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

# Custory CLI

> Create and work with customer journeys from your terminal or coding agent.

Use the Custory CLI when you want to create a useful first customer journey without opening the dashboard first.

The CLI helps you sign in, provide product context, choose the right workspace, create a journey, verify the saved structure, and open the result in Custory.

## What this is

The Custory CLI is a terminal tool for creating and working with customer journeys.

It is useful when:

* you are starting a new journey from a product website
* you already have a private product brief
* a coding agent can summarize bounded product context for you
* you want scripts or terminal tools to work with Custory directly

The shortest way to start is:

```bash theme={null}
npx @custory/cli@latest init
```

## What you need

Before you start, make sure you have:

* Node.js `22.12` or newer
* a Custory account
* access to the workspace where the journey should live, or permission to create a new workspace

Check your Node.js version:

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

## Platform support

| Platform | Status                                                                                                                         | Credential storage                                                      |
| -------- | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- |
| macOS    | Supported                                                                                                                      | macOS Keychain preferred.                                               |
| Linux    | Supported                                                                                                                      | Linux Secret Service preferred; private file fallback when unavailable. |
| Windows  | Available for command execution and MCP config paths, but no Windows-specific secure credential store is currently documented. | Private file fallback unless a supported secure store is added.         |

The supported install path is npm:

```bash theme={null}
npx @custory/cli@latest --version
npm install --global @custory/cli
```

For scripts where reproducibility matters, pin a specific version instead of using `@latest`.

## How it works

The first run follows a simple path:

1. Sign in to Custory in your browser.
2. Provide product context from a website or private brief.
3. Review the suggested journey and personas.
4. Let Custory create and verify the stored journey.
5. Open the journey URL and make the first useful edits with your team.

This creates a starting structure, not final customer truth. Treat the output as a strong draft that your team should review against real customer evidence.

## Choose your path

<CardGroup cols={2}>
  <Card title="CLI quickstart" icon="rocket" href="/cli/quickstart">
    Run the interactive setup and get to a verified first journey.
  </Card>

  <Card title="Create a first journey" icon="route" href="/cli/create-first-journey">
    Choose between website, private brief, and standard input workflows.
  </Card>

  <Card title="Coding agents and MCP" icon="bot" href="/cli/agents-and-mcp">
    Connect Custory to Codex, Claude, or Cursor without giving Custory repository access.
  </Card>

  <Card title="Automation and JSON" icon="braces" href="/cli/automation">
    Use non-interactive commands, JSON output, and predictable exit codes.
  </Card>

  <Card title="Authentication and workspaces" icon="key-round" href="/cli/authentication">
    Sign in, check your active account, list workspaces, and recover sessions.
  </Card>

  <Card title="Tools and agent tasks" icon="wrench" href="/cli/tools-and-agents">
    Discover available Custory tools and call bounded agent tasks directly.
  </Card>

  <Card title="Command reference" icon="list" href="/cli/reference">
    Check exact command syntax, options, conflicts, JSON output, and exit behavior.
  </Card>

  <Card title="CLI security and privacy" icon="shield-check" href="/cli/security">
    Understand scopes, credential storage, private briefs, website limits, and MCP boundaries.
  </Card>

  <Card title="Troubleshooting" icon="circle-help" href="/cli/troubleshooting">
    Fix sign-in, source, workspace, MCP, JSON, and doctor-check failures.
  </Card>
</CardGroup>

## Related resources

* npm package: [`@custory/cli`](https://www.npmjs.com/package/@custory/cli)
* Website overview: [Custory CLI and MCP](https://usecustory.com/cli-and-mcp)
* Existing MCP setup in the dashboard: [MCP](/mcp-server)

## Next step

If this is your first time using the CLI, read [CLI quickstart](/cli/quickstart).