CLI: Functions

Below is a summary of commands available in the agents-cli tool. Run agents-cli --help for more details.

Guides you through storing a secure auth token and configuring API settings in ~/.agents-api/config.ini.

Copy
agents-cli setup

Shows or updates your CLI configuration (e.g., current API base URL, clearing your auth token, HTML documentation settings).

Copy
agents-cli config

Displays your current account information: credits, usage summary, plus a quick reference of commands. Can also generate HTML documentation.

Copy
agents-cli info

Lists all your agents, including name, ID, status, associated API key, and credits. Displays complete IDs and keys without truncation.

Copy
agents-cli agents

Lists all your existing API keys, name, creation date, and last-used timestamp. Shows full key values without truncation.

Copy
agents-cli api-keys

Shows overall usage stats (total cost, average cost per hour/day/week) and a breakdown by agent.

Copy
agents-cli usage

Displays detailed information for a specific agent. Includes container status, available credits, and more.

Copy
agents-cli agent-info 123-xyz

Creates a new API key (permanently stored in your account). Provide an optional --name for clarity. Offers to save the key to a file.

Copy
agents-cli create-key --name "My Key"

Gets a direct link (URL) to a relevant resource, e.g. billing, docs, dashboard, etc. Options to open your browser or copy to clipboard.

Copy
agents-cli link docs --open --copy

Available resources include: dashboard, billing, docs, settings, agents, support.

Connect to an agent's WebSocket stream to receive real-time updates. Use this to monitor agent activity without sending commands.

Copy
agents-cli stream YOUR_AGENT_ID

Options include using persistent WebSocket connection and plain text output.

send – Send an operation (like 'message') to an agent.

This command requires --api-key and --agent-id if your CLI isn't configured with a default token. Supports multiple input formats including JSON from file, stdin, or interactive input.

BASH
Copy
agents-cli send message '{"text":"Hello"}' --api-key YOUR_API_KEY --agent-id YOUR_AGENT_ID

Or using direct JSON:

BASH
Copy
agents-cli send --json '{"operation":"message","api_key":"KEY","agent_id":"ID","params":{"message":"Hello"}}'

Several commands support generating HTML documentation and reports when the feature is enabled in configuration:

• info - Can generate a complete CLI reference guide
• agents - Can generate an HTML report of all your agents
• api-keys - Can generate an HTML report of all your API keys

HTML files are saved to ~/.agents-api/html_docs/ with timestamps.