Setup Wizard

​

Command Syntax

hopx init [OPTIONS]

​

Options

• --no-browser - Headless mode: manually paste callback URL (for servers without browsers)
• --skip-test - Skip the sandbox test step

​

Description

1. Authentication - Browser-based OAuth login
2. API Key Creation - Create and store your first API key
3. Configuration - Set default settings
4. Verification - Test your connection (unless --skip-test is used)

​

Examples

# Full interactive setup
hopx init

# Headless mode (for servers without browsers)
hopx init --no-browser

# Skip the sandbox test
hopx init --skip-test

Welcome to HopX CLI Setup
✓ Opening browser for authentication...
✓ Authentication successful
✓ Creating API key...
✓ API key created and stored
✓ Configuration complete
✓ Testing connection...
✓ Setup complete!

​

When to Use

• First-time setup - Run hopx init after installing the CLI
• Reconfiguration - Run hopx init to reconfigure your CLI settings
• New environment - Run hopx init when setting up on a new machine

​

Manual Setup Alternative

# Authenticate
hopx auth login

# Create API key
hopx auth keys create --name "my-key"

# Configure settings
hopx config set default_template python

​

Related

• CLI Installation - Install the CLI
• CLI Quickstart - Get started guide
• Authentication - Authentication commands
• Configuration - Configuration commands

​

Next Steps

• Complete CLI Quickstart to run your first command
• Learn about Authentication for API key management
• Explore Configuration to customize CLI settings