Documentation
CLI

CLI — Ghosty from your terminal

Install the official Ghosty Studio CLI, sign in with your account, and configure, test and chat with your agents from the terminal.

Updated 2026-09-28

Open in Claude ↗Open in ChatGPT ↗?
Ask your coding agent

Install the Ghosty CLI (npx -y @ghostystudio/cli login) and list my agents per https://www.ghosty.studio/en/docs/cli.md; when it gives you the login link, pass it to me.

Paste it in Claude Code, Cursor or Codex with the ghosty-agent skill installed.

ghosty is the official Ghosty Studio CLI. It does what the dashboard does (configure, test and chat with your agents) from the terminal, and it is built so your coding agent (Claude Code, Codex, Cursor) can use it too.

Install

bash
npx -y @ghostystudio/cli --help

Requires Node 22 or newer.

Sign in

bash
ghosty login

Your browser opens, you sign in with your Ghosty account (Google, Apple or email) and the terminal is signed in. If you already have a session on ghosty.studio, opening the link is all it takes.

  • If the browser doesn't open, the terminal prints the link so you can copy it.
  • The session renews itself; it lasts 90 days without use before asking you to sign in again.
  • Run any command without a session and the login starts on its own.
  • Over SSH or on another machine? ghosty login --device gives you a link and a code to authorize from your phone (over SSH it does this by itself).
  • ghosty whoami shows which account you are using; ghosty logout signs out and revokes the session.
  • ghosty usage shows your plan and how much you've used this week and month.

Let your coding agent do it

Ask Claude Code to "sign in to Ghosty with the CLI". It runs ghosty login, hands you the link in the chat, you open it, and it carries on. Details in .

First steps

bash
ghosty agents ls                        # your agentsghosty try <agent-id> "hi, who are you?"  # one test turnghosty chat <agent-id>                  # live conversation

Every command, with examples, in the . If your product wants to give an agent to each of its customers, see .

Where the session lives

In ~/.config/ghosty/config.json, readable only by your user (or under $XDG_CONFIG_HOME/ghosty/ if you set that variable). To point at another server, set GHOSTY_URL.

Two accounts on the same machine, yours and a customer's? Use profiles: each one keeps its session apart, in config.<name>.json.

bash
ghosty --profile customer loginghosty --profile customer agents lsexport GHOSTY_PROFILE=customer            # or for the whole terminal

With NO_COLOR set, the CLI uses no colors and shows no banner.

← Previous
Documentation MCP
Next →
Command reference