Project overview: README.md
--debug: Print the current log file path tostderrwhen the CLI exits.--lang <lang>: Override the display language for the current invocation. Supported values:en,zh.-h, --help: Show help for the current command.-V, --version: Show the current CLI version, build time, and commit hash.
When oo reports insufficient OOMOL credit, it exits with code 3 and prints the
recharge link to stderr. Callers can handle this code without parsing the message.
A third-party provider’s HTTP 402 alone does not trigger this exit code.
The CLI reads these environment variables to support embedded and automated
use. Truthy values are 1, true, yes, or on (case-insensitive).
OO_CONFIG_DIR: Override the configuration root directory that holdsauth.toml,connector.toml,settings.toml, and telemetry data (and, unlessOO_DATA_DIRis set, thedatasubdirectory). Takes precedence overXDG_CONFIG_HOME.OO_DATA_DIR: Override the data directory that holds the local cache, uploads, and download-session state. Defaults to<config-root>/data.OO_OPEN_FLOW_COMMAND_DIR: During local Open Flow integration testing, pointoo flowat an expanded Open Flow command artifact directory. The directory must containentry.js; the standard repository build writes it topackages/command/dist/command/open-flow-command. When this variable is unset,oo flowuses the Open Flow release bundled with the currentoorelease.OO_OPEN_FLOW_URL: Select a self-hosted Open Flow Server using its complete HTTP(S) origin, such ashttp://127.0.0.1:3000. It must be set together withOO_OPEN_FLOW_TOKEN; when both are present,oo flowdoes not use an OOMOL account, Team, orOO_ENDPOINT.OO_OPEN_FLOW_TOKEN: The self-hosted Server operator token, equal to that deployment'sOPEN_FLOW_TOKEN. It is sent only to the selected origin's/v1/API as a Bearer token and must be set together withOO_OPEN_FLOW_URL.OO_FLOW_ACCOUNT: Select a saved account for the currentoo flowinvocation without changing the active account inauth.toml. Use the exact account ID orendpoint/name; an ambiguousendpoint/namemust be replaced with the account ID.OO_API_KEYstill takes precedence when both are set.OO_LOG_DIR: Override the debug-log directory. Takes precedence over every platform default.OO_API_KEY: Run execution commands with this API key without an interactive login. When set, the CLI builds an in-memory account and does not read, require, or writeauth.toml, and it takes precedence over any saved account. Because no saved account can be in effect while it is set,oo auth logout,oo auth switch, andoo team usebecome no-ops that leaveauth.tomluntouched, andoo auth loginstill saves the account but reports that this variable outranks it.oo auth statusreports the identity this variable provides. No saved default team applies either: the key may belong to a different account, so commands send no team selection (the server applies its default team) unlessOO_TEAM_IDorOO_TEAM_NAMEselects a team.OO_ENDPOINT: Base endpoint domain (for exampleoomol.comoroomol.dev) used to derive every service URL for execution commands. It pairs withOO_API_KEY, overrides the endpoint of a saved account (including the endpointoo auth statusreports and validates against), and selects the endpointoo auth loginauthenticates against.OO_CONNECTOR_URL: Self-hosted connector server URL. It overrides the configuration saved byoo connector login. Only connector commands (oo connector search/schema/run/proxy/appsand top-leveloo search) route requests to it; other commands never send requests to it, butoo auth statusandoo auth loginreport the configured self-hosted connector, and account-requiring commands mention it in their login-required error when no account is available.OO_CONNECTOR_TOKEN: Optional runtime API token paired withOO_CONNECTOR_URL. Ignored whenOO_CONNECTOR_URLis not set.- Connector commands resolve their target server with this precedence:
OO_CONNECTOR_URL>OO_API_KEY> the saved self-hosted connector configuration (oo connector login) > the active account. OO_TEAM_ID: Run team-aware commands (oo connector run,oo connector proxy,oo connector apps,oo connector search/oo search,oo variables list/get/create/delete,oo file upload, andoo website upload) under the team with this id. It takes precedence overOO_TEAM_NAMEand the account's default team; the per-run--teamflag still outranks it. Before execution the CLI validates the id and resolves its team name (one extra request per invocation), so requests carry both the name and the id; an id the account cannot use — not a member, no such team, team deleted — fails with exit1. If the lookup itself cannot complete, the id is sent on its own and the backend stays the judge. Connector commands ignore it when the connector target is self-hosted; variables commands always honor it.OO_TEAM_NAME: Same asOO_TEAM_ID, but selects the team by name. Before execution the CLI resolves the name to its team id through the account's team memberships (one extra request per invocation), so requests carry both the name and the id; a name the account cannot access fails with exit1. If the lookup itself cannot complete, the name is sent on its own and the backend stays the judge.oo connector run --dry-runsends no execution request and skips the lookup entirely, so it stays offline. Ignored whenOO_TEAM_IDis set, and ignored by connector commands when the connector target is self-hosted; variables commands always honor it.- Team-aware commands resolve their team identity with this precedence:
--team>OO_TEAM_ID>OO_TEAM_NAME> the active account's default teamthe server-side default team. Commands that need the team by name (
oo flow,oo team current,oo auth status) never trust the saved name: they refresh the saved default through its team id (so a renamed team keeps working) and ask the backend which team it applies when nothing is saved. Every other command sends the saved selection as is and the server resolves it by id, applying that same default team when nothing is selected. There is no private, per-user scope. --team <name>is an invocation-wide team selector. It can appear before the command, for exampleoo --team acme flow list --json, or after a team-aware subcommand. Requests and Workbench links use the same team without changing the account's saved default. Repeated selectors use the last value, consistently across commands.OO_SKILLS_SYNC_DISABLED: A truthy value disables the startup managed-skill synchronization, so the CLI writes no skill files into agent home directories such as~/.agentsor~/.claude.OO_NO_SELF_UPDATE: A truthy value disablesoo update,oo install, andoo check-updateand forces self-update PATH modification off.
Run the Open Flow CLI bundled with the current oo release, without any
additional download. Help and version queries work offline; operations against
a Hosted or self-hosted Server still require a connection to that service.
- The
oohost consumes--team <name>for the whole Flow invocation. Remaining arguments afterfloware passed to Open Flow unchanged and are kept out of debug logs. - The effective
oo --langlocale is passed to Open Flow asenorzh-CN. Open Flow owns and versions its translated command text. oo flow --helpandoo flow --versionare therefore Open Flow commands. Useoo help flowto show the host-side command description.- Root help and generated shell completions always list
flowfor both Hosted and self-hosted deployments. - Main
ooglobal options such as--langand--debugmust appear beforeflow. The team selector can also appear afterflow, including after a subcommand; other options afterflowbelong to Open Flow. - Open Flow uses the current process's working directory, standard streams,
environment, and signals. Its exit code becomes the
ooexit code. - With no delegated arguments, Open Flow prints help and never waits for input, including when stdin and stdout are TTYs.
OO_OPEN_FLOW_COMMAND_DIRselects a local command entry for repository integration testing.- By default, Open Flow commands use the current
oocredential and effective Team. The Hosted gateway is derived from the current endpoint ashttps://open-flow.<endpoint>; for example,OO_ENDPOINT=oomol.devuseshttps://open-flow.oomol.dev. --team <name>overrides environment and saved team selections for all Hosted Flow operations.oo flow create Main --team acme --jsonandoo --team acme flow create Main --jsonboth create in the authenticatedacmeteam. The flag accepts a team name, not an internal team id.- Setting both
OO_OPEN_FLOW_URLandOO_OPEN_FLOW_TOKENinstead connects directly to that self-hosted Server. This mode does not read an OOMOL account or Team and does not useOO_ENDPOINT. The token must be the same value as the Server deployment'sOPEN_FLOW_TOKEN. OO_FLOW_ACCOUNT=<account-id|endpoint/name>selects a saved account only for the current Hosted Flow invocation, including that account's endpoint and Team. It does not mutate the globally active account and has no effect while the self-hosted variables are active.- Credentials are attached only to
/v1/requests for the selected origin. Identity and Cookie headers supplied by the command artifact are removed before the host writes the Hosted credential and Team selector or the Server Bearer token. Connector and Trigger operations remain Control API operations; the artifact does not connect to their backing services directly. - The command surface covers Flow authoring, Nodes,
Edges, CodeModules, Connector Tasks, Triggers, checks, Draft/Live Runs,
Publications, rollback, and Workbench deep links. Use
--jsonfor versioned machine output. Flows are selected by ID or an unambiguous exact name; Team selection belongs to theooinvocation, and Connector discovery accepts--flow <flow>to use that Flow's Team scope. oo flow export <flow> > template.openflow.jsonwrites a workflow template as JSON to stdout.oo flow import --file <path|-> --name <name> --idempotency-key <key> --jsonimports a template from a file or stdin into a new unpublished Draft;--nameis optional. Import never overwrites the source Flow. Retry an uncertain import with the same file, name, and key. Both operations clear structured accounts, Variables, error-source workflows, and Trigger resource selections while preserving the graph, shared code Modules, fixed inputs, prompts, model choices, and layout. Review literal sensitive data in code, prompts, and business JSON before sharing a template. Configure missing resources and check the imported Draft before running or publishing it.- Add
--include-dependenciestooo flow export <flow>to export a bundle containing the entry and all referenced workflow Drafts. Bundle operations require a Cloud deployment with the beta.82 bundle APIs. Import accepts both single-workflow files and bundles. Repeat--tag <tag-id>to apply tags to every imported workflow;--nameoverrides only the entry name. Bundle JSON output includes the entryflowand all createdflows. Imports allocate new Flow identities and rewrite structured workflow references. Configure and publish dependencies, then refresh their callers' interfaces before running. Retry uncertain imports with the same file, name, Team, tags, and key. oo flow read <flow> --jsonreturns a Draft graph outline. Supplynodesfor selected node details ortextfor a Code/prompt excerpt; these modes are mutually exclusive. Keep the returnedrevisionfor subsequent reads. Text pagination usesnextStart; continue untiltruncatedis false.oo flow search <flow>searches names, configuration, and source text, optionally restricted by node type, and paginates withnextOffset.read,search, andeditaccept either--input <JSON|@file|->or--file <path|->. Input is optional forreadand required forsearchandedit. Nested strings are literal: a Code value of@filedoes not read that file.oo flow schema read|search|edit|check --jsondescribes request contracts;oo flow schema <node-type> --jsondescribes node configuration and ports.oo flow edit <flow> --file <path|-> --jsonsubmits an atomic batch withbaseRevision,requestId, and an orderededitsarray. Use the observed Revision and a fresh request ID for a new edit; retry uncertain submissions with the same Revision, request ID, and contents.- Edit operations include
node.add,node.update,node.remove,input.set,edge.connect,edge.disconnect,text.edit, andtext.set. Anode.addalias is referenced as$aliasby later edits in the same batch; subsequent requests use stable references from the response'snodesmap. Input bindings supply data independently of execution edges.text.editreplaces one exact occurrence; read the selected text before editing it. oo flow state show <flow> --scope <draft|live> --jsonreturns persistent business value metadata, deduplication space summaries, and storage limits. Add--key <key>to read one business value instead. Draft and Live State are isolated; every State operation requires an explicit--scope.oo flow state clear <flow> --scope <draft|live> --yesclears all business values in that scope; add--key <key>to clear only that value.oo flow dedupe clear <flow> --scope <draft|live> --space <space> --yesclears deduplication records in the selected space, eitherflowornode:<node-id>. Both clear operations require--yes.- Run and publication commands may return
0for an accepted asynchronous operation,1for an error or unsuccessful terminal Run,2for an unresolved Wait/Approval, or3when a wait times out or publication remains pending. For waiting,--timeoutis a budget in milliseconds, defaulting to 60000; expiration does not cancel the operation. Continue withruns waitorpublications wait; resolve an outstanding decision withruns resolve <run> <wait> <continue|approve|reject>. runs events <run> --follow --jsonstreams NDJSON pages; resume with--afterusing the returnednextAfter. Publishing accepts--expected-revision,--expected-publication <publication-id|none>, and--idempotency-key. Automatic Trigger execution is controlled withenable/disable <flow> --expected-publication <publication-id>.oo flow check <flow> [--revision <revision-id>]validates the immutable Revision. Reading and editing do not run or publish a Flow; credential availability and real Connector side effects are checked only by an explicitoo flow run. The selected deployment must supportopen-flow-engine/v10to check, run, or publish with this version of the CLI.oo flow open [flow]opens the selected deployment's Workbench in the system browser and also prints its URL.oo flow workbench [flow]prints the same URL without launching a browser, for scripts and agent-hosted previews. Omittingflowopens the Flow catalog; providing it opens that Flow's design page. The Hosted URL carries a short-lived, one-time browser sign-in code for the effective CLI account and is scoped to the effective team under its current name: the account's default team, refreshed through its team id so a renamed team still opens, or the server-side default team the backend reports when none is saved (the same team that invocation's Cloud requests act for). When the saved default team no longer exists or is no longer accessible, the command exits1and says so; when nothing is saved and the backend reports no default team, it fails and points tooo login/oo team use <name>. A self-hosted URL points directly to the Server Workbench; the browser establishes its own operator session, and the operator token is never placed in the URL.- Host telemetry records this delegation only as top-level command
flow, its success or failure, duration, and the Hosted team selection source enum. It records no delegated subcommand, flag values, team names or ids, Project/Flow ID, free-form argument, or command output.
Local repository example:
cd /path/to/open-flow
bun run --filter @oomol-lab/open-flow-command build
cd /path/to/oo-cli
OO_OPEN_FLOW_COMMAND_DIR=/path/to/open-flow/packages/command/dist/command/open-flow-command \
bun run index.ts flow --helpTest the online dev Cloud with a locally built Open Flow command (requires a dev login and an effective Team):
OO_ENDPOINT=oomol.dev \
OO_OPEN_FLOW_COMMAND_DIR=/path/to/open-flow/packages/command/dist/command/open-flow-command \
bun run index.ts flow listConnect to a self-hosted Server:
export OO_OPEN_FLOW_URL=http://127.0.0.1:3000
export OO_OPEN_FLOW_TOKEN="$OPEN_FLOW_TOKEN"
oo flowCommands that document --format=json and --json share the following
conventions:
--show-schema-versionadds aschemaVersionfield to the JSON payload. The current value is1.0.0.- When the underlying payload is a JSON object,
schemaVersionis merged into it as a top-level field. - When the underlying payload is a JSON array, the response is wrapped as
{ "schemaVersion": "1.0.0", "items": <array> }. --show-schema-versionhas no effect unless JSON output is requested with--format=jsonor--json.
Options that document @- read their JSON value from stdin until EOF, for
example echo '{"to":"a@example.com"}' | oo connector run gmail -a send_mail -d @-.
@-requires piped input; it fails with exit code2when stdin is an interactive terminal.- Only one option per command can read from stdin; a second
@-fails with exit code2. - Empty stdin is reported as invalid JSON.
- To read a file literally named
-, use@./-.
When --format=json or --json is passed explicitly, a failing command writes
one JSON line to stderr instead of the plain-text message. stdout stays empty
and the exit code is unchanged:
{"error":{"code":"connectorRun.requestFailed","message":"Connector action get_message returned HTTP 409 (errorCode: connection_ambiguous): Multiple connections match","exitCode":1,"details":{"action":"get_message","service":"gmail","httpStatus":409,"upstreamErrorCode":"connection_ambiguous","executionId":"exec-1"}}}codeis a stable machine-readable identifier, such asauth.required,connectorRun.invalidPayload,commander.unknownOption, orunexpected. Branch oncode, not onmessage.messageis the same localized text that text mode prints; it follows the configured language and is meant for display only.exitCodematches the process exit code:2for usage and input errors,3for insufficient OOMOL credit, and1for other runtime failures.debugLogPathappears with--debug. It replaces the separate log path line, so stderr stays one JSON value.detailsis optional and only appears for errors that carry structured fields. Its fields depend oncode; callers should ignore fields they do not recognize. Current fields:- Failed HTTP requests:
httpStatus. billing.insufficientCredit:billingUrl, plushttpStatuswhen the server returned HTTP 402.connectorRun.requestFailed,connectorRun.approvalRequired, andconnectorProxy.requestFailedfrom the connector service:service,httpStatus, and when availableaction(run only),upstreamErrorCode(the servererrorCode, for exampleconnection_ambiguous), andexecutionId.connectorProxy.requestFailedwhen the proxied provider API returned an HTTP error:service,upstreamHttpStatus, andexecutionId. stdout still carries the proxied response in this case.connectorRun.asyncApprovalRequired:recovery({ service, action, input, submitExecutionId }) andhandle.connectorRun.invalidFileReference,connectorRun.fileReferenceReadFailed,connectorRun.fileReferenceNotFile,connectorRun.fileReferenceTooLarge, and upload failures of a$filereference:inputPath.connectorRun.invalidPayload:issues, an array of{ path, keyword, message, params }wherepathis a JSON Pointer into the--datapayload.connectorRun.asyncTimedOut,connectorRun.asyncFailed,connectorRun.asyncUnknownState:service,action,pollCount, andstate(failure states only).- With
--wait-result, every polling failure after the submit response returned a handle also carrieshandleandsubmitExecutionId, whatever itscode. Resume with the handle instead of submitting the task again. connectorRun.asyncHandleMissing: the task was submitted but its response had no handle to poll with;detailscarriesservice,action, andsubmitExecutionId. Do not resubmit the task.
- Failed HTTP requests:
- Commands whose output is always JSON (such as
oo connector schema) still print plain-text errors unless--jsonor--format=jsonis passed.
- The CLI writes structured debug logs to a platform-specific persisted log
directory:
macOS:
~/Library/Logs/ooLinux:${XDG_STATE_HOME:-~/.local/state}/oo/logsWindows:%LOCALAPPDATA%\\oo\\Logs - The debug logs include request lifecycles for remote APIs, device-login polling events, explicit update checks, persisted settings/auth store changes, and sqlite cache activity.
- Error-oriented log entries also include a
categoryfield so user-facing failures, system failures, and recoverable cache issues can be filtered quickly. Values includeuser_error,system_error, andrecoverable_cache. - Debug log file names carry a UTC timestamp, for example
debug-2026-03-25_06-30-12-p12345.log. - The CLI keeps debug log files from the current UTC calendar day and the previous six UTC calendar days. Logs outside this seven-day UTC date window are removed first. There is no fixed file-count cap.
Start a device login flow, authenticate with a session token, or authenticate with an existing API key, then save the authenticated account.
- Notes: the CLI prints the verification URL with the user code in the
user_codequery parameter, then waits up to 10 minutes for the device login to be verified when neither--session-tokennor--api-keyis provided. It exits with a timeout error if verification does not complete within that window. - Options:
--session-token <session-token>: Authenticate with an existing session token. The CLI does not print a device-login URL or poll for verification when this option is provided.--api-key <api-key>: Authenticate with an existing API key. The CLI validates the key against the account profile and saves the account without a device-login URL or polling. Exits with an error if the key is invalid or expired.--api-keyand--session-tokencannot be combined.--team <name>: Set the account's default team identity to the named team after login. The name must be one of the account's team memberships; otherwise the command exits1(the account itself is still saved). Works with all three login methods.
- Default team: after a successful login the CLI fetches the account's team
memberships and persists a default team identity on the saved account.
Without
--team, a stored default that is still one of the memberships is kept (and gains its team id); otherwise the server-side default team is adopted as the backend reports it (the team a request without a team selection acts for). When the backend reports none — the account has created no team — nothing is persisted, no default-team line is printed, and login still exits0. Otherwise the success output prints the resulting default (Default team identity: <name>), and when the account belongs to more than one team it also prints how many teams the account has (naming at most five, truncating the rest with an ellipsis) and thatoo team use <name>switches the default. When the membership request or the default-team lookup fails and no--teamwas given, login still exits0and prints that the default team is unchanged. WhenOO_TEAM_ID/OO_TEAM_NAMEis set, the default is still saved but a hint notes that the env override keeps outranking it. - Notes: when a self-hosted connector is configured (
oo connector login), it keeps handling connector commands after login; the success output prints a hint thatoo connector logoutswitches them back to OOMOL. - When
OO_API_KEYis set, login still validates and saves the account, but that variable keeps outranking it. The success output prints a hint that the saved account takes effect only onceOO_API_KEYis unset. OO_ENDPOINTselects the host login authenticates against for all three methods (device login, session token, and API key), and the saved account records that endpoint. Without it the public default is used.
Remove the current account from persisted auth data.
- When
OO_API_KEYis set it supplies the credential instead of a saved account, so there is nothing for this command to log out of. It exits0without modifyingauth.tomland reports that nothing was logged out.
Show every saved auth account and validate the API key of the active one.
-
Aliases:
oo auth info. -
Reports the identity that commands actually run as, which is not always the active saved account:
OO_API_KEYoutranksauth.tomlentirely, andOO_ENDPOINTredirects the endpoint of a saved account. The reported endpoint is the one the API key is validated against. -
When
OO_API_KEYis set, the status is alwayslogged-in(a stale active id inauth.tomlis irrelevant), no saved account is marked[active], and text output notes that saved accounts are not in use.auth.tomlis then only a source of the account list, so it is never created when missing, and an unreadable one leavesaccounts[]empty instead of failing the command. -
An unreadable
auth.tomlnever fails the command: status renders the report with a warning naming the unreadable file, an empty account list, and exit code 0. With--format jsonthe warning goes to stderr so stdout stays machine-readable. A missing file is never created. -
Text output lists all saved accounts under an
Accounts:block. The active account is annotated with[active]; the active account additionally showsAPI key statusresolved from a single profile request to its endpoint. Inactive accounts are not validated, so the number of saved accounts never changes how many requests are sent. -
The active-identity block also shows a
Default teamline, resolved the same wayoo team currentresolves it: theOO_TEAM_ID/OO_TEAM_NAMEenv override when set (annotated with the variable that supplies it), otherwise the active account's default team, otherwiseserver default (no saved team). WithOO_API_KEYset the line always readsserver default (no saved team)unless anOO_TEAM_*variable selects one. -
When
OO_TEAM_IDorOO_TEAM_NAMEsupplies the identity, the missing half is looked up — the id resolves to its name, the name to its id through the account's team memberships — and the line shows<name> (<id>). If the lookup does not succeed, the value is still shown and the reason is appended: the active account is not a member of the team, no team exists with that id, the team has been deleted, or the lookup could not be completed. A failed lookup never changes the exit code and never affects the reportedAPI key status. The account's saved default team is looked up the same way, so the row shows the team's current name and appends the reason when the saved default could not be confirmed; with no default saved, the server-side default team the backend reports is shown instead. -
oo auth statustherefore sends at most two requests: the API key check, plus one team lookup (the env-selected team, the saved default, or the server-side default) when an account is available to make it. The two are independent and are sent concurrently. -
API key values are never written to stdout in text or JSON output.
-
When a self-hosted connector is configured (
oo connector loginorOO_CONNECTOR_URL), text output adds a self-hosted connector block showing the server URL, whether a token is configured, and the configuration source. The token value is never printed. -
Options:
--format=jsonand--jsonswitch to structured JSON output.--show-schema-versionprependsschemaVersionto the payload. -
JSON shape (one of three):
{ "status": "logged-in", "activeAccountId": "user-1", "accounts": [ { "id": "user-1", "name": "Alice", "endpoint": "oomol.com", "active": true, "apiKeyStatus": "valid" }, { "id": "user-2", "name": "Bob", "endpoint": "oomol.com", "active": false } ] }{ "status": "logged-out", "activeAccountId": null, "accounts": [] }{ "status": "active-account-missing", "activeAccountId": null, "missingAccountId": "user-1", "accounts": [ { "id": "user-2", "name": "Bob", "endpoint": "oomol.com", "active": false } ] } -
When a self-hosted connector is configured, each of the three shapes may additionally carry an optional top-level
connectorfield:{ "connector": { "url": "http://localhost:3000", "tokenConfigured": true, "source": "file" } } -
When a default team identity is in effect, the
oo auth status --jsonoutput — specifically itslogged-inshape above — carries an optional top-levelteamfield.sourcesays which mechanism selected it (flagfor--team,env_id,env_name,account, orbackend_defaultfor the server-side default team the backend reported because no default team is saved), andstatusreports the team lookup:{ "team": { "name": "acme", "id": "team-7", "source": "account", "status": "valid" } }{ "team": { "name": "platform", "id": "019ed9dd-57b1-77eb-86b7-09724abe8037", "source": "env_id", "status": "valid" } }statusisvalidforbackend_default, and for theaccountsource it reports whether the saved default could be confirmed through its id (valid, or the reason it could not); the name shown is the team's current name, not the one saved at login.nullmeans no lookup was attempted. For an env-selected identity it is one ofvalid,not_a_member,not_found,deleted,request_failed,request_failed_sandbox, orno_credential. The looked-up half is filled only whenstatusisvalid— the name underenv_id, the id underenv_name— while the env-supplied half is always present. -
When
OO_API_KEYsupplies the credential, theoo auth status --jsonoutput is always thelogged-inshape and carries an optional top-levelenvOverridefield:{ "status": "logged-in", "activeAccountId": "oo-env-override", "envOverride": { "endpoint": "oomol.dev", "apiKeyStatus": "valid" }, "accounts": [ { "id": "user-1", "name": "Alice", "endpoint": "oomol.com", "active": false } ] } -
Notes (JSON):
- The
apiKeyfield is never emitted, and the JSON payload never contains the actual API key string under any field name. accounts[]lists every account saved in the local auth file in its original order; each entry is{ id, name, endpoint, active, apiKeyStatus? }.activeAccountIdis the active account id, ornullwhen no active account can be resolved (including theactive-account-missingstate). UnderOO_API_KEYit is the stable synthetic idoo-env-override, which is deliberately absent fromaccounts[]because it is not a saved account.accounts[].activeistrueonly for the active account, and isfalsefor every entry whileOO_API_KEYis set.accounts[].apiKeyStatusis present only on the active entry and uses the enumvalid/invalid/request_failed/request_failed_sandbox.envOverrideis present only whenOO_API_KEYis set, in which case the status is alwayslogged-in. It reports theendpointin effect (fromOO_ENDPOINT, otherwise the public default) and theapiKeyStatusof the environment credential, using the same enum asaccounts[].apiKeyStatus. The API key value itself is never emitted.accounts[].endpointis the endpoint saved inauth.toml. A bareOO_ENDPOINT(withoutOO_API_KEY) redirects the endpoint used for text output and API key validation, but does not rewrite this field.teamis present only on thelogged-inshape and only when a default team identity is in effect.sourceisaccount(the saved default),flag(--team),env_id(OO_TEAM_ID),env_name(OO_TEAM_NAME), orbackend_default(the server-side default team the backend reported because none is saved). An env-selected identity is looked up to complete its missing half, so on success it carries bothnameandid; when the lookup does not succeed, the env-supplied half is kept andstatussays why. Theaccountsource is looked up as well, sonameis the team's current name andidis filled in on success; when that lookup does not succeed, the saved values are kept andstatussays why.missingAccountIdappears only when the auth file records an active id that is no longer present inaccounts[].connectoris present only when a self-hosted connector is configured and reports that configuration (theOO_CONNECTOR_URLoverride when set, otherwiseconnector.toml):url,tokenConfigured, andsource(env/file). Note that whenOO_API_KEYis set, connector commands route to the hosted OOMOL connector service instead of asource: "file"configuration (onlyOO_CONNECTOR_URLoutranksOO_API_KEY). The token value is never emitted. The block is omitted whenconnector.tomlcannot be read.- All three statuses exit
0(this is a query command). Argument errors (for example--format xml) still exit2.
- The
Switch the active auth account.
- With no arguments the command rotates to the next saved account in the
auth.tomlorder. - Options:
-u, --user <user>switches to a specific account. The value is matched againstaccount.idfirst (exact match) and then againstaccount.name(exact match, must be unique). Matching is never fuzzy, case-insensitive, or substring-based. - When
<user>matches multiple accounts by name, the command exits non-zero without rewritingauth.tomland asks the caller to pass an account id. Account ids are stable strings — useoo auth status --jsonto discover them. - When the requested account is already the active one, the switch is
idempotent (exit
0, no rewrite mode change). - When
OO_API_KEYis set, no saved account can be in effect, so switching would change nothing that a later command honors. The command exits0without reading or rewritingauth.tomland reports that nothing was switched. This applies with and without--user, and takes precedence over the no-saved-accounts error. - API key values are never written to stdout or stderr in any output path.
Create a short-lived URL that signs the current account in to the OOMOL website in a browser. The command writes the URL to stdout together with a usage hint, the expiry, and a do-not-share warning; it never launches a browser itself.
- Requires a credential: the active saved account or
OO_API_KEY. The URL is issued by the backend for that credential, so opening it signs the browser in as the same account without a separate login. - Options:
--redirect <url>: where the browser lands after the sign-in completes. Must be anhttp(s)URL whose host is the account's endpoint domain or a subdomain of it (with the default endpoint:oomol.comand*.oomol.com). Targets on another environment are rejected, so anoomol.comredirect exits2while the endpoint isoomol.dev. Defaults to the endpoint's console,https://console.<endpoint>/. A disallowed value exits2without contacting the backend.
- The URL embeds a short-lived sign-in code and expires after the number of seconds reported by the backend (300 at the time of writing). Anyone who opens it before then is signed in to the account, so treat the URL as a secret.
- JSON output (
--json):
{
"expiresIn": 300,
"url": "https://api.oomol.com/v1/auth/session_code/exchange?redirect=https%3A%2F%2Fconsole.oomol.com%2F&session_code=..."
}Alias for oo auth login. Supports the same --session-token <session-token>,
--api-key <api-key>, and --team <name> options.
Alias for oo auth logout.
Team identity selects the team that team-aware commands act for: the connector
commands (oo connector run, oo connector proxy, oo connector apps), the
variables commands (oo variables list/get/create/delete), whose data is
team-owned in the first place, and oo file upload and oo website upload,
whose uploads are billed and metered under the team. One ladder selects it: the
per-run --team <name> first, then the OO_TEAM_ID / OO_TEAM_NAME
environment overrides, then the default saved on the active account. When
nothing selects a team the command sends no team selection and the server
applies the account's default team.
These commands help discover which teams your account can use and manage that
default.
The default team belongs to the saved account, so switching accounts with
oo auth switch switches the default with it, and oo auth logout removes it
along with the account. An installation that predates account-scoped defaults
carried a single global identity.team setting; the CLI moves that value onto
the active account on the next run and removes the setting. Under OO_API_KEY
no saved default applies at all — use OO_TEAM_ID / OO_TEAM_NAME there.
oo team list and oo team use query OOMOL for your team memberships, so they
require an OOMOL account and are unavailable when only a self-hosted connector
is configured. oo team current works regardless: it reads local state and
only enriches its output with a team name when an account is available to look
one up.
oo auth login (and its oo login alias) persists the default automatically:
it keeps the account's still-valid stored default, otherwise adopts the
server-side default team the backend reports (when it reports one), and
accepts --team <name> to pick one explicitly.
List the teams the active account can authenticate as. This command is read-only.
- Options:
--format=jsonand--jsonprint a JSON array. - Output: JSON entries include
name,id,role,isDefault, andcurrent.roleiscreatorormember. isDefaultreflects the backenddefault_teammarker, independently of local selection. Missing backend markers are reported asfalse.currentidentifies the effective team:--teamfirst, thenOO_TEAM_ID/OO_TEAM_NAME, then the account's saved team. Without a local selection, the team marked as the backend default is current.- Output: pass
nameto--team <name>(oroo team use <name>), andidtoOO_TEAM_ID. - Output: the text table distinguishes Default and Current. When the account has no teams, it reports that team-aware commands send no team selection.
- Behavior: listing does not change the saved team selection. If the saved team lacks an id, the command fills it in from the membership listing without an extra request; a failure to write this id is ignored.
Show the team identity used by team-aware commands (connector, variables, file
upload) when no --team flag is given: the OO_TEAM_ID / OO_TEAM_NAME
environment override when set, otherwise the active account's default team.
When neither is set, the commands send no team selection and the server
applies its own default team.
- Sends one request, when an OOMOL account is available to make it, to report the team by its current name: an env-selected identity completes its missing half (the name for an id, the id for a name), a saved default is refreshed to its current name, and with nothing saved the backend reports the server-side default team it applies. What this command reports is what a run would use.
- Works without an OOMOL account. When no account is configured the lookup is skipped rather than failing, and the env-supplied value is reported on its own.
- Options:
--format=jsonand--jsonprint a JSON object. - Output: JSON is
{ "team": <name|null>, "teamId": <id|null>, "source": <"flag"|"env_id"|"env_name"|"account"|"backend_default"|null>, "status": <status|null> }.sourcesays which mechanism selects the team:backend_defaultwhen no default team is saved and the backend reported the server-side default team it applies,nullwhen it reported none (the account has created no team) or that lookup failed.teamis the team's current name: a saved default is refreshed through its id (a name-only default through the memberships), so a renamed team is reported under its new name while the saved values stay as they are.statusreports the team lookup:nullwhenever none was attempted (--dry-run-style offline paths),validforbackend_default, otherwise one ofvalid,not_a_member,not_found,deleted,request_failed,request_failed_sandbox, orno_credential; for theaccountsource a non-validstatus keeps the saved name and id in the output, and the text output appends the reason. - An explicit
--team <name>reports that invocation's selection instead:teamis the supplied name,teamIdisnull,sourceisflag, andstatusisnull. The service gateway resolves and validates that name. - Output: under
OO_TEAM_ID/OO_TEAM_NAMEtext output shows<name> (<id>)once both halves are known. If the lookup does not succeed the env-supplied value is still shown and the reason is appended; the command still exits0. - Output: text output names the environment variable when one is set, and notes that the account's default team is not in use while the override is active.
Set the default team identity to <name> after checking the active account can
access it.
- Arguments:
<name>is the team name, as shown byoo team list. - Shell completion: generated Bash, Zsh, and Fish completion scripts suggest accessible team names. Membership results are cached per account and endpoint for up to one minute; a failed lookup produces no suggestions.
- Behavior: the name is validated against the teams the account can access; an
inaccessible name is rejected with exit
1and the default is left unchanged. On success the team name and id are saved on the active account. - Behavior: when
OO_TEAM_ID/OO_TEAM_NAMEis set, the default is still saved, but the output reports that the environment variable keeps outranking it until unset. - Behavior: with
OO_API_KEYset the command saves nothing, exits0, and reports that this variable has no saved default team.
Print the current account's LLM client configuration as JSON.
- Authentication: requires the current OOMOL account.
- Options:
--format=jsonand--jsonare accepted for consistency with other structured output commands. The command always prints JSON. - Output: a JSON object with:
apiKey: the current account API key.baseUrl: the OpenAI-compatible LLM API base URL, including the/v1API prefix.chatCompletionsUrl: the normalized OpenAI-compatible chat completions endpoint. Call this URL directly for raw chat completions requests instead of appending a path tobaseUrl.model: the default model name, currentlyoomol-chat.
- Production output uses
https://new-llm.oomol.com/v1asbaseUrlandhttps://new-llm.oomol.com/v1/chat/completionsaschatCompletionsUrl.
Call the configured LLM and require a JSON response that validates against a provided JSON Schema.
- Authentication: requires the current OOMOL account.
- Options:
--schema <schema>is required. The value must be a JSON Schema object with root typeobject,@path/to/schema.json, or@-to read it from stdin.--input <input>provides input JSON,@path/to/input.json, or@-to read it from stdin. When omitted, the input is{}. Only one of--schemaand--inputcan use@-.--system <system>provides extra system prompt text or@path/to/system.txt.--max-retries <count>sets retries after the first attempt. Default is2; supported values are0through5.--model <model>overrides the default model for this call.--format=jsonand--jsonare accepted for consistency. The command always prints JSON.
- Behavior: the CLI sends the selected schema and input to the configured OpenAI-compatible chat completions endpoint, requests JSON-only output, repairs common JSON wrapping such as Markdown fences, validates the parsed value against the schema, and retries malformed or schema-invalid model output within the retry budget.
- Output: success prints
{ ok: true, data, model, attempts }, wheredatais the validated model JSON value. - Errors: endpoint
404, authentication401or403, rate limit429, invalid schema, non-object root schema, unsupported LLM responses, and validation exhaustion are reported as command errors.
- Notes: when the persisted settings file contains unknown keys, the CLI ignores those keys and writes a warning entry to the debug log. Known keys continue to load normally.
List persisted configuration values that are currently set.
Read one persisted configuration value.
- Arguments:
<key>is the configuration key. Supported values:lang,file.download.out_dir,telemetry.enabled.
Print the path to the persisted configuration file.
Persist one configuration value.
- Arguments:
<key>is the configuration key. Supported values:lang,file.download.out_dir,telemetry.enabled. - Arguments:
<value>is the value for the selected key. - Value rules: for
lang, supported values areenandzh. - Value rules: for
file.download.out_dir, use any non-empty path string. Relative paths resolve from the current working directory whenoo file downloadruns. A leading~expands to the current user's home directory. - Value rules: for
telemetry.enabled, supported values are lowercasetrueandfalse. Other boolean-like spellings such as1,0,True, andyesare rejected. Settingtelemetry.enabledtofalsealso attempts to purge pending telemetry events immediately and the currentconfig setinvocation is not recorded as telemetry.
Remove one persisted configuration value.
- Arguments:
<key>is the configuration key. Supported values:lang,file.download.out_dir,telemetry.enabled.
The CLI records privacy-constrained command usage telemetry by default. Events do
not include free-form input text, paths, usernames, hostnames, IP addresses,
error messages, real OOMOL account ids, account names, $set, or $identify.
Each event uses a local random device id and sets $process_person_profile to
false. Package names and skill ids can be included in telemetry events,
including private package names, because they are treated as published product
artifacts.
- Environment: setting
OO_TELEMETRY_DISABLEDto a truthy value (1,true,yes,on, case-insensitive) disables telemetry for the current invocation. - Environment: setting
DO_NOT_TRACKto a truthy value (1,true,yes,on, case-insensitive) also disables telemetry for the current invocation. - Persistence:
oo telemetry disableandoo config set telemetry.enabled falsepersist telemetry disablement insettings.toml. - Boundary: disabling telemetry prevents future telemetry sends and attempts to purge pending local telemetry events immediately. If the local telemetry store is temporarily unavailable, disabling still takes effect before future sends. It cannot retract bytes that were already sent over an active TCP connection.
Show the effective telemetry state, local device id prefix if one already exists, pending event count, and last successful flush time.
- Output:
enabled: truewhen telemetry is enabled. - Output:
enabled: false (env)when disabled byOO_TELEMETRY_DISABLEDorDO_NOT_TRACK. - Output:
enabled: false (config)when disabled by persistedtelemetry.enabled = false. - Output:
device_idisnoneuntil telemetry has created a local device id. - Output:
pendingis the number of local telemetry events queued for sending, including events already being sent but not yet confirmed. - Notes:
statusdoes not create a device id and is not recorded as telemetry.
Persist telemetry.enabled = true.
- Notes: enabling telemetry does not purge pending events and is not recorded as telemetry.
Persist telemetry.enabled = false and attempt to purge all pending local
telemetry events immediately.
- Notes: disabling telemetry is not recorded as telemetry.
Install one managed oo release into the local self-managed runtime.
- Arguments:
[version]is optional. When omitted,ooinstalls the latest published release. - Options:
--forceforces a reinstall even when the requested version is already installed. - Options:
--no-modify-pathskips automatic PATH configuration; install will still print a setup note when the executable directory is not onPATH. - Environment: setting
OO_NO_MODIFY_PATHto a truthy value (1,true,yes,on, case-insensitive) is equivalent to--no-modify-path. The flag and the env var combine with OR semantics: either one being set skips PATH configuration. - Environment: setting
OO_HIDE_PATH_SHADOWING_WARNINGto a truthy value hides the shadowing note for users who intentionally keep anotherooearlier onPATH. It does not change managed installation, PATH setup, or legacy cleanup behavior. - Output: on success, the CLI prints the installed version and the final executable path.
- Output: when
stderris an interactive TTY, the CLI also renders colored progress stages tostderrwhile the install is running. - Notes: install verifies that the installed
oocommand is usable before reporting success. - Notes: after a successful install, the CLI best-effort removes legacy global
@oomol-lab/oo-clipackage-manager installs that appear anywhere onPATH; whenPATHyields nooocandidates, the CLI falls back to the current command path. For npm installs, cleanup targets the detected global prefix when it can be inferred. Cleanup failures do not change the command result. - Notes: after PATH setup and legacy cleanup, if the current
PATHstill resolvesooto another executable before the managed executable directory, install prints a shadowing note that identifies that path and the managed directory. - Notes: when automatic PATH modification is enabled, install ensures zsh
startup profiles
.zprofileand.zshenvcontain the managed PATH snippet, even if the currentPATHalready contains the executable directory. When the executable directory is not onPATH, install also attempts to persist it for future shells. When automatic PATH configuration succeeds, install tells the user to restart their shell; when it fails, install prints a setup note that tells the user which directory to add. - Notes: when some shell profiles were updated and others could not be, install lists both — the profiles that were updated and the profiles that could not be updated — followed by the restart-shell note. The user can then decide whether to update the failed profiles manually.
- Notes: after a successful install workflow, the CLI silently runs
oo skills addwith the managed executable so bundled skills refresh to the installed CLI version. - Notes: when the current version is
0.0.0-development, the CLI prints the managed install/update unsupported message and exits successfully.
Update the managed oo install to the latest published release.
- Arguments: none.
- Options:
--no-modify-pathskips automatic PATH configuration; update will still print a setup note when the executable directory is not onPATH. - Environment: setting
OO_NO_MODIFY_PATHto a truthy value (1,true,yes,on, case-insensitive) is equivalent to--no-modify-path. The flag and the env var combine with OR semantics: either one being set skips PATH configuration. - Environment: setting
OO_HIDE_PATH_SHADOWING_WARNINGto a truthy value hides the shadowing note for users who intentionally keep anotherooearlier onPATH. It does not change managed installation, PATH setup, or legacy cleanup behavior. - Output: when the current version is already the latest published release, the CLI prints the up-to-date message.
- Output: when a newer published release is available, the CLI prints the version change result.
- Output: when
stderris an interactive TTY, the CLI also renders colored progress stages tostderrwhile the update is running. - Notes:
oo updateensures the managed install is current and usable, and does not expose a separate--forceflag. - Notes: when the latest published release matches the current version, update
still runs
oo skills addfor the active managed version before printing the up-to-date message. - Notes: after a successful update, the CLI best-effort removes legacy global
@oomol-lab/oo-clipackage-manager installs that appear anywhere onPATH; whenPATHyields nooocandidates, the CLI falls back to the current command path. For npm installs, cleanup targets the detected global prefix when it can be inferred. Cleanup failures do not change the command result. - Notes: after PATH setup and legacy cleanup, if the current
PATHstill resolvesooto another executable before the managed executable directory, update prints a shadowing note that identifies that path and the managed directory. - Notes: when automatic PATH modification is enabled, update ensures zsh
startup profiles
.zprofileand.zshenvcontain the managed PATH snippet, even if the currentPATHalready contains the executable directory. When the executable directory is not onPATH, update also attempts to persist it for future shells. When automatic PATH configuration succeeds, update tells the user to restart their shell; when it fails, update prints a setup note that tells the user which directory to add. - Notes: when some shell profiles were updated and others could not be, update lists both — the profiles that were updated and the profiles that could not be updated — followed by the restart-shell note. The user can then decide whether to update the failed profiles manually.
- Notes: after a successful update workflow, the CLI silently runs
oo skills addwith the managed executable so bundled skills refresh to the installed CLI version. - Notes: when the current version is
0.0.0-development, the CLI prints the managed install/update unsupported message and exits successfully.
Alias for oo update.
Uninstall the managed oo runtime and its built-in skills.
- Arguments: none.
- Options:
-y, --yesskips the confirmation prompt and is required in non-interactive terminals. - Options:
--dry-runprints what would be removed (and retained) without deleting anything. - Options:
--purgeadditionally removes user data (auth, settings, cache, logs, telemetry) and all oo-managed registry skills. - Default removal: the managed executable (
~/.local/bin/oo), all installed versions, self-update staging and locks, and bundled skills. - Default retention: PATH configuration is left untouched; registry skills,
local skills, and any same-name directory that is not oo-managed are
retained, as is user data (removed only with
--purge). - Skill safety: a skill is removed only when its
.oo-metadata.jsonproves oo ownership (kind: "bundled", orkind: "registry"under--purge). Directories with missing, invalid, local, or non-matching metadata are never deleted, so user-authored same-name skills are safe. - Installation method: when
oowas installed via a package manager (npm/bun/pnpm/yarn), the command removes oo-managed skills, prints the matchingnpm uninstall -g @oomol-lab/oo-cli(or equivalent) command, and exits non-zero so callers know the binary still needs manual removal. When the executable is at an unknown location, it removes oo-managed skills only and asks the user to remove the binary manually. - Windows: files that cannot be removed while
oo uninstallis running are removed after the process exits. Other runtime paths, skills, and user data selected by the uninstall plan are cleaned up during command execution. On Unix, cleanup happens during the command. - Safety: the command refuses to run while another live
ooprocess is running, and it never writes API keys or other secrets to stdout/stderr.
Check whether a newer CLI release is available.
-
Notes: when a newer release is found, the CLI prints the recommended upgrade command
oo update. -
Notes: when the current release is already the latest one, the CLI prints a confirmation message.
-
Notes: transient request failures are retried twice before the CLI gives up.
-
Notes: successful and failed checks are not cached, so every invocation checks the latest published release.
-
Notes: when the update check is temporarily unavailable, the CLI prints a retry-later message instead of exiting with an error.
-
Options:
--format=jsonand--jsonswitch to structured JSON output. The shape is one of:{ "status": "update-available", "currentVersion": "1.2.3", "latestVersion": "1.3.0" }{ "status": "up-to-date", "currentVersion": "1.2.3", "latestVersion": "1.2.3" }{ "status": "failed", "currentVersion": "1.2.3", "message": "Cannot reach update service." } -
Notes (JSON):
statusis the stable machine-readable enum.messageis a human-readable English string and should not be parsed by scripts. The command exits0even whenstatusis"failed"because the failure is a query result; scripts should branch onstatus. Argument errors (for example--format xml) still exit2.
Print the CLI version.
-
Notes: text output is identical to
oo --version/oo -V. Useoo versionwhen you want a command-style invocation, particularly in combination with--jsonfor script consumption. -
Options:
--format=jsonand--jsonswitch to structured JSON output. The payload mirrors the same data the text output prints (version, build time, and commit hash) so callers can switch formats without losing fields:{ "version": "1.2.3", "buildTime": "2026-05-26T00:00:00.000Z", "commit": "abc12345" }buildTimeis the build timestamp formatted as ISO 8601, ornullwhen the binary was built without an embedded build timestamp.commitis the first eight characters of the git commit hash recorded at build time, ornullwhen unknown.
Print CLI environment details, persisted store paths, and detected skill agents.
- Options:
--format=jsonand--jsonswitch to structured JSON output. Without those flags, the command prints a human-readable colored summary. - Output (JSON): a single object with three top-level fields:
cli: an object with the following string fields.versionis the running CLI version.platformis the Node-style platform identifier (darwin,linux,win32, etc.).archis the Node-style architecture identifier (arm64,x64, etc.).storeDiris the root directory of the persisted store.logDiris the persisted debug log directory.authFileis the persisted auth file path.settingsFileis the persisted configuration file path.agents: an array of{ id, skillDir, status }entries, one per supported skill agent.idis the stable agent identifier (for exampleuniversal,claude,hermes).skillDiris the agent's resolved skill directory.statusis one ofavailable,no_skills, ornot_installed.availablemeans both the agent home directory and its skill directory exist locally.no_skillsmeans the agent home directory exists but the skill directory has not been created yet (for example whenoocould not write skills into the agent).not_installedmeans the agent home directory itself is missing, sooohas nowhere to install skills.features: a reserved array for optional CLI capability flags. The CLI currently always returns an empty array.
Search connector actions with free-form text.
-
Arguments:
<text>is the semantic search text. -
Options:
--format=jsonand--jsonprint a JSON array of matching action entries. -
Options:
--team <name>reports each result'sauthenticatedstate under the given team identity. When omitted, the effective identity followsOO_TEAM_ID/OO_TEAM_NAME, then the active account's default team, otherwise the server-side default team. -
Output: every match includes
authenticatedandaccessStatus. -
Output: JSON entries include the stable CLI fields
service,name,description,authenticated, andaccessStatus.accessStatusis eitheravailableorconnection_required. -
Output: text output prints one block per action with the service/action label, optional description and price description, authenticated state, and access status.
-
Notes: the action list itself does not depend on identity; each result's
authenticatedandaccessStatusfields reflect the effective identity's connected apps, so a connection under a team affects both fields only when that team is the effective identity. -
Notes: use
oo connector schema "<service>.<action>"to inspect the selected action contract. -
Notes: search results also warm the local action schema cache when schema data is available.
oo connector schemafetches full metadata when only a connection-specific search result has been cached. -
--all-teamssearches all teams of the current user on the OOMOL-hosted connector. It ignores the saved current team andOO_TEAM_ID/OO_TEAM_NAME, conflicts with--team, and is unavailable for self-hosted connectors. Without this option, search stays scoped to the effective current team. -
Results retain
appIdwhen returned. Cross-team available entries also includeteamIdandteamName. Text output shows these selectors too. -
The hosted endpoint returns at most 10 entries after connection expansion, not 10 distinct actions. One action may occupy multiple entries. Missing results do not prove that a team lacks a connection.
-
To execute a selected cross-team connection, use its
teamIdinOO_TEAM_IDand itsappIdwithoo connector run --app-id. -
When supplied by the connector, JSON and text output include the localized
pricingDescriptionfor that result's connection. Its absence does not mean the action is free. Self-hosted connectors without this field work normally.
Show the stable schema contract for one or more connector actions.
- Arguments:
<actionId...>is one or more action identifiers in the form<service>.<action>, for examplecal.create_schedule. - Options:
-a, --action <action>selects the action name and treats the single positional argument as a bare service name. This legacy form is retained for backwards compatibility; it accepts exactly one bare service name and rejects both additional positional arguments and the<service>.<action>form. - Options:
--refreshfetches fresh metadata from the connector metadata API. - Options:
--format <format>and--jsonare accepted for consistency with other commands; the command always prints JSON.--show-schema-versionadds theschemaVersionfield following the shared JSON output conventions. - Output: for a single requested action, the command prints a JSON object with
the stable CLI fields
service,name,description,inputSchema, andoutputSchema; with--show-schema-versionthe object gains a top-levelschemaVersionfield. For two or more requested actions, it prints a JSON array of those objects in request order; with--show-schema-versionthe array is wrapped as{ "schemaVersion": "1.0.0", "items": [...] }per the shared conventions. - Output:
pricingDescriptionis included when the connector supplies a price description. The text identifies the applicable hosted channel and may give a reference cost rather than a guaranteed charge. Missing or null prices are omitted. Descriptions follow the existing--lang en/--lang zhsetting. - Notes:
--refreshforces a fresh schema fetch for every selected action. - Notes: full metadata cached by an earlier lookup in the same language is
reused until it expires; use
--refreshfor the latest remote contract.
Clear all locally cached connector action schemas.
- Arguments: none.
- Output: text output prints a single success line.
- Notes: the command does not require authentication and does not fetch new
metadata immediately; later
oo connector schemaoroo connector runinvocations fetch and cache schemas again when needed.
Validate input data and run one connector action.
- Arguments:
<serviceName>is the service name. - Options:
-a, --action <action>selects the action name and is required. - Options:
-d, --data <data>accepts inline JSON,@pathto a JSON file, or@-to read JSON from stdin (see JSON Input).--input <data>is an alias for--data <data>. - Options: inside
--data, an object{ "$file": "<path>" }references a local file. Before execution the CLI uploads the file to temporary OOMOL file storage and replaces the object with the file's download URL:- The object must contain only a non-empty
$filestring; anything else containing$fileis rejected with exit code2. Relative paths resolve against the current directory. - The payload is validated against the action contract with a URL in place of each reference before anything is uploaded, so the target field must accept a URL string.
- The same file referenced several times is uploaded once per command.
- Uploads follow
oo file upload: they require an OOMOL account (also against a self-hosted connector), files up to 500 MiB, links that expire after seven days, and records thatoo file listshows. --dry-runchecks that each referenced file exists and fits the limit but uploads nothing.
- The object must contain only a non-empty
- Options:
--app-id <app-id>selects the exact connection from search. It is mutually exclusive with--connection-name; empty IDs are rejected. The selected team must own that connection; an app ID does not switch teams. - Options:
--connection-name <connection-name>runs the action with the connector app connection name. Useoo connector apps <serviceName>to list available connection names. - Options:
--approvaldeclares that the user confirmed this operation. When an action returnsapproval_required, its policy requires user confirmation: the caller asks the user to confirm the operation and its key parameters before passing--approval, unless the user has explicitly said the action needs no confirmation. The original request to perform the action is not that confirmation. - Options:
--dry-runvalidates the payload without executing the action. - Options:
--waitpolls the selected action until it reaches a terminal state. This option is only valid when the selected action schema declares an async result lifecycle. - Options:
--wait-resultsubmits an async submit action and then polls its configured result action. This option is only valid when the selected action schema declares an async submit lifecycle. - Options:
--team <name>runs the action under the given team identity. When omitted, the action runs under the team selected byOO_TEAM_ID/OO_TEAM_NAMEif set, then the active account's default team, otherwise the server-side default team. - Options:
--format=jsonand--jsonprint a JSON object. - Output: non-dry-run JSON output mirrors the stable response shape
{ data, meta: { executionId } }. - Output: when
--datacontains$filereferences, JSON output addsmeta.uploads, one{ inputPath, fileName, fileSize, expiresAt }entry per reference, whereinputPathis a JSON Pointer into--data. Download URLs are never printed. Text mode prints one line per upload on stderr. - Output: for async submit actions, the default output is the submit result, such as a handle or session id. The CLI does not wait automatically.
- Output: with
--wait-result, JSON output uses the completed result indataand includesmeta.pollAction,meta.pollCount,meta.submitExecutionId, andmeta.handle. - Output: for async result actions, the default output is one result action
response. With
--wait, JSON output uses the completed result indataand includesmeta.pollCount. - Output: dry-run JSON output returns
{ dryRun, ok }. - Errors: stderr prints the HTTP status and includes the server
messageanderrorCodewhen the failure response provides them. When the response carries neither, the raw response body is included (trimmed and length bounded) so the failure detail is not lost. With--json, the failure is a structured JSON error with codeconnectorRun.requestFailed(connectorRun.approvalRequiredforapproval_required); see JSON Errors. ForerrorCode: approval_required, stderr explains that the blocked action was not executed and that it can be retried with unchanged key parameters and--approvalonly after the user confirms it or has explicitly said it needs no confirmation. The HTTP status is retained and the exit code is1. The CLI does not retry automatically. - Errors: if
--wait-resultsuccessfully submits a task but a result query returnsapproval_required, the command exits1and explains that the task was submitted but that result query was not executed. Stderr includes recovery JSON{ service, action, input, submitExecutionId }, whereactionandinputdescribe the result query. Stdout remains empty. After the user confirms, resume that result query with--wait --approval, preserving the original team and connection selection. Do not resubmit the task. With--json, the same recovery object is also available aserror.details.recovery. - Notes:
--waitpasses an explicit--approvaldeclaration on every poll of the selected action. With--wait-result, it applies only to submission; the derived result action does not inherit it. - Notes: the command validates the input against the selected action contract before executing.
- Notes: while waiting for an async result action in text mode, interactive terminals show progress on stderr. JSON output does not include progress text.
- Notes: against a self-hosted connector,
--teamis rejected with exit2, the account's default team and theOO_TEAM_ID/OO_TEAM_NAMEenvironment variables are ignored.--waitand--wait-resultfail with the existing unsupported errors because the self-hosted runtime does not expose the async lifecycle contract.
List connected connector apps under the effective identity. This command is read-only.
- Arguments:
[serviceName]is optional. When omitted, the command lists every connected app across all providers. When provided, the listing is scoped to that one service. - Options:
--team <name>lists connected apps under the given team identity. When omitted, the listing uses the team selected byOO_TEAM_ID/OO_TEAM_NAMEif set, then the account's default team, otherwise the server-side default team. - Options:
--format=jsonand--jsonprint a JSON array. - Output: JSON entries include the stable CLI fields
service,connectionName,displayName,accountLabel,status,authType,isDefault, andscopes. App id fields are not included. - Output: when an app has no connection name, JSON output uses
nulland text output prints-. - Output: text output prints one column-aligned row per app. The listing across
all providers leads with a
Servicecolumn; the single-service listing omits it because the service is fixed by the argument. On a color-capable terminal the status and default columns are color-coded; piped orNO_COLORoutput is plain aligned text. - Notes: use the listed
connectionNamevalue withoo connector run <serviceName> --connection-name <connection-name>. - Notes: against a self-hosted connector,
--teamis rejected with exit2, and the account's default team and theOO_TEAM_ID/OO_TEAM_NAMEenvironment variables are ignored.
Proxy a provider API request through a connected connector app.
- Arguments:
<serviceName>is the service name. - Options:
-d, --data <data>accepts a complete proxy request JSON object,@pathto a JSON file, or@-to read it from stdin. The object shape is{ endpoint, method?, query?, headers?, body? }. - Options:
--input <data>is an alias for--data <data>. - Options: without
--data, use--endpoint <endpoint>plus optional--method <method>,--query <json>,--headers <json>, and--body <json>to build the same request object. The--dataform cannot be combined with these split request options. - Options:
--endpointis a provider endpoint path relative to the provider proxy base URL, or an allowed absolute HTTPS URL. - Options:
--methodmust be one ofGET,POST,PUT,PATCH, orDELETE. Values are case-insensitive. Likecurl, the method defaults toGETwhen omitted, in both the split form and the--dataobject. - Options:
--querymust be a JSON object whose values are strings, numbers, booleans, ornull. - Options:
--headersmust be a JSON object with string values. Authentication headers are injected by the connector service from the connected app; callers should not pass provider credentials through CLI options. - Options:
--bodyis parsed as JSON. To send a text body, pass a JSON string such as"hello". - Options:
--connection-name <name>selects a named connection within the selected identity. Leading and trailing whitespace is removed; empty names are rejected. It works with both--dataand split request options. - Options:
--team <name>runs the proxy request under the given team identity. When omitted, the request runs under the team selected byOO_TEAM_ID/OO_TEAM_NAMEif set, then the active account's default team, otherwise the server-side default team. - Options:
--format=jsonand--jsonprint a JSON object. - Output: JSON output keeps the stable shape
{ data: { status, headers, data }, meta: { executionId, service } }. - Errors: upstream HTTP
4xxor5xxresponses exit1, even when the connector successfully forwarded the request. stdout still contains the upstream response and execution ID in the selected output format; stderr reports the HTTP status. HTTP2xxand3xxresponses exit0; provider business errors inside an HTTP2xxbody require caller interpretation. - Errors: stderr prints the connector proxy HTTP status and includes the server
messageanderrorCodewhen the failure response provides them. When the response carries neither, the raw response body is included (trimmed and length bounded) so the failure detail is not lost. With--json, the failure is a structured JSON error with codeconnectorProxy.requestFailed; see JSON Errors. - Notes:
oo connector proxydoes not use connector action schemas or schema cache. Use it when the selected connector supports proxy execution and no purpose-built connector action is available. - Notes: against a self-hosted connector,
--teamis rejected with exit2and the account's default team and theOO_TEAM_ID/OO_TEAM_NAMEenvironment variables are ignored. Proxy execution depends on server support; the open-source runtime currently returns an error.
Validate and save a self-hosted connector server so connector commands use it instead of the OOMOL-hosted connector.
- Arguments:
<url>is the self-hosted connector server URL, for examplehttp://localhost:3000. - Options:
--token <token>provides a runtime API token for the server, created on the server's/accesspage. - Output: text output confirms the connected server URL, reports whether the
token was verified, and points to
<url>/accessfor managing runtime tokens. - Notes: the command validates the server through its health endpoint before
saving the configuration. After a successful login, all connector commands —
oo connector search/schema/run/proxy/appsand top-leveloo search— use this server instead of the OOMOL-hosted connector. - Notes: when the server accepts unauthenticated requests, a provided token cannot be verified; the configuration is still saved and a notice is printed.
- Notes: when no OOMOL account is logged in and
OO_API_KEYis unset, the command prints a note that non-connector commands still requireoo auth login. - Errors: an invalid URL (not an http(s) URL) or an invalid token (empty, or
containing whitespace or control characters) exits
2. An unreachable server, an HTTP 401 response, or an unexpected/non-connector response exits1; the 401 error includes a hint to create a runtime token at<url>/access.
Remove the saved self-hosted connector configuration.
- Arguments: none.
- Output: text output confirms which server was disconnected. Connector
commands fall back to the active OOMOL account unless
OO_CONNECTOR_URLis still set. - Notes: when no self-hosted connector is configured, the command prints a notice instead of failing.
- Notes: the command only removes the saved configuration; the
OO_CONNECTOR_URLenvironment variable is not affected. - Notes: a corrupt
connector.tomlis cleared as well, sooo connector logoutalways leaves the configuration removed.
Search connector actions with one free-form query.
- Arguments:
<text>is the semantic search text. - Options:
--format=jsonand--jsonprint a JSON array of matching action entries. - Options:
--team <name>reports each result'sauthenticatedstate under the given team identity. When omitted, the effective identity followsOO_TEAM_ID/OO_TEAM_NAME, then the active account's default team, otherwise the server-side default team. - Output: every match includes
authenticatedandaccessStatus. - Output: JSON entries include the stable CLI fields
service,name,description,authenticated, andaccessStatus.accessStatusis eitheravailableorconnection_required. - Output: text output prints one block per action with the service/action label, optional description and price description, authenticated state, and access status.
- Notes: the action list itself does not depend on identity; each result's
authenticatedandaccessStatusfields reflect the effective identity's connected apps, so a connection under a team affects both fields only when that team is the effective identity. - Notes: use
oo connector schema "<service>.<action>"to inspect the full connector action contract. - Notes: search results also warm the local action schema cache when schema
data is available.
oo connector schemafetches full metadata when only a connection-specific search result has been cached. --all-teamssearches all teams of the current user on the OOMOL-hosted connector. It ignores the saved current team andOO_TEAM_ID/OO_TEAM_NAME, conflicts with--team, and is unavailable for self-hosted connectors. Without this option, search stays scoped to the effective current team.- Results retain
appIdwhen returned. Cross-team available entries also includeteamIdandteamName. Text output shows these selectors too. - The hosted endpoint returns at most 10 entries after connection expansion, not 10 distinct actions. One action may occupy multiple entries. Missing results do not prove that a team lacks a connection.
- To execute a selected cross-team connection, use its
teamIdinOO_TEAM_IDand itsappIdwithoo connector run --app-id.
Before running a command, oo silently synchronizes bundled and registry skills
for the universal ~/.agents host, which is always provisioned (created when
missing), and for every other supported host directory that already exists.
- Bundled skills:
ooensuresoo,oo-find-skills,oo-create-skill, andoo-publish-skillare installed for the universal~/.agentshost and each detected Claude Code, Hermes, CodeBuddy, WorkBuddy, Trae, Trae CN, OpenClaw, QoderWork, and DeepSeek TUI host. Existing oo-managed bundled skill targets are refreshed to the currentooversion, except that0.0.0-developmentstartup runs do not refresh existing bundled targets, and installed0.0.0-developmentbundled targets are left untouched. - Registry skills: when a published skill already has a local canonical copy
under
<config-dir>/skills/registry/<skill-id>,oopublishes that copy to any newly detected supported host that is missing it. - Local skills: agent-native local skills are not synchronized during startup. A local skill belongs to the agent skill directory where it was created.
- Unusable host directories: a supported host is skipped when its skill
directory path is occupied by something
oocannot create a directory at, such as a symbolic link whose target has been removed or a regular file. The remaining hosts still install, andoo infokeeps reporting the host so the broken path stays visible. - Shared host directories: supported hosts whose skill directories resolve to
the same location — for example
~/.claude/skillssymlinked to~/.agents/skills— are one host. The skill is installed there once and is reported under the more specific agent: the universal~/.agentshost yields to a detected agent that shares its directory. - Migration: startup synchronization does not rewrite same-version legacy
symlink targets. Use
oo skills addfor bundled skills andoo skills updatefor registry skills to replace legacy symlinks explicitly. Successfuloo installandoo updateworkflows run both maintenance steps. - Safety: startup synchronization does not fetch registry data, does not
require authentication, does not print additional command output, and does
not overwrite same-name targets that are not managed by
oo. An empty target directory holds no skill, so it is filled the same way a missing one is.
This command inspects local skills, not all packages published or maintained
by the account in the cloud. Use
oo connector run oomol_console --action list_my_skill_packages --json for
personal cloud packages and list_team_skill_packages for team configuration.
Inspect oo connector schema for their input and pagination contracts.
Show bundled and registry skills by default. Local skills are listed only when
requested. oo skills list is accepted as an alias for backwards compatibility.
- Options:
--source <source>,-s <source>filters the list to one source:bundled,registry, orlocal. - Options:
--agent <agent>narrows the scan to one supported agent:universal,claude,hermes,codebuddy,workbuddy,trae,trae-cn,openclaw,qoderwork, ordeepseek-tui. - Options:
--json/--format jsonemits a structured JSON payload (see JSON output below).--show-schema-version(only meaningful with JSON output) adds a top-levelschemaVersionfield; without it, the payload starts atsummary. - Managed ownership rule: the command scans each existing supported local skill root:
~/.agents/skills,~/.claude/skills,${HERMES_HOME:-~/.hermes}/skills,~/.codebuddy/skills,~/.workbuddy/skills,~/.trae/skills,~/.trae-cn/skills,${OPENCLAW_HOME:-~/.openclaw}/skills,~/.qoderwork/skills, and~/.deepseek/skills. It keeps only child directories whose.oo-metadata.jsonidentifies an oo-managed bundled, registry, or local skill. A child directory with the same name but without.oo-metadata.jsonis surfaced as anon-managedhost of the matching managed skill (it is not listed as a separate top-level skill). - Local source rule:
--source locallists oo-managed local skills from agent skill directories.--source local --agent <agent>lists only that agent's local skills. - Identity: top-level skill identity is
kind + name + packageName. Version differences across hosts do not split a skill into separate entries; per-host versions are reflected in the JSON output'shosts[].version. - Ordering: bundled skills are listed first when present, with
oobeforeoo-find-skillsbeforeoo-create-skillbeforeoo-publish-skill; the remaining skills are ordered by skill name. Host entries within a skill followUniversal,Claude Code,Hermes,CodeBuddy,WorkBuddy,Trae,Trae CN,OpenClaw,QoderWork,DeepSeek TUIorder. - Text output: text output prints a summary line and one block per visible
skill, then per-host rows showing the agent, install status, and
controlState(see below). Local paths and source paths are never printed in text output; use JSON for machine-readable detail. controlStatevalues (per host):controlled— the host directory is oo-managed and its contents match the canonical source.modified— the host directory is oo-managed but its contents have been edited locally.non-managed— the host directory exists with the same name as an oo-managed skill but has no.oo-metadata.jsonof its own.unknown— metadata cannot be parsed, the source path is unavailable, or the directory comparison failed.
When --json or --format json is supplied, the command writes a single line
of JSON to stdout. With --show-schema-version, the top-level object is
prefixed with "schemaVersion": "1.0.0".
{
"schemaVersion": "1.0.0",
"summary": {
"registrySkills": 3,
"localSkills": 2,
"bundledSkills": 4
},
"skills": [
{
"id": "oo",
"name": "oo",
"kind": "bundled",
"packageName": null,
"version": "1.2.3",
"description": "Use OOMOL hosted capabilities",
"hosts": [
{
"agentId": "universal",
"status": "installed",
"path": "/Users/name/.agents/skills/oo",
"sourcePath": "/Users/name/Library/Application Support/oo/skills/bundled/universal/oo",
"version": "1.2.3",
"controlState": "controlled"
}
]
}
]
}Field semantics:
summaryalways reflects the full inventory and is not affected by--sourceor--agentfilters. Use it to see how many skills exist in total even when theskillsview is filtered.skillsreflects the current filtered view. By default, local skills are hidden fromskills(matching legacyoo skills listbehavior); pass--source localto view them.skills[].packageNameisnullfor bundled and local skills. Bundled skills are not distributed via a registry package, so no virtualpackageNameis invented in JSON. Text output displays<internal>/<local>as human-facing placeholders.skills[].versionis the top-level version. When the same skill is installed at different versions across hosts, the top-level is one entry; per-host versions appear inhosts[].version.hosts[].statusis"installed"in this release. The field is reserved for future host states.hosts[].sourcePathis the canonical source directory for bundled and registry skills,nullfor local skills, andnullfor non-managed host entries.
Print the local path for an installed skill.
- Arguments:
<skill-id>is the directory name to locate under supported skill roots. Path-shaped values are rejected; pass paths directly tooo skills publish. - Options:
--agent <agent>narrows the scan to one supported agent:universal,claude,hermes,codebuddy,workbuddy,trae,trae-cn,openclaw,qoderwork, ordeepseek-tui. - Resolution: with
--agent, the command checks only that agent's<agent-home>/skills/<skill-id>path. Without--agent, it checks all available supported agent skill roots plus canonical registry storage under<config-dir>/skills/registry/<skill-id>. - Match rule: a candidate matches when it contains
SKILL.md. The command does not validate skill frontmatter or.oo-metadata.json; publish performs that validation. - Output: when exactly one candidate matches, stdout is that path plus a
newline. When no candidates match, or multiple candidates match, the command
exits non-zero. Ambiguous errors list the candidate paths and tell callers to
pass
--agentor publish one path directly.
Check whether this environment has permission to author local skills for one agent.
- Options:
--agent <agent>is required and selects one supported agent:universal,claude,hermes,codebuddy,workbuddy,trae,trae-cn,openclaw,qoderwork, ordeepseek-tui. - Host check: the selected agent home directory must already exist.
- Storage check: the command creates the selected agent's skills root, such as
<agent-home>/skills, when needed. It writes and removes a temporary probe file in that directory. - Output: on success, text output prints the writable storage path and number
of checked supported hosts. The count is
1for a successful agent check. On failure, the command exits non-zero.
Initialize one local skill in the selected agent's own skill directory.
- Arguments:
<name>is normalized to lowercase hyphen-case and used as the skill id, target directory name, and frontmattername. - Options:
--agent <agent>is required and selects the agent skill directory to write. Accepted values areuniversal,claude,hermes,codebuddy,workbuddy,trae,trae-cn,openclaw,qoderwork, anddeepseek-tui. - Options:
--description <text>is required and writes the generatedSKILL.mdfrontmatter description. - Generated
SKILL.mdfrontmatter includescompatibility: "Requires the oo CLI.". - Generated
SKILL.mdfrontmatter includes nestedmetadata.titleandmetadata.icon. When--titleis omitted, the title is generated from the skill id. When--iconis omitted, a generic local workflow icon is used. - Generated
SKILL.mdbody includes editable local workflow placeholder sections for when to use the skill, inputs, execution, result handling, and failure handling. - Metadata: the created skill directory includes
.oo-metadata.jsonidentifying the skill as a local skill managed byoo. - Options:
--icon <icon>writes a non-empty icon reference tometadata.iconin the generatedSKILL.mdfrontmatter. The value may be an emoji, an image URL, or:collection:icon:wherecollectionandiconare names from https://icones.js.org/. - Options:
--title <title>writesmetadata.titleto the generatedSKILL.mdfrontmatter. - Target directory: the skill is created at the selected agent's
<agent-home>/skills/<skill-id>. - Publication mode: the command does not copy the new local skill to other agents.
- Failure behavior: if the selected agent home does not exist, or if the target
directory already exists, the command exits non-zero before writing the skill
and suggests
oo skills adoptfor existing workflow directories. - Output: text output prints the initialized skill id and target path.
Turn an existing local workflow directory into an oo-managed local skill without overwriting the workflow implementation.
- Arguments:
<path>must be an existing directory. Relative paths resolve from the current working directory. - Skill id: when
--name <name>is provided, it is normalized to lowercase hyphen-case and used as the skill id and frontmattername. Otherwise the command uses an existingSKILL.mdfrontmatternamewhen present, falling back to the source directory name. - Options:
--agent <agent>selects an agent skill directory. Accepted values areuniversal,claude,hermes,codebuddy,workbuddy,trae,trae-cn,openclaw,qoderwork, anddeepseek-tui. - Target behavior: without
--agent, the command adopts<path>in place. With--agent, if<path>is already the selected agent's<agent-home>/skills/<skill-id>directory, the command adopts it in place. Otherwise it copies the existing directory to that target path before adopting it. The source directory is not removed. - Content behavior: existing workflow files are preserved. Existing
SKILL.mdbody content is preserved; the command only patches frontmatter fields needed for the skill contract. IfSKILL.mdis missing, the command creates one with local workflow placeholder sections. - Description:
--description <text>writes frontmatterdescription. It is required only when the existingSKILL.mddoes not already contain a non-empty frontmatterdescription. - Presentation metadata:
--title <title>writesmetadata.title, and--icon <icon>writesmetadata.icon. When omitted, existing nested metadata values are preserved; top-leveltitleoriconare copied into nestedmetadatawhen present; otherwise default display metadata is used. - Metadata: the adopted skill directory includes
.oo-metadata.jsonidentifying the skill as a local skill managed byoo. - Safety: the command refuses to adopt a directory whose
.oo-metadata.jsonidentifies a bundled or registry skill, or whose oo metadata is invalid. With--agent, the command refuses to copy over an existing different target directory. - Validation: after writing the skill contract and local metadata, the command validates the adopted skill directory and prints validation warnings to stderr.
- Output: text output prints the adopted skill id and target path.
Validate a local skill directory against the generic skill contract.
- Arguments:
<path>is the skill directory containingSKILL.md. - Validation:
SKILL.mdfrontmatter must be a dictionary with stringnameand non-empty stringdescriptionfields. - Validation: nested
metadatais optional, but when present it must be a dictionary. Nestedmetadata.iconandmetadata.titleare optional, but when present they must be non-empty strings. - Warnings: missing
metadata.iconormetadata.titleprints a warning, but does not make validation fail. If top-leveliconortitleexists while nestedmetadata.iconormetadata.titleis missing, the warning explains that top-level fields do not satisfy display metadata. - Output: on success, the command prints a concise success message. On failure, it prints the validation error and exits non-zero.
Convert one skill into an OOMOL package and run the publish step.
- Arguments:
<path>must be a skill directory containingSKILL.md, or theSKILL.mdfile itself. Relative paths resolve from the current working directory. Bare skill ids are not resolved by this command; useoo skills locate <skill-id>first when needed. - Options:
--visibility <visibility>sets the registry package visibility. Accepted values areprivateandpublic. When omitted, an existing package keeps its current registry visibility. If no existing visibility can be read, an interactive terminal prompts forprivateorpublic; non-interactive first-time publishes must pass--visibility privateor--visibility public. - Options:
-y, --yesanswers publish confirmation prompts with yes. - Options:
--forceis accepted for compatibility with older workflows. - Source resolution:
.oo-metadata.jsondetermines whether the path is an oo-managed local skill, an oo-managed registry skill, or an unmanaged path source. Invalid oo metadata fails before publishing. Bundled skills are rejected because they are managed by the oo CLI release. - Registry source resolution: when the path has registry metadata with a scoped
package name, that package name is used as the target. If no scoped package
name is available and the installed metadata package name differs from the
target package name, an interactive
[y/N]confirmation is required before publishing under the current account scope unless-y, --yesis provided. - Authentication: the command requires the current OOMOL account. If the source
has an existing scoped
metadata.packageName, that package name is preserved; otherwise the package name is@<lowercase-account.name>/<lowercase-skill-id>. - Validation: the source directory must contain
SKILL.mdwith frontmatternamematching<skill-id>and a non-empty stringdescription. Optionalmetadata.title,metadata.icon,metadata.packageName, andmetadata.versionmust be non-empty strings when present, andmetadata.versionmust be semver. - Package metadata: missing
metadata.titlefalls back to a title generated from<skill-id>. Missingmetadata.versionfalls back to0.0.1. - Package contents: the skill directory's
.gitignorecontrols which local files are excluded from the published package. When the skill has no.gitignore, the built-in package template is used. Symbolic links are rejected during packaging..oo-metadata.jsonis always excluded from the published package. - Registry safety: before publishing, the command looks up the latest remote
package metadata. If the remote package already contains blocks, an
interactive terminal prompts for confirmation with the standard
[y/N]confirmation style unless-y, --yesis provided. Answering no, pressing Enter, or running without an interactive stdin stops before conversion, PUT, or local metadata writeback. - Visibility resolution: explicit
--visibilityis used as-is. Without it, the command preserves a latest remote package markedpublicas public and a private/restricted remote package as private. If the latest package metadata is missing or does not include visibility, the command asks forprivateorpublic; non-interactive runs must pass--visibility. - Version resolution: if the requested version is not greater than the latest remote package version, the command publishes the next patch version.
- Writeback: after the publish step succeeds,
SKILL.mdfrontmatter is updated with the finalmetadata.packageNameandmetadata.version. - Registry writeback: after publishing an oo-managed registry skill, the command
updates registry ownership metadata. If the source path is not canonical
registry storage, it replaces
<config-dir>/skills/registry/<skill-id>with the published source, then copies canonical storage to every available supported agent. If no supported agent home is available, publish and canonical writeback still succeed. - Output: on success, text output prints the skill id, final package specifier,
selected visibility (
privateorpublic), and the Hub package URL for the current account endpoint, for examplehttps://hub.oomol.com/package/<packageName>for production accounts. On failure, the command exits non-zero and leavesSKILL.mdunchanged.
Share a published skill package, confirm the exact skill being shared, and print a prompt that can be copied to another user. Public packages are shared directly. Private or restricted packages are shared through a temporary registry share id.
- Arguments:
[skill]is optional in an interactive terminal. It may be a local skill id, an installed registry skill id, a path to a skill directory containingSKILL.md, or a package name. When omitted, the command prompts for the skill id, package name, or path. - Options:
--downloads <downloads>limits temporary private-package installs. When omitted, installs are unlimited. Non-numeric values fail. Numeric values that are not positive safe integers use the default unlimited value. - Options:
--days <days>sets the temporary private-package share duration. The default is7days and the maximum is7days. Non-numeric values fail. Numeric values outside the valid range use the default7. - Options:
-y, --yesskips the final[y/N]confirmation after the command resolves the skill id and package name. - Resolution: the argument may identify a local skill, an installed registry skill, a skill directory path, or a package name. Skill ids are resolved by checking local skills first, then installed registry skills. Path-like references are resolved as skill directories. If no skill or path can be resolved, or if the resolved skill does not identify a package, the argument is treated as a package name.
- Package check: the command requests latest package metadata for the resolved
package. Public packages use
<packageName>directly in the prompt. Private packages create a temporary share and display the share token as<packageName>#<shareID>. Missing visibility metadata is treated as public. Unpublished packages are rejected before any share prompt is printed. - Output: on success, text output prints a single copyable plain text code
block, with no nested command fences. The prompt language follows the active
CLI language (
--lang enor--lang zh). The prompt states the skill or package is already published, includes the package name, Hub URL, and skill id for skill targets, links to the general install preparation guide athttps://static.oomol.com/oo-cli/skill-install-guide/install.md, and then prints the final install command. The prompt tells the recipient to follow that guide to check OO CLI and login state before running the install command. Both skill-target and package-target prompts continue throughoo skills install <packageName>for public packages, oroo skills install <packageName>#<shareID>for private packages. Private-package prompts identify the exact temporary install specifier<packageName>#<shareID>and do not present the target as already public.
Search published skills with free-form text.
- Alias:
oo skills find <text>. - Arguments:
<text>is the search text sent to the skills search service. - Options:
--keywords <keywords>sends a comma-separated keyword list as repeatedkeywordsquery parameters after trimming empty entries. - Options:
--format=jsonand--jsonprint a JSON array of matching skill entries. - Output: JSON entries include only the stable CLI fields
description,name,packageName,packageVersion, andskillDisplayNamewhen present. - Output: text output prints one block per skill with its title or name, optional description, and source package reference when available.
- Notes: every invocation requests at most
5results.
Installing a private package requires access for the current identity. For team
access, the package must be added to the team’s Skills configuration; membership
alone does not share members’ private packages with other members or bots.
Adding requires package access and team write permission, through Console with
the target team selected or oomol_console.add_skill_package_to_team. The grant
covers the entire package without changing visibility or installing it locally.
Removing a team binding does not uninstall local skills or revoke other grants.
Install bundled or published skills into supported local skill directories.
- Alias:
oo skills add [packageName...]. - Arguments:
[packageName...]accepts zero or more package names. - Arguments: when omitted, the command installs all bundled skills.
- Arguments: when several package names are given, each is installed in order. Installs that already completed are kept even if a later package fails.
- Arguments: when a package name is
oo,oo-find-skills,oo-create-skill, oroo-publish-skill, the command installs the corresponding bundled skill. - Arguments: when a package name is a published package name, the command
installs skills from that package. A package name may include an explicit
version as
<packageName>@<version>, including scoped package forms such as@scope/name@1.2.3. - Arguments: a package name may also use
<packageName>#<shareID>. In that form, the command reads the package skill list from<packageName>and downloads the package archive through the share identified by<shareID>. - Behavior: the command installs every published skill in each package by
default; the optional
-s, --skillfilter narrows which skills are installed. - Options:
-s, --skill <skills...>limits the install to the named skills. The option is optional and accepts multiple values (for example-s foo bar). Matching is case-insensitive and accepts either the skill name or its directory name. Names that match no skill are ignored. With several packages the filter spans all of them: a package that publishes none of the requested skills is silently skipped, and the command fails only when no package (or, for the no-argument bundled install, no bundled skill) matches any requested name — listing the available skills. An explicitly named bundled skill is already a single-skill selection and is not further narrowed by--skill. - Options: because
-s, --skillaccepts multiple values, put any package names before it (for exampleoo skills install @scope/pkg -s foo bar). Tokens that follow--skillare read as skill names, not package names, until the next option such as--json. - Options:
-f, --forceoverrides install when the target directory exists with the same skill name but is not managed by oo (no validoometadata). The previous directory contents are removed before the new skill is written; awarnlog records the overwrite.--forcedoes not bypass path containment, package validation, auth, or download validation; and it does not affect startup auto-sync,oo skills update,oo skills sync,oo skills uninstall, oroo skills publish. - Options:
--out-dir <dir>exports skills into<dir>instead of installing them into local agent skill directories. This is a pure export: it writes only inside<dir>and does not modify oo's managed storage or any agent home directory. Each selected skill is written to<dir>/<skill-id>/; an existing<dir>/<skill-id>directory is replaced, while other contents of<dir>are left untouched. Exported skills are keyed only by skill id, so when more than one selected skill resolves to the same id (across packages, or a registry skill that shares a bundled skill name) the last one written wins. Both bundled skills and published registry packages can be exported: a bundled skill name (or the no-argument form) is materialized offline, while a published package name is downloaded, extracted, and written in its published form. Registry exports send the active account'sAuthorizationheader. The-s, --skillfilter narrows which skills are exported from each registry package and, in the no-argument form, which bundled skills are exported; an explicit bundled skill name argument exports just that skill.--forcehas no effect in export mode. - Options:
--agent-format <agent>selects the render format for exported bundled skills and only applies together with--out-dir; using it without--out-dirfails. It does not reshape exported registry skills, which are always written in their published form. The default isuniversal(the~/.agentsformat). Accepted values areuniversal,claude,hermes,codebuddy,workbuddy,trae,trae-cn,openclaw,qoderwork, anddeepseek-tui. - Output: with
--out-dir, the command prints the exported skills and their target directory;--json/--format jsonemits an export report withcommand: "skills.install.export"that lists each exported skill'skind(bundledorregistry), sourcepackageName(nullfor bundled skills),path, and writtenfiles, plus the resolvedagentFormatandoutputDirectory. When a requested registry package cannot be exported, the failure is reported in the report'serrors[]and the command exits1. Skills exported before a later failure within the same package are still listed in the report's exported skills, yielding apartial-failurestatus. - Path rule: under
--out-dir, a registry skill name is accepted only when it is a single safe path segment that stays inside the output directory; otherwise the export is rejected withinvalid_pathbefore anything is downloaded or written. - Output: successful non-interactive installs print a compact summary grouped by installed skills and target AI agents. When exactly one target is written, the summary includes that target path. With several package names, each package prints its own summary in order.
- Notes: when a package publishes multiple skills, the command installs all of them; when it publishes exactly one skill, that single skill is installed.
- Canonical directory: bundled skills are materialized under
<config-dir>/skills/bundled/<agent>/<skill-id>, where<config-dir>is the directory that containssettings.tomland<agent>isuniversal,claude,hermes,codebuddy,workbuddy,trae,trae-cn,openclaw,qoderwork, ordeepseek-tui. - Canonical directory: published skills are materialized to
<config-dir>/skills/registry/<skill-id>. - Migration: on first run after upgrading,
oo skills installremoves legacy canonical directories left over from earlier releases (claude-skills/,openclaw-skills/, and any bundled or registry skill directory that lived directly underskills/). Bundled skills are rebuilt automatically in the new layout; previously-installed published skills must be reinstalled withoo skills install <packageName>. - Target directory: bundled and published skills are published to the universal
~/.agentshost (created when missing) and each other existing supported host directory, currently~/.agents/skills/<skill-id>,~/.claude/skills/<skill-id>,${HERMES_HOME:-~/.hermes}/skills/<skill-id>,~/.codebuddy/skills/<skill-id>,~/.workbuddy/skills/<skill-id>,~/.trae/skills/<skill-id>,~/.trae-cn/skills/<skill-id>,${OPENCLAW_HOME:-~/.openclaw}/skills/<skill-id>,~/.qoderwork/skills/<skill-id>, and~/.deepseek/skills/<skill-id>. - Target directory: if an existing supported host is missing its
skillsroot, the command creates that root before publishing the selected skill. - Path rule: published skill names are accepted only when their resolved
canonical and target directories remain under those local
skillsroots. - Installation mode: bundled and published skills are copied into every target skills directory. Existing oo-managed symlink targets from older releases are replaced with copied directories when the skill is installed, refreshed, or updated explicitly.
- Metadata: new bundled and registry writes include a hidden
.oo-metadata.jsonfile with an oo source marker and schema version. Bundled metadata records the currentooversion; registry metadata records the source package and package version. Metadata files from older releases that lack the schema version marker are no longer recognized asoometadata. - Notes: all registry requests for published skills send the active account's
Authorizationheader. - Notes: a same-name target directory without valid
oometadata is treated as a non-OOMOL skill; the install fails withname_conflictfor that skill unless--forceis used (which overwrites it). A same-name skill already managed byoois overwritten, including when it was installed from a different package. An empty target directory holds no skill, so it never conflicts: the install writes into it and reportspreviousState: "absent". - Notes: the universal
~/.agentshost is available whenever its skill directory can be created (the directory itself is created when missing), so the command normally has at least one install target. It drops out only when somethingoocannot create a directory at occupies~/.agents/skills, and the command reportsno_supported_hostswhen that leaves no usable host. - Notes: an existing bundled or registry skill installation is considered
managed by
ooonly when its.oo-metadata.jsonidentifies that source. Otherwiseootreats it as a different skill and will not overwrite it. - Options:
--json/--format jsonemits a structured payload (see "JSON output for mutation commands" below). error.codeenum (install JSON):not_authenticated/no_supported_hosts/invalid_path/invalid_package_specifier/package_lookup_failed/package_download_failed/invalid_package_archive/skill_not_found_in_package/name_conflict/storage_conflict/publication_failed/skill_filter_no_match/unknown.targets[].previousStateis one ofabsent | managed | unmanaged | unknown. With--force, an overwritten unmanaged target is reported asinstalledwithpreviousState: "unmanaged".
Upload installed oo-managed registry skills to the skills sync service.
- Options:
--source <source>selects the sync source. The only supported value isregistry; when omitted, the command usesregistry. - Options:
-i, --ignore <patterns...>excludes registry skills from upload by matching patterns against eitherpackageNameor skill name. The option may be repeated, and each value may contain comma-separated patterns. Patterns use gitignore-style matching. - Scope: the command uploads only installed published registry skills whose
.oo-metadata.jsonidentifies registry ownership and package identity. Bundled and local skills are never uploaded. - Request: the command sends
PUT https://api.<endpoint>/v1/skillswith a JSON array of{ "packageName": string, "version": string, "skillName": string }. The active account'sAuthorizationheader is included. - Behavior: the server-side manifest is overwritten, including with an empty array when no registry skills remain after filtering.
- Output: on success, text output prints the number of uploaded registry skills.
- Options:
--json/--format jsonemits a structured payload. Unlike the other mutation commands,oo skills sync upload --jsonuses a top-levelrecords[]instead ofskills[]/targets[], because the operation unit is the sync record, not an agent-side install target. The payload still includescommand,status,summary, anderrors[]. error.codeenum (sync upload JSON):not_authenticated/no_supported_hosts/sync_upload_failed/sync_invalid_response/unknown.- Behavior: when the upload request fails, the JSON payload still includes the
records[]that would have been uploaded, and the command exits1.
Install uploaded oo-managed registry skills into supported local skill directories.
- Aliases:
oo skills sync download,oo skills sync install. - Options:
--source <source>selects the sync source. The only supported value isregistry; when omitted, the command usesregistry. - Request: the command reads
GET https://api.<endpoint>/v1/skills. The active account'sAuthorizationheader is included. - Behavior: each uploaded entry is installed from its recorded
packageNameandversion, and only the recordedskillNameis selected from that package. - Scope: only registry skills are applied. Bundled and local skills are never restored by this command.
- Output: when the uploaded manifest is empty, text output reports that no uploaded registry skills were found. Otherwise, regular install summaries are printed, followed by a final applied-count line.
- Options:
--json/--format jsonemits a structured payload withskills[](one entry per applied record). Single-record install/lookup failures are reported inskills[].status = "failed"with a stableerror.code; only sync-protocol failures (manifest download, response schema) go to top-levelerrors[]. error.codeenum (sync apply JSON):not_authenticated/no_supported_hosts/invalid_path/package_lookup_failed/package_download_failed/invalid_package_archive/publication_failed/sync_download_failed/sync_invalid_response/unknown.
Update installed oo-managed published skills.
- Arguments:
[packageName...]accepts zero or more package names. Breaking change: in earlier releases these positional arguments were skill ids; they are now package names. - Arguments: when omitted, the command updates every installed oo-managed registry skill.
- Arguments: when one or more package names are given, the command updates every installed skill that belongs to each named package. All installed skills of a package are updated together.
- Unknown package: a package name that has no installed oo-managed skill fails
with
package_not_installed. In text mode the command aborts with an error; with--jsonthe failure is reported per entry and the command exits1. - Bundled skills: bundled skills such as
oo,oo-find-skills,oo-create-skill, andoo-publish-skillare excluded from this command. Passing a bundled name as a package argument fails withbundled_unsupported. Refresh them withoo skills add, or let a successfuloo installoroo updaterefresh them automatically. - Ownership rule: a skill is considered managed for update only when its
.oo-metadata.jsonidentifies registry ownership and package identity; bundled and local metadata are ignored by this command. - Published skills: registry-backed skills derive their package identity from
.oo-metadata.json, then fetch package info without an explicit version to determine the latest available package version. - Update order: the command refreshes the canonical
<config-dir>/skills/registry/<skill-id>copy before republishing to each existing supported host directory. - Interactive terminals: renders live progress while checking and updating skills.
- Non-interactive terminals: prints one status line for each current or failed skill, and one success line for each updated host target path.
- Options:
-s, --skill <skills...>limits the update to the named skills. The option is optional and accepts multiple values (for example-s foo bar). Matching is case-insensitive and accepts either the skill name or its directory name. Names that match no installed skill are ignored. When none of the requested names match the resolved skills, the command fails (text mode aborts with an error listing the resolved skills;--jsonreportsskill_filter_no_matchand exits1). - Options: because
-s, --skillaccepts multiple values, put any package names before it (for exampleoo skills update @scope/pkg -s foo). Tokens that follow--skillare read as skill names, not package names, until the next option such as--json. - Options:
--json/--format jsonemits a structured payload (see "JSON output for mutation commands" above). skills[].status(update JSON):updated | repaired | current | failed.updated: the version was bumped on at least one host.repaired: the version did not change, but a host publication was rewritten (legacy symlink, metadata drift, etc.).current: no host needed any write.
error.codeenum (update JSON):not_authenticated/no_supported_hosts/invalid_path/bundled_unsupported/package_not_installed/package_lookup_failed/package_download_failed/invalid_package_archive/publication_failed/skill_filter_no_match/unknown.
Check whether installed oo-managed registry skills have a newer published version, or have drifted from their canonical content. Read-only: the command never downloads a package archive or writes to any skill directory.
-
Arguments:
[packageName...]accepts zero or more package names. Breaking change: in earlier releases--skilltook skill ids and was the primary selector; that role is now filled by these positional package-name arguments. (--skillstill exists as an optional filter — see Options.) -
Arguments: when omitted, the command checks every installed oo-managed registry skill.
-
Arguments: when one or more package names are given, the command checks every installed skill that belongs to each named package. Duplicate package names are de-duplicated; the original input order is preserved in the output.
-
Options:
-s, --skill <skills...>limits the check to the named skills. The option is optional and accepts multiple values (for example-s foo bar). Matching is case-insensitive and accepts either the skill name or its directory name. Names that match no resolved skill are ignored. When none of the requested names match the resolved registry skills, the command fails and exits1with an error listing the available skills (no JSON payload is emitted in that case). -
Options: because
-s, --skillaccepts multiple values, put any package names before it (for exampleoo skills check-update @scope/pkg -s foo). Tokens that follow--skillare read as skill names, not package names, until the next option such as--json. -
Options:
--format=jsonand--jsonswitch to a structured payload.--show-schema-version(only meaningful with JSON) prependsschemaVersion. -
Scope: only
registrykind skills are checked. A bundled name, or a package name with no installed oo-managed skill, is reported as afailedentry whoseskillIdechoes the requested package name (each carries a stableerror.code). -
Network: requires the current OOMOL account because the latest package version is fetched from the registry's package-info endpoint. The command does not download package tarballs.
-
JSON shape:
{ "summary": { "registrySkills": 3, "registrySkillUpdates": 1, "registrySkillRepairs": 1, "registrySkillsCurrent": 1, "registrySkillFailures": 0 }, "skills": [ { "skillId": "demo", "packageName": "@alice/demo", "currentVersion": "0.1.0", "latestVersion": "0.2.0", "status": "update-available" }, { "skillId": "foo", "packageName": "@alice/foo", "currentVersion": "0.2.0", "latestVersion": "0.2.0", "status": "up-to-date" }, { "skillId": "bar", "packageName": "@alice/bar", "currentVersion": "0.2.0", "latestVersion": "0.2.0", "status": "repair-required" } ] } -
statusvalues:update-available— registry latest is newer than the installed version;oo skills updatewill upgrade.up-to-date— installed version matches the registry latest, and all host directories match the canonical publication.repair-required— installed version equals the registry latest, but the host publication has drifted from the canonical layout in a way thatoo skills updatewould rewrite. Concretely this fires when the host directory is a legacy symlink (instead of a real copy) or when its.oo-metadata.jsonrecords a different package/version than the canonical metadata. Content-level changes to host files are not detected here; runoo skills info --jsonto inspect hostcontrolStatefor content drift.failed— the skill could not be checked. The entry includeserror.code(machine-readable enum) anderror.message(English template).
-
currentVersionis the highest version among the skill's installed copies (the shared canonical copy and every agent host copy); copies left behind by a partial update are reported throughstatus, not by loweringcurrentVersion.oo skills sync uploadreports the same version. -
Exit code: the command exits
0even when individual entries arefailed, because failure is encoded in the payload. Argument errors (for example--format xml) still exit2. -
error.codeenum:bundled_unsupported/package_not_installed/package_lookup_failed/unknown.
oo skills install, oo skills uninstall, oo skills update, and
oo skills sync apply share a common JSON envelope:
{
"command": "skills.install",
"status": "completed",
"summary": { /* per-command counters */ },
"skills": [
{
"skillId": "demo",
"kind": "bundled | registry | local | unknown",
"packageName": "@alice/demo",
"previousVersion": "0.1.0",
"version": "0.2.0",
"status": "<per-command enum>",
"targets": [
{
"agentId": "universal",
"status": "<per-command enum>",
"path": "/Users/.../.agents/skills/demo",
"sourcePath": "/Users/.../oo/skills/managed/demo",
"version": "0.2.0",
"previousVersion": "0.1.0",
"previousState": "absent | managed | unmanaged | unknown",
"error": { "code": "<stable code>", "message": "..." }
}
],
"error": { "code": "<stable code>", "message": "..." }
}
],
"errors": [{ "code": "<command-level code>", "message": "..." }]
}oo skills sync upload uses records[] instead of skills[]/targets[],
because the operation unit is the sync record, not an install target.
Common rules:
commandis one ofskills.install/skills.uninstall/skills.update/skills.sync.upload/skills.sync.apply.statusiscompleted/partial-failure/failed/noop.targets[]is per-agent. Foruninstall/update, each target may includepreviousVersion;installtypically usespreviousState.error.messageis a fixed English template; it is not localized.--show-schema-versionprepends a top-levelschemaVersionfield.- Argument errors (for example
--format xml) still exit2and do not produce JSON. Other failures still emit the JSON payload and exit1. - The JSON payload never includes
apiKey, raw HTTP request/response bodies, stack traces, or unredacted endpoint secrets.
Control whether agents may load a bundled skill without being asked to. This is
a command group with three subcommands, and it applies only to the four bundled
skills (oo, oo-find-skills, oo-create-skill, oo-publish-skill). Registry
and local skills are unaffected.
Turning auto-trigger off leaves the skill installed and still invocable by name
— /oo in Claude Code and Claude-compatible agents, $oo in Codex. What
changes is that the agent no longer offers to use it on its own.
- Scope: the setting is per skill, not per agent. One run applies it to every supported agent host, using whichever mechanism that agent understands.
- Persistence: the choice is stored in the CLI settings file under
[skills.auto_trigger]and survives across sessions. - Application: the setting is an input to skill publication, not a runtime
switch.
off/onrepublish the bundled skills immediately. Startup synchronization does not detect a hand-edited[skills.auto_trigger]; apply one withoo skills repair --skill oo --skill oo-find-skills --skill oo-create-skill --skill oo-publish-skill(--skillis required). --allis a standing policy, not a snapshot: bundled skills added by later releases are covered by it without a further command. While it is in force, a per-skilloff/onstill updates the stored list but changes nothing an agent can see, and the text output says so.- Consequence: with auto-trigger off, an agent that hides a skill's description
from its own context can no longer act on it unprompted. The bundled
ooskill's end-of-session suggestions are one such behavior and stop happening until auto-trigger is turned back on.
Make bundled skills manual-only.
- Arguments:
[skillName...]bundled skill names to make manual-only; they are added to a persisted list, de-duplicated and sorted. - Options:
--allmakes every bundled skill manual-only, now and in future releases, and clears the per-skill list because it supersedes it.--json/--format json/--show-schema-versioncontrol output. - Validation: pass skill names or
--all, not both and not neither; either misuse exits2. A name that is not a bundled skill exits2and lists the accepted names. - Safety: a same-name skill directory that
oodoes not manage is left untouched and reported as skipped. This differs fromoo skills install, which fails the run on such a directory: changing a preference must still reach the other agents. - Exit code:
1when the setting was saved but one or more skill targets could not be republished; the message names them and gives theoo skills repaircommand to finish applying it.
Let agents load bundled skills on their own again.
- Arguments:
[skillName...]bundled skill names to remove from the list. - Options:
--allrestores the shipped default for every bundled skill, clearing both the standing policy and the per-skill list, so nothing is left silently manual-only. Output options matchoff. - Validation: as
off, except thatonalso accepts a name the storeddisabledlist already holds even when it is not a bundled skill in this release. Removing an entry is the command's job, and a bundled skill dropped by a later release would otherwise be unclearable except with--all. - Safety and exit codes match
off.
Show the configured auto-trigger policy for every bundled skill.
- Options:
--json/--format json/--show-schema-version. - Text output: a headline stating the overall state, then one line per bundled
skill reading
auto,manual, ormanual (all). - Scope: this reports the stored setting, not what is currently published. The two agree unless the settings file was edited by hand without republishing — see Application above.
status emits the state; off and on emit the same state plus what they
published.
{
"disabled": ["oo-create-skill"],
"disabledAll": false,
"skills": [
{ "autoTrigger": true, "name": "oo", "reason": "default" },
{ "autoTrigger": true, "name": "oo-find-skills", "reason": "default" },
{ "autoTrigger": false, "name": "oo-create-skill", "reason": "skill" },
{ "autoTrigger": true, "name": "oo-publish-skill", "reason": "default" }
],
"publications": [
{ "agent": "universal", "skill": "oo", "status": "published" },
{ "agent": "claude", "skill": "oo", "status": "skipped" }
]
}disabledechoes the persisted per-skill list verbatim, including a name that no longer matches a bundled skill in this release. Such an entry has no effect; clear it withon <name>, which accepts a name the list already holds.reasonisdefault(auto-trigger on),skill(this skill was named), orall(the standing policy covers it).alloutranksskill.publicationsis present onoffandononly.statusis one ofpublished,skipped(target not managed byoo), orfailed.
End-of-session skill suggestions for the bundled oo skill, plus controls to
silence them. The bundled oo skill calls these commands, but they can also be
run directly. This is a command group with three subcommands.
Given the connector services used during a session, decide which skills to suggest installing or updating and which to skip.
-
Arguments:
[connectorService...]accepts zero or more connector service identifiers (theservicefield fromoo search). Each is mapped to one skill package by prependingoo-and replacing underscores with hyphens (github→oo-github,aliyun_oss→oo-aliyun-oss). Blank entries are ignored; the derived packages are de-duplicated and their input order is preserved in the output. With no arguments the plan is empty. -
Options:
--format=jsonand--jsonswitch to a structured payload.--show-schema-version(only meaningful with JSON) prependsschemaVersion.--forcere-surfaces suggestions that the session cooldown would otherwise suppress (see below). -
Behavior: each derived
oo-<service>package is confirmed against the registry. It is suggested forinstallwhen it is published but not installed locally; forupdatewhen an installed package has a newer published version; and skipped when it is already current, not published, previously dismissed, or globally muted. When suggestions are globally muted, the plan returnsmuted: truewith no recommendations. -
Session cooldown: once a suggestion is surfaced, the same suggestion is suppressed on later runs for a short window so a repeated wrap-up does not re-surface it every time. A suppressed suggestion is returned under
skippedwith reasonrecently-suggestedinstead ofrecommendations. The window is per suggestion: switching to a different service, or a suggestion whose content changes (for exampleinstallbecomingupdate, or a newer latest version), surfaces again, as does passing--force. Globally muted plans surface nothing and do not start a cooldown. This suppression is best-effort: if its on-disk state is unavailable the plan is returned without de-duplication. -
Network: every non-dismissed, non-muted package is verified with a public registry package-info request (existence + latest version). This endpoint needs no login, so no account or API key is required — the active account's endpoint is used when present, otherwise the default. Requests run with a small bounded concurrency. Dismissed and muted packages need no network. A
404is treated as "not published" (silently skipped); any other failed lookup skips that package instead of failing the command. -
JSON shape:
{ "muted": false, "recommendations": [ { "packageName": "oo-gmail", "action": "install" }, { "packageName": "oo-notion", "action": "update", "currentVersion": "1.0.0", "latestVersion": "1.2.0" } ], "skipped": [ { "packageName": "oo-drive", "reason": "up-to-date" }, { "packageName": "oo-slack", "reason": "dismissed" } ] } -
actionvalues:install/update. -
reasonvalues:up-to-date/not-published/dismissed/muted/lookup-failed/recently-suggested. -
Exit code:
0even when a lookup fails or a package is unpublished (both are encoded as skips). Argument errors (for example--format xml) exit2.
Stop suggesting packages so later sessions no longer surface them.
- Arguments:
[packageName...]package names to stop suggesting; they are added to a persisted dismissal list, de-duplicated and sorted. - Options:
--allmutes every future suggestion instead of specific packages.--format=json/--json/--show-schema-versioncontrol output. - Validation: pass package names or
--all, not both and not neither; either misuse exits2. - Persistence: the choice is stored in the CLI settings file under
[skills.recommend]and survives across sessions. - JSON shape:
{ "muted": <bool>, "dismissed": ["oo-gmail", ...] }— the resulting persisted state.
Resume suggesting packages.
- Arguments:
[packageName...]package names to remove from the dismissal list. - Options:
--allclears the global mute instead of specific packages. Output options matchmute. - Validation: pass package names or
--all, not both and not neither; either misuse exits2. - JSON shape:
{ "muted": <bool>, "dismissed": [...] }— the resulting persisted state.
Remove oo-managed skills from supported local skill directories.
- Alias:
oo skills remove [skills...]. - Arguments: when no name is provided, the command removes all bundled skills.
- Arguments: one or more names may be provided and may mix skill names and
package names, e.g.
oo skills remove @scope/pkg other-skill. - Options:
--agent <agent>narrows local skill removal to one supported agent. It is used to disambiguate same-name local skills across agents. - Name resolution: each name is first treated as a skill name. The command checks bundled skills, agent-native local skills, and published registry installations for that name. When a registry and a local skill share the name, both are removed, and registry installations are removed before local installations.
- Package fallback: when a name matches no installed skill, it is treated as a
package name and every installed registry skill that belongs to that package
is removed. A name that starts with
@and contains/(a scoped package identity, e.g.@scope/pkg) is always treated as a package and is never tried as a skill name. - Package ownership: package matching uses each installed skill's recorded package identity. A skill installed from a different package is never removed, even when another package publishes a skill with the same name.
- Multiple names: with
--jsonevery name is attempted and per-name outcomes are aggregated into the report. In text output the names are processed in order and the first failure stops the run. - Ownership rule: a bundled skill is removable from a supported host only when
that host's installed directory has a
.oo-metadata.jsonfile that identifies bundled ownership. - Ownership rule: a local skill is removable when its agent skill directory
contains
.oo-metadata.jsonidentifying local ownership. - Local ambiguity: when no
--agentis provided and multiple agent-native local skills with the requested name exist, the command prints an error, exits non-zero, and does not remove any local skill. If exactly one local match exists, it is removed. - Canonical directory removed: bundled skills remove
<config-dir>/skills/bundled/<agent>/<skill>for each installed agent. Published skills remove<config-dir>/skills/registry/<skill>. - Target directory removed: bundled and published skills are removed from every
existing supported host directory, currently
~/.agents/skills/<skill>,~/.claude/skills/<skill>,${HERMES_HOME:-~/.hermes}/skills/<skill>,~/.codebuddy/skills/<skill>,~/.workbuddy/skills/<skill>,~/.trae/skills/<skill>,~/.trae-cn/skills/<skill>,${OPENCLAW_HOME:-~/.openclaw}/skills/<skill>,~/.qoderwork/skills/<skill>, and~/.deepseek/skills/<skill>. Local skills remove only the selected agent-native local directory. - Path rule:
[skill]must resolve to child directories under those localskillsroots. Names that escape those roots are rejected. - Notes: when no supported target has a managed installation and no matching
agent-native local skill exists for the requested skill, or an existing same-name
target is not managed by
oo, the command exits with an error. - Options:
--json/--format jsonemits a structured payload (see "JSON output for mutation commands" above). skills[].status(uninstall JSON):removed | failed.targets[].status:removed | absent | unmanaged | failed.error.codeenum (uninstall JSON):no_supported_hosts/invalid_path/not_installed/not_managed/ambiguous_local_skill/remove_failed/unknown.- Behavior with
--jsonand no[skill]argument: the command still only uninstalls bundled skills; the existing scope is preserved verbatim.
Force re-deploy one or more oo-managed skills from their trusted source into one or more agent skill directories. Always overwrites the target directory.
This is not oo skills update: the command never goes to the network, never
fetches a new registry package version, and never changes the package or
version that is recorded for an installed skill. It only rewrites the agent
copy from the trusted local source.
- Options:
--skill <skill>is required and may be repeated to repair multiple skills. Inputs are de-duplicated; input order is preserved. - Options:
--agent <agent>may be repeated to choose target agents. When omitted, the command targets every currently-available supported agent (the same set used byoo skills installdefaults). Inputs are de-duplicated. - Options:
--json/--format jsonemits a structured payload (see JSON output below).--show-schema-version(only meaningful with JSON output) prependsschemaVersion. - Source priority:
- If
<skill>is a bundled skill name (oo,oo-find-skills,oo-create-skill,oo-publish-skill), the command re-materializes the per-agent bundled canonical source from the CLI's embedded assets, then publishes that canonical source to the target agent. A repair on a bundled skill therefore also refreshes the canonical bundled storage at<config-dir>/skills/bundled/<agent>/<skill>. - Otherwise, the command checks
<config-dir>/skills/registry/<skill>for managed registry metadata. If found, the command publishes the canonical registry source to the target agent. Registry repair never refreshes the canonical registry directory. - If the skill is only known as a local skill in an agent's
skillsdirectory, the command exits witherrors.skills.repair.localUnsupported.repairdoes not copy local skills across agents. - If neither bundled nor managed registry source can be found, the affected
(skill, agent)pair surfaces as a per-pair failure witherror.code: source_not_found. The command does not fall back to copying from one host's installed directory into another.
- If
- Overwrite semantics: the target host directory is rewritten regardless of
whether it is currently managed, manually modified, has corrupt metadata, or
is an unmanaged same-name directory.
repaircarries--force-style semantics for the exact(source, target agent, skill)pair that it resolves. - Safety:
repairdoes not bypass path containment checks, the supported-agent name list, registry canonical metadata validation, startup auto-sync rules, or the existing safety borders foroo skills add,oo skills update,oo skills sync,oo skills publish, andoo skills uninstall. - Fail-soft execution: each
(skill, agent)pair is attempted independently. If any pair fails, the command continues with the remaining pairs, prints a summary of successes and failures, and finally exits non-zero. - Failure inputs that abort up-front (no JSON payload, normal CLI error):
- Missing
--skill->errors.skills.repair.skillRequired. --agentvalue outside the supported list -> existingerrors.skills.list.invalidAgent.- Explicit
--agentwhose home directory does not exist ->errors.skills.agentNotInstalled. - Skill resolves only as a local skill ->
errors.skills.repair.localUnsupported.
- Missing
- Text output: text output prints the success summary, a per-skill agent
list, and any failures. Text output never prints filesystem paths;
consumers that need machine-readable paths should use
--json.
{
"schemaVersion": "1.0.0",
"summary": {
"requestedSkills": 2,
"targetAgents": 3,
"repaired": 5,
"failed": 1
},
"results": [
{
"skill": "oo",
"kind": "bundled",
"agentId": "universal",
"status": "repaired",
"path": "/Users/name/.agents/skills/oo",
"sourcePath": "/Users/name/Library/Application Support/oo/skills/bundled/universal/oo",
"version": "1.2.3"
},
{
"skill": "chatgpt",
"kind": "registry",
"agentId": "claude",
"status": "failed",
"path": "/Users/name/.claude/skills/chatgpt",
"sourcePath": "/Users/name/Library/Application Support/oo/skills/registry/chatgpt",
"version": "0.4.0",
"error": {
"code": "write_failed",
"message": "Failed to write the skill source to the target agent directory."
}
}
]
}schemaVersion is included only when --show-schema-version is set.
error.code values are an enumerated, machine-readable set:
source_not_foundsource_invalidinvalid_pathwrite_failedunknown
error.message is a templated, scrubbed string; it never contains stack
traces, raw exception messages, or filesystem paths beyond what already
appears in the surrounding path / sourcePath fields.
Print the current persisted debug log directory path.
Print one previous persisted debug log file.
- Arguments:
[index]is optional and must be an integer greater than or equal to1.1means the previous log file, and larger values continue walking backward through retained logs. - Notes: the current
oo log printinvocation creates its own log file, so the command always skips the current run and reads earlier logs.
Download one file from http or https and save it locally.
- Arguments:
<url>is required and must use thehttporhttpsscheme. - Arguments:
[outDir]is optional. When omitted, the CLI uses the configuredfile.download.out_dirvalue if present, otherwise~/Downloads. Missing directories are created automatically. If the path already exists and is not a directory, the command fails. - Notes:
[outDir]andfile.download.out_dirmay start with~, which expands to the current user's home directory. - Options:
--name <name>overrides only the saved base name. The value must be non-empty, must not be.or.., and must not contain path separators. - Options:
--ext <ext>overrides only the saved extension. The value may be written with or without a leading., but it must be non-empty, must not be.or.., and must not contain path separators. - Notes: when
--nameor--extis not provided, the CLI infers the saved file name from the final response metadata and URL. - Notes: if the inferred saved file name would be opaque, use
--nameto pick a clearer base name while keeping the inferred extension. - Notes: known composite extensions such as
.tar.gzand.pkg.tar.zstare preserved as one full extension when they can be inferred automatically. - Notes: downloads are written through a temporary file in the target directory, then promoted to the final path only after the transfer completes.
- Notes: each in-progress download owns an isolated temporary file in the target directory. Concurrent downloads of the same URL and output directory do not merge or append to one another's partial files.
- Notes: if a download stops partway through, rerunning the same command against
the same output directory will attempt to resume with HTTP Range. If the
server does not resume safely, the CLI restarts the transfer from byte
0. - Notes: resume metadata is best-effort. If local resume metadata cannot be read or written, the current download can still complete, but later resume may not be available.
- Notes: if the final target path already exists, the CLI never overwrites it
and instead appends
_1,_2, and so on before the full extension. - Notes:
oo file downloaddoes not support--format=jsonor--json. - Notes: successful
stdoutoutput is one localized human-readable line that includes the absolute saved path, followed by a newline. Whenstderris a TTY, human-readable progress is rendered there.
Upload one file to the temporary file cache.
- Arguments:
<filePath>is the local file path to upload. - Options:
--format <format>returns structured output. Supported value:json. - Options:
--jsonis an alias for--format=json. - Options:
--team <team>uploads the file under the given team, so the upload is billed and metered under that team. When omitted, the team comes fromOO_TEAM_ID/OO_TEAM_NAMEwhen set, otherwise the active account's default team. - Notes: the team selection is sent only to the file service requests; the presigned part uploads go straight to storage without it.
- Notes: the uploaded file expires after seven days and is deleted on the server.
- Notes: files larger than
500 MiBare rejected. - Notes: successful uploads persist a local sqlite record with the upload time, file name, file size, signed download URL, expiry time, and a UUID v7 id.
- Notes: JSON and text output return
downloadUrlas a URI-safe signed URL. ThefileNamefield keeps the original uploaded file name.
List previously uploaded files from the local sqlite store.
- Options:
--status <status>filters records by expiry state. Supported values:active,expired. - Options:
--limit <limit>limits the number of returned records. The value must be an integer greater than or equal to1. - Options:
--format <format>returns structured output. Supported value:json. - Options:
--jsonis an alias for--format=json. - Notes: the command does not delete expired records implicitly.
- Notes: output normalizes legacy signed download URLs when possible, while
leaving
fileNameunchanged.
Delete expired or stale file transfer records.
- Options:
--format <format>returns structured output. Supported value:json. - Options:
--jsonis an alias for--format=json. - Notes: local upload records with
expiresAt <= noware deleted. - Notes: download resume sessions older than 14 days are deleted when they are not owned by an active download process.
- Notes: the JSON response shape is
{ "deletedCount": number }.
Upload one HTML file to long-term website storage and print the public URL it is served from.
- Arguments:
<filePath>is the local HTML file to upload. Its name must end with.htmlor.htm(case-insensitive); other files are rejected with exit2. - Options:
--format <format>returns structured output. Supported value:json. - Options:
--jsonis an alias for--format=json. - Options:
--team <team>uploads the website under the given team, so the upload is billed and metered under that team. When omitted, the team comes fromOO_TEAM_ID/OO_TEAM_NAMEwhen set, otherwise the active account's default team. - Notes: the command requires an OOMOL account. Without one it fails with exit
1and asks you to log in first. - Notes: websites are stored per team. When the account belongs to no team,
the command fails with exit
1and asks you to create or join one. - Notes: the team selection is sent only to the website service request; the file itself goes straight to storage without it.
- Notes: files larger than
20 MiBare rejected with exit2. - Notes: the file is served as
text/htmlfromhttps://r2.inklycat.com, does not expire, and is readable by anyone who has the URL. - Notes: every upload gets a new URL of the form
https://r2.inklycat.com/v1/<teamId>/<id>/index.html. The local file name is not part of it, and uploading again does not replace an earlier website. - Notes: the JSON response shape is
{ "fileName": string, "fileSize": number, "url": string }. - Notes: text output is the localized success line followed by the file size and the URL.
Store and read named string variables in the OOMOL cloud. Aliases:
oo variable, oo var, oo vars. All subcommands require the current
account; values are stored as strings (serialize JSON yourself if needed).
Variables belong to a team, not to a single user: every member of the team
reads and writes the same set, and the last write wins. Each subcommand
resolves the team it acts for with the shared ladder --team <team> >
OO_TEAM_ID > OO_TEAM_NAME > the active account's default team > the
server-side default team. With nothing selected the command sends no team
selection and the server applies its own default team; there is no private,
per-user scope. An empty --team value exits 2.
Every subcommand accepts --team <team>. An account that
belongs to no team at all cannot use variables: the command exits 1 and says
so. Selecting a team the account is not a member of, or one that does not
exist, also exits 1.
List all variables of the current team, most recently updated first (no pagination; up to 200 per team).
- Text output: one line per variable,
nameandupdatedAtonly. Full values are not printed; useoo variables getor--jsonto read a value. - Options:
--team <team>runs the command for that team. - Options:
--format <format>/--jsonreturn structured output as{ "variables": [{ "name", "value", "updatedAt", "updatedBy" }] }with full values.updatedByis the id of the team member who last wrote the variable and is absent when the service does not report one.
Read the value of a variable of the current team.
- Arguments:
<name>is required (1-256 characters; no/or control characters). - Text output: the raw value followed by a newline.
- Options:
--team <team>selects the team, as foroo variables list. - Options:
--format <format>/--jsonreturn{ "name", "value", "updatedAt", "updatedBy" }. - Notes: exits non-zero if the variable does not exist.
Create or replace a variable for the current team (last-write-wins).
create and update are identical.
- Arguments:
<name>is required.[value]is an optional positional value. - Value source: exactly one of
[value],--from-file <path>, or--stdinmust be provided. An empty string is allowed. - Options:
--from-file <path>reads the value verbatim from a UTF-8 file. - Options:
--stdinreads the value verbatim from standard input until EOF; it errors if stdin is an interactive terminal. - Options:
--team <team>selects the team, as foroo variables list. - Options:
--format <format>/--jsonreturn{ "name", "value", "updatedAt", "updatedBy" }. - Notes: the value is limited to 64 KiB (65536 bytes, UTF-8).
- Notes: each team can store at most 200 variables; exceeding the quota exits
1.
Delete a variable of the current team. Idempotent: succeeds even if the name does not exist.
- Arguments:
<name>is required. - Options:
--team <team>selects the team, as foroo variables list. - Options:
--jsonreturns{ "name", "deleted": true }.
Generate a shell completion script.
- Arguments:
<shell>is the target shell. Supported values:bash,zsh,fish. - Behavior: the generated script dynamically completes accessible team names
for
oo team use <name>. These candidates use a per-account, per-endpoint cache with a one-minute lifetime.