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

# Sign in

> Sign the Companion in with a Companion Key from the dashboard.

The Companion signs in once per device with a Companion Key. The key is exchanged for a device credential that renews itself every thirty days.

**1. Issue a Companion Key**

Open the [dashboard](https://yocrow.dev/dashboard), select the **Companion Key** tab and choose **Issue Companion Key**. The key is shown once. Copy it before you close the panel.

**2. Run yocrow login**

```bash theme={null}
yocrow login
```

Paste the key at the prompt. The input is hidden.

```text nocopy theme={null}
Yocrow Companion is connected.
```

> [!WARNING]
>
> `yocrow login` needs an interactive terminal. It fails with `protected_input_required` when run with `--non-interactive` or from a script.

## Where credentials are stored

| Platform | Storage |
| - | - |
| macOS | Keychain |
| Linux | Secret Service |
| Windows | Credential Manager |

The Companion Key and the device credential are never written to a plain text file or printed.

## Sign out

```bash theme={null}
yocrow logout --yes
```

```text nocopy theme={null}
Yocrow Companion has been logged out.
```

Signing out revokes the device credential and clears every provider connection on this device.


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