Skip to main content
The family belongs to the proxycli extension. It is visible and usable only while the extension is enabled at the Gateway:
Enabling the extension deploys nothing, and disabling it removes nothing. proxycli:setup and proxycli:teardown own the collector. See proxycli.

​
Commands

Every command accepts --json.

​
orbit proxycli:setup

Deploy the collector Process on one Node and publish https://collector.cli-proxy-api.orbit.
The output shows enabled, hostname, node_id, cache_connection, and collected_at. It never includes a token or the management key. Setup can run again with the same options. That run rewrites the collector script when needed and reconverges the same Process in place, keeping its ID. An unchanged, completed collector stays running without a restart. When task VMs are enabled, the Gateway refuses a URL that differs from their configured model proxy origin before saving settings or changing the collector. See Set up for the shared-origin constraint. The management key is the only CLIProxyAPI credential. The script uses it for /v0/management, including auth-file models. A collector set up before that read stores no models until setup runs again and the next poll finishes.

​
orbit proxycli:teardown

Stop the collector for the whole fleet, remove its Process, and withdraw collector.cli-proxy-api.orbit and its certificate. The Gateway also deletes the stored management key and the read and control tokens.
In a terminal the command asks a default-No question that names the fleet effect. Without --yes, a noninteractive or JSON call fails with input.confirmation_required before any Gateway request. Declining fails with input.cancelled and changes nothing. To collect again, run proxycli:setup with the key file.

​
orbit proxycli:status

Show the collector state.
The output shows enabled, hostname, node_id, cache_connection, and collected_at. collected_at is null until the collector writes a snapshot.

​
orbit proxycli:list

List provider pools from the snapshot.
The command reads Valkey and never calls CLIProxyAPI.

​
orbit proxycli:show

Show one provider’s pool and accounts.
A provider that is not in the snapshot fails with resource.not_found.

​
orbit proxycli:update

Enable or disable one CLIProxyAPI account.
The command changes the account in CLIProxyAPI and rewrites the snapshot from cache. It fetches no quota.

​
orbit proxycli:models

List the models CLIProxyAPI offers, from the collector snapshot.
Each item is {id, provider}. The command does not call CLIProxyAPI. provider follows the owned_by mapping, including anthropic to claude. google and meta keep those names, and no ProxyCli provider serves them. While the collector is not set up, the command fails with proxycli.disabled. A snapshot with no models returns an empty list. Run proxycli:setup again, then wait for the next poll, before expecting models from a collector that was deployed earlier. When a later poll cannot read one auth file, the snapshot keeps that file’s models from the previous poll. When a model has no owned_by, provider comes from that model’s auth file, using the same mapping. A model with neither is absent from the list.

​
Errors

proxycli errors lists the Gateway errors of setup and toggles.
  • proxycli describes placement, publication, the cache, and the model list.
  • extension controls the Gateway switch.