CLI
Install and use the agent CLI to 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, and the CLI authenticates, starts runs, and reads results. Use it to start runs, follow them, and manage configs without writing HTTP calls by hand.
Install
Install with Homebrew:
brew install ellipsis-dev/cli/agentThis installs the agent binary. Check that it is on your path:
agent pingagent ping confirms the CLI can authenticate and reach the /v1 API.
Authenticate
For interactive use on your machine, log in once. agent login runs a device-code flow: it prints a verification URL (and opens it in your browser unless you pass --no-browser), then polls until you approve the request in the dashboard. The issued user token is stored under ~/.config/ellipsis/config.json and attributes runs to you.
agent login # use --no-browser over SSH
agent me # show the current credential's identity
agent logout # remove the stored tokenFor scripts, CI, and other non-interactive environments, set a token in the environment instead of logging in. Create an API key and export it as ELLIPSIS_API_TOKEN:
export ELLIPSIS_API_TOKEN="ellipsis_key_..."Credentials resolve highest-wins: an explicit argument, then ELLIPSIS_API_TOKEN from the environment, then the stored config file. To point the CLI at a non-default API host, set ELLIPSIS_API_BASE_URL (it defaults to https://api.ellipsis.dev).
Start a run
Start a run from a saved agent config, or from an inline config file:
agent run start --config cfg_123
agent run start --config-file my_agent.jsonList, inspect, and follow runs:
agent run list --limit 20 # filter with --source, --days, and more
agent run get run_8f2c # inspect one run
agent run get run_8f2c --watch # follow a run until it finishesManage configs
agent config init agents/my_agent.yaml # scaffold a starter config
agent config list # list saved configs
agent config get cfg_123 # print one config as YAML (-o json for JSON)Budget and usage
agent budget # current budget summary
agent usage # usage dashboard for the periodNotes
- Most commands accept
--jsonto print the raw API response, which is handy for piping intojqin scripts. - Every command maps to the public REST API, so anything the CLI does you can also do over HTTP. For programmatic access from your own services, call the API directly.
- Run
agent --help, oragent <command> --help, for the full list of commands and flags.