CLI
Every command
The CLI is still taking shape during the beta: commands may be renamed or
regrouped between releases, and their output, errors and logs are being
reworked. uze --help always describes the version you have.
uze # help
uze --help # help, on the root or any command
uze --versionA command run inside a project acts on that project and on the machine. -m
makes it act on the machine alone.
Package manager
Plugins
uze add <plugin>@<market> # add a plugin to this project
uze add <plugin>@<market> -m # add it to this machine only
uze <plugin>@<market> # the same as uze add
uze install [path] # install what agents.yaml declares (alias: i)
uze update [plugin] # move plugins to where agents.yaml points now
uze remove <plugin> # take it out of this project
uze remove <plugin> -m # take it off this machine
uze inspect <plugin> # what it carries, and how each agent receives it
uze inspect <plugin> --harness <agent> # the names one agent sees, without starting it
uze status # this project: plugins, context, what is still owed
uze status -m # this machine: every installed pluginadd and remove change what is declared, install reproduces it, and
update moves the pins.
uze add
uze add <plugin>@<market> installs one plugin from a marketplace you added
and, inside a project, declares it in agents.yaml and records it in
agents.lock. With -m it installs on this machine and declares nothing,
project or not. uze <plugin>@<market> is the same command without its verb.
A plugin always comes from a marketplace, never from a path or a Git URL: add
the marketplace first with uze market add.
uze install
uze install brings a project to what it declares: it creates agents.yaml
when the project has none, resolves it into agents.lock, drops from the lock
what agents.yaml no longer declares, installs what the lock records, and
copies the declared plugins' rules into .agents/rules/. It never moves a
version and takes no plugin, so after git clone it is the one command a
teammate runs. Given a project's root directory it acts on that project, and
otherwise on the project you are in. update and status take a project
directory the same way.
| Flag | On | Does |
|---|---|---|
-m | add, update, remove, status, <plugin>@<market> | Act on the machine only |
--trust | add, install, update, <plugin>@<market> | Approve the commands a plugin runs, for CI |
--alias <name> | add, <plugin>@<market> | Install under another name when another marketplace's plugin has it. Cannot be combined with --replace |
--replace | add, <plugin>@<market> | Replace the other marketplace's plugin of the same name |
--harness <agent> | inspect | Only this agent: each capability's name, route, where it lands and what it loses |
Marketplaces
uze market add <source> # owner/repo, host:owner/repo, a Git URL or ./a-directory
uze market list
uze market inspect <name>
uze market remove <name> # the marketplace and everything it delivered
uze market link <name> <checkout> # read it from a checkout you are developing
uze market unlink <name>
uze market host # the hosts owner/repo and alias:owner/repo resolve against
uze market host <alias> # make one the default
uze market host <alias> <https-url> # define one
uze market host <alias> --remove # remove one you definedWorkspace
uze workspace # open the workspace
uze workspace stop # stop the workspace and every process in it
uze workspace allow [dir] # read this project's setup and gate commands, and approve them
uze workspace revoke [dir] # withdraw that approvalRun inside one of the workspace's own panes, uze workspace selects the space
working in that project in the workspace already running, or opens one for it.
allow needs a person at a terminal, and refuses inside an agent uze launched:
the commands a project runs are yours to approve, never its agents'.
Setup and health
uze setup # choose the agents to set up
uze setup <agent>... # set up these (claude, codex, opencode, agy)
uze setup list # every agent and whether it is ready
uze setup inspect <agent>
uze setup --verbose # stream each installer's output instead of keeping it in a log
uze doctor # diagnose, repair what is safe, and check each plugin reached every agent
uze doctor --repair # put back what uze can of its own state, then check again
uze doctor --repair --discard-leftovers # also delete the records set aside and the versions a failed restore kept
uze usage # the CPU, memory and disk uze and its agents use on this machine
uze upgrade # replace uze with the latest release now (not plugins)
uze uninstall # remove the program, leaving every delivered plugin working (--yes)
uze uninstall --purge # also take back every delivered plugin and remove ~/.uzeA uze placed by the install script keeps itself current. Commands check for a
release at most once an hour, in the background, and install one as soon as
they find it; the next command says it was updated. UZE_RELEASE_CHANNEL=stable
waits until a release has been the latest for a day. uze upgrade installs now,
without waiting. A uze installed any other way (cargo, a package manager) is
left to that, and uze upgrade says so. UZE_AUTOUPDATE=off stops the check,
UZE_AUTOUPDATE=notify only tells you, and in CI (CI set) it is off unless
you set it. Staying current has the
whole picture, plugins included.
uze usage reports uze as a whole: the machine, the workspace's uptime, a
table of processes (agents, shells, the terminal server, clients) with their
CPU and memory, and a table of disk (the checkouts uze made, then packages,
records, cache and settings). CPU is the machine's share over one second;
memory is each process's own share.
uze doctor also checks every program an installed plugin needs (see
Requirements) and names each
one that is missing or too old, with the command that installs it. A
missing program that keeps a guard hook denying calls is reported as a
failure; any other is a warning.
Configuration
uze config theme list | set <id> | show [id] # the CLI and the workspace
uze config theme set adaptive [--light <id>] [--dark <id>] # follow the system
uze config icons [default | nerd | ascii] # the CLI and the workspace
uze config notification [on | off | silent | test] # workspace only
uze config extension [<id> [on | off]] # workspace onlyEverywhere
--verbose prints what happened in detail, -q/--quiet prints only
warnings and errors, and --color auto|always|never decides colour
(NO_COLOR is honoured). --format json gives machine-readable output on the
commands that report: add, install, update, remove, status, inspect,
doctor, usage, market list|inspect|remove|host, and config theme list|show,
icons, extension, notification.
The commands agents call are in The agent CLI.