Installation

Agent assisted setup

Copy the instructions below and paste them into your agent (claude, codex, opencode, etc.).

Install Script

Install the latest release:

curl -fsSL https://plot.app/cli/install | bash

Install a specific version:

curl -fsSL https://plot.app/cli/install | bash -s -- --version 0.0.10

You can also pin a version with PLOT_CLI_VERSION, which is useful in scripts and repeatable environments:

PLOT_CLI_VERSION=0.0.10 curl -fsSL https://plot.app/cli/install | bash

By default, the installer places the plot binary in the first suitable location on your PATH, or in ~/.plot/bin if no existing user bin directory is available. To choose a location:

PLOT_INSTALL_DIR=~/.local/bin curl -fsSL https://plot.app/cli/install | bash

If you do not want the installer to edit your shell config, pass --no-modify-path:

curl -fsSL https://plot.app/cli/install | bash -s -- --no-modify-path

Package Managers

Install globally with npm:

npm install -g @plot-app/cli

Or run it without installing:

npx @plot-app/cli --help

Supported Platforms

The install script does not currently install on Windows or musl-based Linux distributions such as Alpine.

Authentication

Browser Login

The easiest way to authenticate is:

plot login

The CLI opens a browser login flow and stores credentials locally after you authorize access.

Personal Access Token

Use a token when a browser login is not available, such as on a server or in an automation environment:

plot login --token "$PLOT_API_TOKEN"

Keep personal access tokens private. Do not paste them into prompts, comments, issues, docs, or logs.

Check Your Login

Verify the active user and workspace:

plot whoami

For credential storage details:

plot auth status

Switch Workspaces

If you have access to more than one workspace, list them:

plot workspace list

Then choose the active workspace:

plot workspace use scalespark-media

Many Plot URLs include the workspace slug:

https://go.plot.app/{workspaceSlug}/{entityType}/{identifier}

If a copied URL points to a different workspace than plot whoami shows, switch workspaces before running the command.

Logout

Remove stored credentials for the active workspace:

plot logout

First Commands

Once authenticated, try:

plot workspace info
plot task me
plot team list
plot search "onboarding"

Use --format markdown when you want terminal-friendly output:

plot task me --format markdown

Output is already clean when another program or AI agent runs the CLI: spinners and progress messages only render in an interactive terminal, so piped output never includes them. You do not need to pass any extra flag:

plot task me --format json

--quiet (or -q) still exists to force-suppress progress chrome when you are in a terminal.