opencomputer
Build, deploy, and run OpenComputer cloud agents from the shell
TLDR
SYNOPSIS
opencomputer [global options] command [arguments]
DESCRIPTION
opencomputer is the command-line client for OpenComputer, an open-source coding-agent service aimed at Slack and a hosted or self-hosted computer. The CLI calls the public HTTP API. It does not start a local agent server.Agent source lives under opencomputer/agents/. init creates one hello-world agent. link stores which cloud project this directory deploys to. doctor and deploy print that project before they change anything. An unlinked directory fails with the link command to run next.model connect claude and model connect codex attach a Claude or ChatGPT plan using a one-time code from the dashboard. They do not require opencomputer login. models and model-access are aliases of model.Compiled bundles are cached under node_modules/.cache/opencomputer/, not inside the opencomputer/ source tree.Install the published package with npx @opencomputer/cli, or run the opencomputer binary from a global install of that package. opencomputer-create is the separate scaffold command from the same package.
PARAMETERS
--api-url url
API base URL. Default https://app.opencomputer.dev. The same value can be set with the environment variable OPENCOMPUTER API URL (underscores between the three words).--api-key key
API key. Or set the environment variable OPENCOMPUTER API KEY (underscores between the three words).--json
Print machine-readable output. Errors are a JSON object on stderr.--idempotency-key key
Stable retry key for commands that change cloud state.--verbose
Print session events.--version
Print the CLI version and exit.login [--no-browser] [--force]
Sign in. whoami prints the current identity. logout [--local] signs out.init directory
Create an agent project. . means the current directory.link --project id-or-slug | --create-project name
Bind this directory to a cloud project. Later commands reuse that binding.doctor
Local checks before deploy, including secret names referenced in code.deploy [--alias development | production] [--watch]
Deploy the linked project. --watch keeps deploying as files change.run agent prompt [--keep]
Run one prompt on a deployed agent and print the remaining credit balance.secrets set name --value-stdin
Upload a secret. The value is read from stdin only. secrets list and secrets remove take --environment and --agent.env set name --value-stdin
Set an encrypted runtime environment variable, also from stdin only.logs [--follow]
Read runtime and managed-egress logs. --session limits the stream to one session.memory list | show | create | edit | export | remove
Manage memory documents for one environment. edit opens $EDITOR.webhooks create | list | enable | disable | rotate-token | remove
HTTPS hooks that start a fresh session. The bearer token is shown only when it is created or rotated.billing
Show the plan. upgrade prints the checkout link.
CAVEATS
Secret and runtime-env values are accepted only with --value-stdin. Putting the secret on the command line is rejected so it does not land in the shell history.When credits or a trial limit are exhausted, commands fail with HTTP 402. run prints a billing warning before that stop. Retrying the same command does not add credit.The default API is the hosted service at https://app.opencomputer.dev. Point --api-url at another deployment only when you mean to.
