Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.useagentos.com/llms.txt

Use this file to discover all available pages before exploring further.

The AgentOS CLI lets you manage workspaces, talk to the Operator, and run macros from your terminal. Output is JSON by default, which makes it easy for scripts and AI agents to work with.

​
Install

One command: 
curl -fsSL https://useagentos.com/install.sh | bash
This downloads the right binary for your system and puts it in ~/.local/bin. Works on macOS, Linux, and WSL. Check that it worked: 
agentos health
You should see: 
{ "ok": true, "backendUrl": "https://api.useagentos.com" }

​
Download manually

If you’d rather grab the binary yourself, check the GitHub releases. Pick the one for your system:
FileSystem
agentos-darwin-arm64Mac with Apple Silicon
agentos-darwin-x64Mac with Intel
agentos-linux-arm64Linux ARM
agentos-linux-x64Linux x64
Then make it executable and move it somewhere in your PATH: 
chmod +x agentos-darwin-arm64
mv agentos-darwin-arm64 ~/.local/bin/agentos

​
Log in

You need an AgentOS account to use the CLI. If you don’t have one, sign up at useagentos.com first. 
agentos auth login
This opens your browser. Sign in, approve the request, and you’re done. The CLI stores your credentials locally.

​
Try it out

List your workspaces: 
agentos workspaces list
Talk to the Operator: 
agentos operator chat ws_abc123 --message "What's the status of my project?"
Check available macros: 
agentos macros list

​
Output format

Everything returns JSON. If you want it formatted for humans: 
agentos workspaces list --output pretty

​
Next steps

Authentication

Token storage, environment variables, and session management

Commands

Full reference for all commands