CLI
Install and authenticate the agent binary and run agents from your terminal.
The Ellipsis CLI is a single binary named agent that drives the same /v1 REST API from your terminal. It is a thin, open-source client: the agent runs in the Ellipsis cloud; the CLI authenticates, starts runs, and reads results.
Install
brew install ellipsis-dev/cli/agent
agent ping # confirms the CLI can authenticate and reach /v1Authenticate
Interactive use: log in once. agent login runs a device-code flow (prints a verification URL, opens it unless --no-browser, polls until you approve). The user token lands in ~/.config/ellipsis/config.json and attributes runs to you.
agent login # --no-browser over SSH
agent me # identity behind the current credential
agent logout # remove the stored tokenScripts and CI: create an API key and export it as ELLIPSIS_API_TOKEN instead of logging in. Credentials resolve highest-wins: explicit argument, then ELLIPSIS_API_TOKEN, then the stored config file. ELLIPSIS_API_BASE_URL points the CLI at a non-default host (default https://api.ellipsis.dev).
Start a run
From a saved config, an inline config file, or a built-in template:
agent run start --config agent_x9Kd3Fq2
agent run start --config-file my_agent.json
agent run start --template welcome-to-ellipsis --watchList, inspect, and follow runs:
agent run list --limit 20 # filter with --source, --days, and more
agent run get runs_7Hq2mX4p # inspect one run
agent run get runs_7Hq2mX4p --watch # follow until it finishesManage configs
agent config init agents/my_agent.yaml # scaffold a starter config
agent config list # list saved configs
agent config get agent_x9Kd3Fq2 # print one config as YAML (-o json)Budget and usage
agent budget # current spend against every limit
agent usage # usage dashboard for the periodNotes
- Most commands accept
--jsonto print the raw API response for piping intojq. - Every command maps to the public REST API; anything the CLI does you can do over HTTP.
agent --helpandagent <command> --helplist every command and flag.