CLI
Run every Estii API operation from your terminal with the estii CLI.
The estii CLI is built on the same API, so anything you can script
you can also do by hand.
Install
Run it without installing anything (needs Node):
npx @estii.com/cli commandsor with bun
bunx @estii.com/cli commandsOr install it so estii is on your PATH:
npm i -g @estii.com/cli
# or
bun add -g @estii.com/cliOn macOS and Linux you can also use the install script:
curl -fsSL https://dl.estii.com/install.sh | shConfirm it with estii version. The examples below assume estii is installed; if
you are running through npx, prefix each command with npx @estii.com/cli.
Sign in
Sign in once and the CLI keeps your session:
estii auth loginThis opens your browser to confirm the sign-in, then stores the session locally.
Check it any time with estii auth status, and sign out with estii auth logout.
Use a token instead
If you would rather use a token, set ESTII_TOKEN to a personal access token and
the CLI uses it without signing in:
export ESTII_TOKEN=estp_your_tokenSee API keys to create one.
Read and update your data
Either way, you can then read and update your data:
estii space list
estii deal list --space your-space
estii deal show <deal-id>Add --json to any command for machine-readable output.
See all commands
estii --help lists every command. Add a command name for its options and
subcommands:
estii --help
estii deal --helpFor the full catalogue as JSON, handy for scripting or feeding to an agent:
estii commands
# GENERAL
# version local Print version number
# doctor local Print CLI environment status
# commands local List every command (JSON when piped or with -o json)
# init local Install the estii agent skill into your AI harness
# self update local Update the estii CLI to the latest release
# self uninstall local Uninstall the estii CLI from this machine
# mcp serve local Serve estii's commands to MCP clients over stdio
#
# AUTH
# auth status read Print current auth status
# auth login write Authorize this machine via a browser login
# auth logout write Remove the locally stored token
#
# SPACE
# space list read List spaces you can access
# space current read Show the current space selection (local state, no network)
# space use write Select the current space by id or name
# space show read Show a single space by id or the active space
#
# DEAL
# deal list read List deals in the active space
# deal show read Show a single deal in the active space
# deal export read Export a deal
# deal set write Assign deal fields (key=value)
# deal request-approval event Submit a draft deal for approval
# deal approve event Approve a draft deal
# deal progress event Mark an approved deal as progressed
# deal close event Close a deal as won, lost, or abandoned
# deal redraft event Return a deal to draft
# deal archive event Archive a draft or closed deal
# deal unarchive event Restore an archived deal
#
# ROLE
# role list read List roles in the active space
# role estimate read Estimate the price of a role from an expression
# role export read Export all roles with per-card pricing
#
# PRODUCT
# product list read List products in the active space
# product estimate read Estimate the price of a product from an expression
# product export read Export all products in the active space
#
# STREAM
# stream list read List streams in the active space
# stream estimate read Estimate the price of a stream from an expression
# stream export read Export all streams from the active space
#
# ...
Use it with an AI agent
The CLI doubles as an MCP server, so an AI agent can drive Estii for you. See MCP Server to wire it into Claude Code, Codex, or another client.