Overview

​

What is the HopX CLI?

​

Use Cases

• AI agent code execution - Execute AI-generated code safely in isolated environments
• Running untrusted code - Test code without risking your local machine
• Integration testing - Run tests in clean, reproducible environments
• Data processing pipelines - Process data in isolated sandboxes
• Browser automation - Automate browser interactions with desktop features
• Educational environments - Create learning environments for students

​

When to Use CLI vs SDK vs API

​

Use CLI When:

• You prefer command-line workflows
• You’re writing shell scripts or automation
• You need quick one-off operations
• You’re integrating with CI/CD pipelines
• You want interactive terminal sessions

​

Use SDK When:

• You’re building applications in Python or JavaScript
• You need programmatic control in your code
• You want type safety and IDE support
• You’re building libraries or frameworks

​

Use API When:

• You’re building in languages without SDK support
• You need direct HTTP control
• You’re building custom integrations
• You need fine-grained request/response handling

​

Command Groups

​

Quick Example

# Install CLI
curl -fsSL https://raw.githubusercontent.com/hopx-ai/hopx/main/cli/scripts/install.sh | bash

# Authenticate
hopx auth login

# Create sandbox
hopx sandbox create --template python

# Execute code
hopx run "print('Hello, World!')"

​

Features

​

Authentication

• Browser-based OAuth login (Google, GitHub)
• API key management (create, list, revoke)
• Secure credential storage via system keyring
• Multi-profile support for different environments

​

Output Formats

• Table (default) - Human-readable tables with borders
• JSON - Machine-readable JSON for scripting
• Plain - Minimal text output for piping

​

Configuration

• YAML configuration file (~/.hopx/config.yaml)
• Environment variable support (HOPX_* prefix)
• Multiple profiles for dev/prod environments
• Config precedence: CLI flags > environment > config file > defaults

​

Exit Codes

​

Global Options

--api-key TEXT      API key (overrides HOPX_API_KEY)
--profile TEXT      Configuration profile (default: "default")
--output, -o FORMAT Output format: table, json, plain
-q, --quiet         Suppress non-essential output
-v, --verbose       Increase output verbosity
--no-color          Disable colored output
--version           Show version and exit
--help              Show help message

​

Related

• CLI Installation - Install the CLI
• CLI Quickstart - Get started in 5 minutes
• Python SDK Overview - Python SDK reference
• JavaScript SDK Overview - JavaScript SDK reference
• API Overview - REST API reference

​

Next Steps

• Follow the Installation Guide to install the CLI
• Complete the Quickstart Guide to run your first command
• Explore Command Reference for detailed command documentation