Skip to main content
Public Preview The Wherobots CLI works with agentic coding tools like OpenCode, Claude Code, and other AI-powered terminals out of the box. Because these tools execute commands in your terminal, you can manage Wherobots jobs, stream logs, and access the full API using natural language.

​
Before you start

The following requirements must be met to use the Wherobots CLI in an agentic terminal:
  • A Wherobots Account within a Community, Professional, or Enterprise Organization. See Create a Wherobots Account.
    • While all Organization Editions can use the CLI, certain API features and job creation require a Professional or Enterprise Organization. See Organization Editions for details.
  • A Wherobots API key. See API Keys.
  • The Wherobots CLI installed and on your PATH. See Install Wherobots CLI.
  • Your WHEROBOTS_API_KEY environment variable set. See Configure authentication.
  • An agentic terminal such as OpenCode, Claude Code, Cursor, or another AI-powered coding tool with terminal access.
    • Models such as Claude Opus, GPT Codex, or Gemini 3 Pro for the best results when using natural language commands.

​
Add agent skills

Agent skills give your agentic terminal domain-specific knowledge about Wherobots so it produces more accurate commands and better interprets results. Without skills, the agent relies only on CLI help text and its general training data. With skills installed, it has structured context about Wherobots workflows, APIs, and best practices — leading to fewer errors, less back-and-forth, and more reliable multi-step operations.
If you use the Wherobots VS Code Extension, skills are bundled with the extension and available automatically in Copilot Chat and Claude Code — no manual installation needed.
Install all Wherobots skills: 
npx skills add -g wherobots/agent-skills
Or install a specific skill: 
npx skills add wherobots/agent-skills --skill wherobots-usage
For more information on skills and the skills CLI, see the Skills documentation. To see available Wherobots skills, visit the wherobots/agent-skills repository.

​
Benefits

Describe what you want in plain language. The agentic terminal resolves the correct commands, subcommands, and flags for you.
Chain together operations like submitting a job, waiting for completion, and retrieving logs without writing a script.
When a command fails, the agent reads the error, suggests a fix, and can retry automatically.

​
Example tasks

Once the CLI is installed and your API key is set, just ask. Your agentic terminal translates natural language into the right wherobots commands, picks the appropriate flags, and interprets the results.
Wherobots recommends using the latest high-performing AI model available in your agentic terminal for the best results such as Claude Opus, GPT Codex, or Gemini 3 Pro.

​
Explore the API

Terminal PromptWhat you can expect
List available CLI commandsPrints the full command tree so you can see every available endpoint.
Preview a job submission requestPreviews the exact API request without executing it.

​
Submit and monitor jobs

Terminal PromptWhat you can expect
Submit a script as a job and stream the logsUploads the script, creates a run, and tails the output until completion.
Check the status of a recent jobFetches the most recent run and reports its state.
Get resource metrics for a running jobPulls live CPU and memory metrics for the specified run.

​
Debug and triage

Terminal PromptWhat you can expect
List recent failed jobs and summarize errorsFetches recent failures, parses the structured output, and gives you a readable summary.
Retrieve logs from a failed runTails the logs for the most recent failure so you can jump straight to the error.

​
Automate

Terminal PromptWhat you can expect
List running jobs as JSONReturns the running jobs in JSON format.
Cancel all running jobs in a specific regionFilters runs by region and status, then cancels each one.

​
Next steps

Install Wherobots CLI

Install and configure the CLI for terminal-based Wherobots access.

MCP Server

Configure the Wherobots MCP Server for catalog exploration and spatial query generation.