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

# Auth and utility commands

> Sign in, sign out, read the docs in the terminal, and check the CLI.

The commands that do not run tasks: credentials, docs, and two health checks.

## `pome login`

Signs you in through the browser and stores a team API key. On macOS the key goes
to the Keychain; elsewhere it goes to `~/.pome/credentials.json`.

```bash theme={"dark"}
pome login
```

| Flag                    | Default               | Description                             |
| ----------------------- | --------------------- | --------------------------------------- |
| `--api-url <url>`       | `https://api.pome.sh` | Control-plane base URL.                 |
| `--dashboard-url <url>` | `https://app.pome.sh` | App URL that serves the sign-in page.   |
| `--key-name <name>`     | `pome login`          | Label for the API key this login mints. |

## `pome logout`

Removes locally stored credentials — the Keychain entry, `~/.pome/credentials.json`,
or both. Takes no flags.

```bash theme={"dark"}
pome logout
```

Signing out locally does not revoke the key on the server. Revoke it in
[app.pome.sh](https://app.pome.sh) if it may have leaked.

## Where credentials come from

Hosted commands resolve credentials in this order, and stop at the first hit:

1. `POME_API_KEY`
2. The macOS Keychain entry, `security find-generic-password -s pome-sh`
3. `~/.pome/credentials.json`, written by `pome login`

If none are set, hosted commands fail immediately rather than running unauthenticated.

## `pome docs`

Prints the docs.pome.sh URL for a topic, so you can go from the terminal to the
page without searching.

```bash theme={"dark"}
pome docs
pome docs getting-started
pome docs github
```

| Flag              | Default                | Description                                                  |
| ----------------- | ---------------------- | ------------------------------------------------------------ |
| `--site <origin>` | `https://docs.pome.sh` | Override the docs origin.                                    |
| `--url`           | on                     | Print URLs. Retained for compatibility; this is the default. |

## `pome version`

Prints the CLI version. Include it in any bug report.

```bash theme={"dark"}
pome version
```

## `pome health`

Runs an in-process smoke check against the bundled GitHub twin. It answers one
question: is this installation able to boot a twin at all? For agent wiring, use
[`pome doctor`](./doctor) instead.

```bash theme={"dark"}
pome health
```

## See also

* [`pome doctor`](./doctor) — checks the agent-to-twin wiring, not the install.
* [`pome init`](./init) — the next step after signing in.