Skip to main content
Choose your language and install the Hopx SDK using your preferred package manager.

​
Prerequisites

Before installing, ensure you have:
  • Python SDK: Python 3.8 or higher and pip
  • JavaScript SDK: Node.js 16 or higher and npm/yarn
  • API Key: Get your API key from the console

​
Installation Methods

​
Package Managers

  • Python
  • JavaScript/TypeScript
pip install hopx-ai

​
Poetry

[tool.poetry.dependencies]
python = "^3.8"
hopx-ai = "^0.1"

poetry add hopx-ai

​
uv

uv pip install hopx-ai

​
Install from Source

  • Python
  • JavaScript/TypeScript
git clone https://github.com/hopx-ai/hopx.git
cd hopx/python
pip install -e .

​
Verify Installation

Test your installation to ensure everything is set up correctly:
  • Python
  • JavaScript/TypeScript
from hopx_ai import Sandbox, __version__

print(f"Hopx SDK version: {__version__}")

# Test connection (API key automatically read from HOPX_API_KEY env var)
sandbox = Sandbox.create(template="code-interpreter")
print(f"✅ Successfully created sandbox: {sandbox.sandbox_id}")
sandbox.kill()
Installation complete! You’re ready to create your first sandbox. Continue to the Quickstart guide or set up Authentication.

​
Updating

Keep your SDK up to date with the latest features and fixes:
  • Python
  • JavaScript/TypeScript
pip install --upgrade hopx-ai

​
Advanced Topics

Pin specific SDK versions for production deployments:
  • Python
  • JavaScript/TypeScript
# requirements.txt
hopx-ai==0.1.19  # Exact version
hopx-ai>=0.1.19,<0.2.0  # Compatible versions
Common installation issues and solutions:

​
Python: ImportError

# Ensure pip is up to date
pip install --upgrade pip

# Reinstall
pip uninstall hopx-ai
pip install hopx-ai

# Check installation
pip show hopx-ai

​
JavaScript: Module not found

# Clear cache
npm cache clean --force

# Reinstall
rm -rf node_modules package-lock.json
npm install

# Check installation
npm list @hopx-ai/sdk

​
SSL Certificate Errors

  • Python
  • JavaScript/TypeScript
# Install certificates
pip install --upgrade certifi
Disabling SSL verification is not recommended for production. Only use for development environments.

​
Network Issues

If behind a corporate proxy:
  • Python
  • JavaScript/TypeScript
pip install hopx-ai --proxy http://proxy.company.com:8080
Install the SDK on machines without internet access:
  • Python
  • JavaScript/TypeScript
# On connected machine
pip download hopx-ai -d ./packages

# Transfer ./packages to offline machine
pip install --no-index --find-links ./packages hopx-ai

​
Next Steps

Quickstart

Create your first sandbox in 2 minutes

Authentication

Set up API keys and authentication

Development Tools

Use with Docker and CI/CD

Core Concepts

Learn about sandboxes and templates

SDK Reference

Complete SDK documentation
Having issues? Check our troubleshooting guide or join Discord.