Skip to main content
These commands work on the CLI itself rather than on a project. All of them except obss whoami run without a sign-in, and only whoami has a Plugin (MCP) tool. API keys and background updates are on the CLI reference.

obss login

Sign in to Obss with your browser.
No Plugin (MCP) tool: an MCP host signs in with OAuth when it first calls a tool. Flags Also takes the global flags. Examples Sign in on this computer, or from a remote machine by opening the printed link on any computer:
Notes The CLI prints the sign-in link and a confirmation code on stderr, even with --quiet, and in a terminal it also opens the link in your browser. When you confirm the code in the browser, the command finishes, saves your sign-in, and makes your organization the active one. The result names you, your organization, and the dashboard URL. While OBSS_API_KEY is set, obss login refuses to sign in and exits with code 2. Unset the variable first, as Use an API key explains.

obss whoami

Show who the CLI acts as, in which organization, and whether it uses a sign-in or an API key.
Plugin (MCP) tool: get_identity Takes only the global flags. Examples
Result fields Notes To keep a script in one organization, pass organization.id to --expected-organization-id on later commands: they then fail if your sign-in moves to another organization. When you’re not signed in, the command exits with code 3 and tells you to run obss login.

obss logout

Remove your saved sign-in and your saved project from this computer.
No Plugin (MCP) tool: it acts only on the CLI on this computer. Takes only the global flags. Examples
Notes Running it twice is safe. While OBSS_API_KEY is set, commands keep using the key after you log out, and the CLI says so on stderr.

obss version

Show the installed version, its release channel, the platform, and whether background updates are on.
No Plugin (MCP) tool: it acts only on the CLI on this computer. Takes only the global flags. Examples
Result fields Notes obss --version prints the version and channel on one line. Neither command contacts Obss.

obss upgrade

Replace the installed obss binary with the latest release for its channel.
No Plugin (MCP) tool: it acts only on the CLI on this computer. Flags Also takes the global flags. Examples See whether a newer release exists, then install it:
Result fields Notes The command doesn’t contact the Obss API, so it still runs when other commands fail with client_update_required. Use it when you don’t want to wait for a background update. If the CLI can’t write its binary, the command tells you to reinstall in a folder you can write, such as ~/.local/bin or ~/.obss/bin. You don’t need sudo.

obss schema

Print machine-readable command definitions as JSON Schema.
No Plugin (MCP) tool: an MCP host reads each tool’s input schema from the server. Arguments Takes only the global flags. Examples List every command, then read the launch plan schema before you write a plan:
Result fields For one command, the result has these fields: Notes An unknown command name fails with usage_error. The command doesn’t contact Obss.

Next steps