Skip to main content
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:

​
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:

​
Platform support

The supported install path is npm:
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

CLI quickstart

Run the interactive setup and get to a verified first journey.

Create a first journey

Choose between website, private brief, and standard input workflows.

Coding agents and MCP

Connect Custory to Codex, Claude, or Cursor without giving Custory repository access.

Automation and JSON

Use non-interactive commands, JSON output, and predictable exit codes.

Authentication and workspaces

Sign in, check your active account, list workspaces, and recover sessions.

Tools and agent tasks

Discover available Custory tools and call bounded agent tasks directly.

Command reference

Check exact command syntax, options, conflicts, JSON output, and exit behavior.

CLI security and privacy

Understand scopes, credential storage, private briefs, website limits, and MCP boundaries.

Troubleshooting

Fix sign-in, source, workspace, MCP, JSON, and doctor-check failures.

​
Next step

If this is your first time using the CLI, read CLI quickstart.