> ## Documentation Index
> Fetch the complete documentation index at: https://docs.openscaffold.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI

> Connect Claude Code to your OpenScaffold workspace. Node 22 or newer.

The CLI is the npm package [`@openscaffold/cli`](https://www.npmjs.com/package/@openscaffold/cli), current version **0.1.1**; it installs a command named `openscaffold`. It needs Node 22 or newer. `npx` runs it without a separate install, but uses a copy already installed in the project if there is one; to be sure you get the latest release, add `@latest`, as in `npx @openscaffold/cli@latest login`.

| Command | What it does |
| - | - |
| `npx @openscaffold/cli login` | Sign in (one browser click) and connect Claude Code. Ends with the status report. |
| `npx @openscaffold/cli status` | What's set up on this machine, and the next step. Add `--json` for coding agents. |
| `npx @openscaffold/cli logout` | Disconnect Claude Code and revoke this machine's login. |

## What `login` writes

Only to your user config, never into a repo:

* `~/.config/openscaffold/credentials.json`: your login, readable only by you
* the `openscaffold` MCP server in Claude Code, at user scope
* a SessionStart hook in `~/.claude/settings.json` that loads the right customer's briefing
* `/os-requirements`, `/os-what-changed`, `/os-check-plan` and `/os-demo-check` in `~/.claude/skills/`

`logout` removes all of it.

## Self-hosted or local servers

`login` reuses the server you last signed in to. To point it somewhere else, set `OPENSCAFFOLD_URL`:

```bash theme={null}
OPENSCAFFOLD_URL=https://app.openscaffold.ai npx @openscaffold/cli login
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.