> ## 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.

# All commands

> Every command the CLI has, grouped the way you type them, with arguments, flags and what each one is allowed to change.

One command per documented API operation, generated from the API reference, plus four built into the CLI: auth set-key, auth remove, whoami and workspaces use. An operation that is not documented cannot become a command.

```bash theme={null}
reachboost --help
reachboost leads --help
```

> [!NOTE]
>
> Command descriptions come from the CLI and the API reference, and are in English. This reference describes `reachboost` 0.2.0. [Open the API reference](https://docs.reachboost.io/api-reference/introduction.md).

## Global flags

Accepted by every command, before or after the command name.

**--api-url \<url>** `URL`

API base URL. Default [https://app.reachboost.io](https://app.reachboost.io), or REACHBOOST\_API\_URL. Only point it at a server you trust: the API key is sent there.

**--workspace \<uuid>** `uuid`

Workspace to act on. Or REACHBOOST\_WORKSPACE, or the profile's stored default.

**--profile \<name>** `string` (default: default)

Which stored key and default workspace to use. Or REACHBOOST\_PROFILE. Default "default".

**--timeout \<seconds>** `number` (default: 30)

Give up on a request after this many seconds, 1 to 3600. Default 30.

**--json** `boolean`

Print the API response as JSON on stdout and nothing else.

**--csv** `boolean`

Print list results as CSV on stdout (RFC 4180), for spreadsheets and pipelines.

**--columns \<fields>** `string`

Comma-separated fields to show in a table or CSV, instead of the defaults.

**--quiet** `boolean`

No status lines on stderr.

## Commands

What the labels mean:

Read-only

Changes data

Needs --yes

Needs --yes and --confirm-name

Not in this release

Not available through the CLI

Built into the CLI

> [card] [Authentication](https://docs.reachboost.io/cli/commands/auth.md)
>
> `reachboost auth` · 2 commands
>
> Storing, checking and forgetting the API key on this machine. The key itself is created and revoked in ReachBoost.

> [card] [whoami](https://docs.reachboost.io/cli/commands/whoami.md)
>
> `reachboost whoami` · 1 command
>
> Show which key and workspace commands will use, and check that they work.

> [card] [Workspaces](https://docs.reachboost.io/cli/commands/workspaces.md)
>
> `reachboost workspaces` · 8 commands
>
> The workspaces an agency key may act on, and which one this profile uses by default.

> [card] [Campaigns](https://docs.reachboost.io/cli/commands/campaigns.md)
>
> `reachboost campaigns` · 20 commands
>
> Outreach sequences and their messages. A campaign is created as a draft and can be edited, given messages and leads while it stays one; for those edits the CLI reads the status just before sending and refuses a campaign that has started (a check, not a transaction: a campaign started in that instant would still be edited). A flow campaign's steps are replaced with replace-flow, which still accepts changes to step content once the campaign has run. publish starts a draft. Pausing, finishing and stopping leads are not in this release.

> [card] [Inbox](https://docs.reachboost.io/cli/commands/inbox.md)
>
> `reachboost inbox` · 5 commands
>
> Conversations and messages from the connected LinkedIn accounts. Read-only: sending is done in the app, by a person.

> [card] [Integrations](https://docs.reachboost.io/cli/commands/integrations.md)
>
> `reachboost integrations` · 1 command
>
> List integrations a flow can push to.

> [card] [Invitations](https://docs.reachboost.io/cli/commands/invitations.md)
>
> `reachboost invitations` · 4 commands
>
> Invitations to join the workspace. Creating one sends the invitation mail and prints the link; withdrawing one stops the link working.

> [card] [Lead lists](https://docs.reachboost.io/cli/commands/lead-lists.md)
>
> `reachboost lead-lists` · 9 commands
>
> Named sets of leads, imported or scraped, that campaigns draw from.

> [card] [Leads](https://docs.reachboost.io/cli/commands/leads.md)
>
> `reachboost leads` · 13 commands
>
> The people in your workspace, whichever list or campaign they belong to, with their tags, custom fields and activity.

> [card] [Senders](https://docs.reachboost.io/cli/commands/senders.md)
>
> `reachboost senders` · 4 commands
>
> The LinkedIn accounts that send outreach. Deleting one cannot be undone.

> [card] [stats](https://docs.reachboost.io/cli/commands/stats.md)
>
> `reachboost stats` · 1 command
>
> Get statistics. Read-only. Returns aggregated campaign statistics for a date range.

> [card] [Tags](https://docs.reachboost.io/cli/commands/tags.md)
>
> `reachboost tags` · 5 commands
>
> Labels you attach to leads to group and filter them.

> [card] [Members](https://docs.reachboost.io/cli/commands/users.md)
>
> `reachboost users` · 4 commands
>
> The people who have access to the workspace. Only first and last names can be changed, not email addresses; admins cannot be removed from the command line.

> [card] [Webhooks](https://docs.reachboost.io/cli/commands/webhooks.md)
>
> `reachboost webhooks` · 5 commands
>
> Where ReachBoost posts events such as an accepted connection or a reply: list, create, change and remove a workspace's webhooks.


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