Skip to Content
Referenceoo CLI

oo services

Services agents can use, those added here and what can be added.

Services agents can use, those added here and what can be added. These commands call the /api/v1/services routes; oo api routes --path /api/v1/services shows their inputs and permissions.

oo services list prints JSON with three lists. services: what agents can use besides models, each with its status (on, available or setup) and howToUse. added: the services added from Services > New service, such as an OpenClaw 2.0 dashboard or the Machines service, with its agents, its status and its setup: each step (reserve, publish, agent, live) done, under way, failed or still to come, with its times, and for a failed step why (failure.reason) and whether a retry can help (failure.retry); and a dashboard's address. canAdd: what New service can add here, and for which agents; a Sunport has one Machines service, whose machines oo machines lists. added and canAdd are null when they could not be read, which is not the same as none. oo services add, retry and remove do what New service and a dashboard's page do for an OpenClaw 2.0 dashboard; they need services.write and jobs.create on services/*. oo services sign-in turns a service's OpenOrange sign-in on or off, as its page does. An administrator adds, retries and removes the Machines service in the dashboard, at its page. oo services search-engine switches web search's engine. oo services catalog shows every service the catalog offers, with what it is for, its cost here and who may add it.

oo services list

List services

oo services list [options]
ArgumentRequiredDefaultChoicesDescription
--query NAME=VALUEno

It also takes the connection options.

oo services get

Show one by ID

oo services get [options] id
ArgumentRequiredDefaultChoicesDescription
idyesID from oo services list
--output OUTPUTnowrite response to a protected file (required for a new credential)
--overwriteno

It also takes the connection options.

oo services catalog

Print every service in the Services catalog, in the dashboard's words: what it is, when to use it, what you get, what it costs here, how long it takes to set up and who may add it, with the oo command or the dashboard page that adds it. Any key reads it, an agent's own included. It names nothing added here: oo services list and oo apps list show those. A cost names prices only for a key that may read billing (billing.read), as an administrator's does; for any other it says how the service is paid for. When someone describes a need, suggest the service that fits, with its cost; add it only if they may. --json prints the API's JSON, with each page as a full link.

oo services catalog [options]
ArgumentRequiredDefaultChoicesDescription
--jsonnoprint the API's JSON

It also takes the connection options.

oo services add

Add an OpenClaw 2.0 dashboard, as Services > New service does: the agent's own Control UI at an address of its own under this Sunport, behind the OpenOrange sign-in. The agent is an OpenClaw agent on a VM of its own that no other dashboard opens; canAdd in oo services list names them. The address's first label is the agent's ID, or that with -2 and on while it is taken, unless --name gives one. It prints the new service's ID and address. The dashboard is routing until OpenOrange says its name answers on public DNS, usually a minute or two, then live: read it back with oo services list; the Sunport asks OpenOrange again while it waits.

oo services add [options] agent
ArgumentRequiredDefaultChoicesDescription
agentyesthe agent's ID, from canAdd in oo services list
--name LABELnothe address's first label, such as nova-ui

It also takes the connection options.

oo services remove

Take an OpenClaw 2.0 dashboard added from New service down, as its page in the dashboard does: its address stops answering and its agents stop trusting it. Its entry stays as history. The Machines service is removed in the dashboard.

oo services remove [options] id
ArgumentRequiredDefaultChoicesDescription
idyesthe service's ID, from added in oo services list
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

oo services retry

Run the failed steps of an OpenClaw 2.0 dashboard added from New service again, as Retry on its page does: publishing its address, and connecting each agent whose gateway wasn't updated. The new jobs are queued as you. It is refused when none of its jobs failed (nothing_to_retry), as when site safety stopped Go live. setup.failure in oo services list says why a step failed and whether a retry can help; a step that needs an OpenOrange or Sunport update fails again until that update.

oo services retry id
ArgumentRequiredDefaultChoicesDescription
idyesthe service's ID, from added in oo services list

It also takes the connection options.

oo services search-engine

Switch this Sunport's web search engine, as Services > Web search does: DuckDuckGo is free; Brave, Exa and You.com (youcom) are charged to the team per search at list price, with no markup. Exa may use search queries to train its models by default. It takes no redeploy: Clem restarts on the new engine and OpenClaw VM agents refresh after it. Read how it went with oo services get webSearch: engineSwitch has its state, the engine in effect, why it failed (error) and the agents the engine didn't reach (notReached), such as Hermes agents, which keep their own search (web_search:not_managed). It needs services.write on services/webSearch.

oo services search-engine engine
ArgumentRequiredDefaultChoicesDescription
engineyesduckduckgo, brave, exa, youcomthe engine to switch to

It also takes the connection options.

oo services sign-in

Choose whether an added service asks for the OpenOrange sign-in at its address, as the switch on its page does; the Sunport asks on every request, so the change holds from the next one. off opens the service to anyone with its address. An OpenClaw 2.0 dashboard always asks (sign_in_required), and a Machines service has no such switch (service_kind_unsupported). It needs services.write on the service, and prints whether it now asks (signInRequired).

oo services sign-in [options] id state
ArgumentRequiredDefaultChoicesDescription
idyesthe service's ID, from added in oo services list
stateyeson, offon asks for the sign-in; off opens it to anyone with its address
--yesnoconfirm it now; an agent passes it only once the person confirmed it in chat

It also takes the connection options.

On this page