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

# The vf command line interface

> Manage Voiceflow agents, knowledge bases, transcripts, analytics, and environments from your terminal or CI with the official vf CLI.

## Install with an AI agent

Paste this prompt into your coding agent (Claude Code, Cursor, Codex) to install `vf` and sign in.

```text Install prompt wrap
Install the Voiceflow CLI (`vf`) and sign me in. Run everything yourself and keep your messages short.

1. Install or update: `curl -fsSL https://raw.githubusercontent.com/voiceflow/cli/master/scripts/install.sh | bash` (Windows: `iwr -useb https://raw.githubusercontent.com/voiceflow/cli/master/scripts/install.ps1 | iex`). If `vf` is already installed, set `VF_INSTALL_DIR` to its folder first so it updates in place. Check with `vf version`. If `vf` isn't on PATH, use the full path the installer printed.

2. Run `vf workspace list -o json`. If it works, skip to step 4. If it returns `authentication_error`, I'm signed out: ignore its token hint, and never ask me for a password or token.

3. Sign-in calls back to this machine, so if you're on SSH, in a container or in a cloud sandbox, stop and tell me to run this locally. Otherwise, start `vf auth login --no-browser --login-timeout 15m` in the background, logging to a file. Parse the log as JSON and take `authorization_url` (for plain-text output, take the URL after "Open this URL to sign in"). Send me:

   > To connect the Voiceflow CLI:
   > 1. Sign in at https://creator.voiceflow.com (new to Voiceflow? Sign up at https://creator.voiceflow.com/signup).
   > 2. Open this link and click **Allow**: LINK

   You're done when the log shows `"status": "signed_in"`. If it fails or times out, retry once with a new link, then stop and show me the error.

4. Tell me the `vf` version, up to five workspaces (name and ID) plus the total, and the line that adds `vf` to my PATH if needed. Suggest `vf project list --workspace-id <id>` and `vf docs search "<question>"` as next steps.
```

The `vf` CLI is the official command line interface for Voiceflow. It covers the
same surface as the dashboard for day-to-day operations: inspect and update
agents, manage knowledge base documents, fetch transcripts and analytics, run
evaluations, and publish environments, all scriptable from your terminal or CI.

The CLI is built for automation first. Every command supports structured output
(`--output-format json`, `yaml`, `table`, or `toon`), a `--jq` flag for inline
filtering, and `--dry-run` to preview any request before it executes. Running
inside a coding agent such as Claude Code or Cursor enables `--agent-mode`
automatically, which switches on structured errors designed for tools to parse.

<Columns cols={2}>
  <Column>
    <Card title="Install" href="/docs/cli/install" icon="/docs/images/icons/download-m.svg">
      One command on macOS, Linux, or Windows.
    </Card>
  </Column>
  <Column>
    <Card title="Authenticate" href="/docs/cli/authentication" icon="/docs/images/icons/key.svg">
      Connect the CLI to your Voiceflow account.
    </Card>
  </Column>
  <Column>
    <Card title="Command reference" href="/docs/cli/commands/overview" icon="/docs/images/icons/console.svg">
      Every command, flag, and default, generated from the CLI itself.
    </Card>
  </Column>
  <Column>
    <Card title="Migrating from the community CLI" href="/docs/cli/migrating-from-the-community-cli" icon="/docs/images/icons/arrow-right.svg">
      Command mapping from the retired third-party voiceflow-cli.
    </Card>
  </Column>
</Columns>

## A first command

List your workspaces after [authenticating](/docs/cli/authentication). It doubles
as proof that the token works:

```bash
vf workspace list --output-format json
```

Then list the agent projects in a workspace, using an `id` from that output:

```bash
vf project list --workspace-id <workspace-id> --output-format json
```

Every command accepts `--help`, and the [command reference](/docs/cli/commands/overview)
carries the full tree. The reference is generated from the CLI source at a
pinned version, so it always matches the binary it documents.

## Where the CLI fits

- Use the CLI for scripting, CI pipelines, and bulk operations.
- Use the [APIs](/docs/api-reference/api-overview) when you are building an
  application or integration.
- Use the [MCP server](/docs/mcp/overview) when you are working from a coding
  assistant.

The CLI source lives at [github.com/voiceflow/cli](https://github.com/voiceflow/cli),
where releases and issues are tracked.