RobotX Deploy CLI

Use the robotx CLI to deploy, manage versions, and check status for RobotX applications.

RobotX Deployment Skill

Use this skill when an agent needs to deploy or manage project versions on RobotX using the robotx CLI.

Quick start

• Check CLI availability: which robotx || which robotx_cli
• Install (binary-first, no Go required):
  • curl -fsSL https://raw.githubusercontent.com/haibingtown/robotx_cli/main/scripts/install.sh | bash
• Fallback install (if you explicitly want source install):
  • go install github.com/haibingtown/robotx_cli/cmd/robotx@latest
  • Or auto PATH setup: curl -fsSL https://raw.githubusercontent.com/haibingtown/robotx_cli/main/scripts/go-install.sh | bash

Configure

Set credentials by config file (~/.robotx.yaml) or env vars:

• ROBOTX_BASE_URL
• ROBOTX_API_KEY

Auth pre-check and default login

Before running any API command (deploy, projects, versions, status, logs, publish), verify local auth first.

Recommended quick check:

robotx projects --limit 1 --output json

If you see auth-related errors (missing_base_url, missing_api_key, 401, 403), always try robotx login first, then fall back only if login fails:

1. Default (interactive, browser-based): run robotx login and retry the original command.
   • robotx login --base-url https://robotx.xin
   • The CLI prints a verification URL + user code, then auto-opens your browser for authorization.
   • Complete the login in the browser; the CLI polls and saves credentials to ~/.robotx.yaml.
   • Headless/remote mode: add --no-browser and open the printed URL manually.
   • For RobotX hosted login authorization, use robotx.xin (not api.robotx.xin).
2. Fallback (only if login is not possible or fails): manual API key setup via console and configure locally.
   • export ROBOTX_BASE_URL=https://your-robotx-server.com
   • export ROBOTX_API_KEY=your-api-key
   • Or write ~/.robotx.yaml:

base_url: https://your-robotx-server.com
api_key: your-api-key

For CI/non-interactive environments, prefer env vars over robotx login.

Machine-readable output

For agents and workflows, always use structured output:

• robotx deploy . --name my-app --output json
• robotx projects --limit 50 --output json
• robotx versions --project-id proj_123 --output json
• robotx status --project-id proj_123 --output json
• robotx logs --build-id build_456 --output json
• robotx publish --project-id proj_123 --build-id build_456 --output json

JSON is written to stdout. Progress logs are written to stderr.

Common commands

Deploy (create-or-update)

robotx deploy [path] --name "My App" [--publish] [--wait=true]

By default, deploy --name is create-or-update for the same owner.

Versions

robotx versions --project-id proj_123 [--limit 20]

versions alias: robotx builds --project-id proj_123.

Projects

robotx projects [--limit 50]

Status

robotx status --project-id proj_123 [--build-id build_456] [--logs]

status accepts --project-id, --build-id, or both. If --logs is set, --build-id is required.

Logs

robotx logs --build-id build_456 [--project-id proj_123]

Publish

robotx publish --project-id proj_123 --build-id build_456

MCP note

robotx mcp is currently a placeholder and not available for production use. Use shell/CLI mode for agent integration.