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

# Quickstart

> Install the CLI, store an API key once, and run your first command. About five minutes.

**1. Install**

Needs Node.js 20 or newer. To try it without installing, write `npx reachboost-cli` in place of `reachboost`.

```bash theme={null}
npm install -g reachboost-cli
```

Check that it installed:

```bash theme={null}
reachboost --version
```

[Where the key is stored depends on your platform.](https://docs.reachboost.io/cli/authentication.md#where-the-key-is-stored)

**2. Store your API key**

1. In ReachBoost, open [Integrations > API keys](https://app.reachboost.io/integrations/api) and create a key. The workspace uuid is shown on the same page.
2. Run:

   ```bash theme={null}
   reachboost auth set-key --workspace "<workspace-uuid>"
   ```
3. Paste the key when asked. The CLI checks it against the workspace, stores it, and uses that workspace as the default for later commands until you change it with `reachboost workspaces use`.
4. See which key and workspace commands will use:

   ```bash theme={null}
   reachboost whoami
   ```

> [!TIP]
>
> Profiles, several workspaces and CI: see [Authentication](https://docs.reachboost.io/cli/authentication.md).

**3. Run your first command**

Reads print a table. Add `--help` to any command to see its flags.

```bash theme={null}
reachboost lead-lists list
reachboost campaigns list --status active
reachboost leads get "<lead-uuid>"
```

Every command, with its flags: see the [command reference](https://docs.reachboost.io/cli/commands.md).


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