One-click launch of OpenClaw sandbox environment powered by Novita Agent Sandbox
Project description
Novita OpenClaw CLI
One-click launch of OpenClaw sandbox environments powered by Novita Agent Sandbox.
Installation
pip install novita-openclaw-cli
Configuration
1. Get a Novita API Key
Go to Novita API Key Management to obtain your API key. This key is used for:
- Creating and managing Novita sandbox instances
- Serving as the LLM inference API key for OpenClaw
2. Configure the API Key
Use any of the following methods:
# Option 1: Pass directly
novita-openclaw-cli launch --api-key sk_your_api_key
# Option 2: Set for a single command
NOVITA_API_KEY=sk_your_api_key novita-openclaw-cli launch
# Option 3: Export for the current session
export NOVITA_API_KEY=sk_your_api_key
# Option 4: Add to shell profile (persistent)
echo 'export NOVITA_API_KEY=sk_your_api_key' >> ~/.zshrc
Usage
All commands support the --json / -j global flag to output structured JSON (useful for AI agents or scripting). If you are an AI Agent, always use the --json flag to get stable, machine-parseable output:
novita-openclaw-cli --json launch # {"status":"ok","sandbox_id":"...","webui":"...","gateway_ws":"...","gateway_token":"..."}
novita-openclaw-cli --json list # {"status":"ok","sandboxes":[...]}
novita-openclaw-cli --json status <id> # {"status":"ok","sandbox_id":"...","state":"...","webui":"...","gateway_ws":"...","gateway_token":"..."}
novita-openclaw-cli --json stop <id> # {"status":"ok","sandbox_id":"...","message":"..."}
Launch a Sandbox
novita-openclaw-cli launch
A random Gateway Token is generated automatically. You can also specify a custom token:
novita-openclaw-cli launch --gateway-token <your-token>
After launch you will see:
- Sandbox ID — used for subsequent management commands
- Web UI URL — open in browser to use OpenClaw (token is appended to the URL for auto-authentication)
- Gateway WebSocket URL — for TUI or API connections
- Gateway Token — authentication token for connections
Full options:
| Option | Description | Default |
|---|---|---|
--api-key |
Novita API Key | Reads from NOVITA_API_KEY env var |
--gateway-token |
Gateway auth token for access control. Recommend setting a secure custom token | Auto-generated random token |
--timeout |
Sandbox creation timeout (seconds) | 60 |
List Sandboxes
novita-openclaw-cli list
Check Sandbox Status
novita-openclaw-cli status <sandbox-id>
Shows Sandbox ID, status, Web UI URL, Gateway WS URL, and Gateway Token. Also provides a ready-to-use TUI connection command.
Connect via TUI
novita-openclaw-cli tui <sandbox-id> --token <gateway-token>
Requires the OpenClaw CLI to be installed locally: npm install -g openclaw
The first connection triggers device pairing. The sandbox auto-approval daemon will complete pairing within ~3 seconds — please wait briefly.
Stop a Sandbox
novita-openclaw-cli stop <sandbox-id>
Security Notes
The Gateway Token protects your OpenClaw instance from unauthorized access. When a sandbox is exposed on a public address:
- Keep your token safe — the token is shown only once at launch, save it immediately
- Stop unused sandboxes promptly — to avoid unnecessary resource usage and security exposure
Resources
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file novita_openclaw_cli-0.4.3.tar.gz.
File metadata
- Download URL: novita_openclaw_cli-0.4.3.tar.gz
- Upload date:
- Size: 12.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
df1c0800efbfd7f57ae65ac09a45782625c6bf4d842c2ed12d7ff8a6f11ce48b
|
|
| MD5 |
5e78f673dc0549154d6ee8750de6a7e6
|
|
| BLAKE2b-256 |
ddf0ee3488fcf32f567f11fe1f60bc9cead7f3ed2397d27e11c312a111b4e6fe
|
File details
Details for the file novita_openclaw_cli-0.4.3-py3-none-any.whl.
File metadata
- Download URL: novita_openclaw_cli-0.4.3-py3-none-any.whl
- Upload date:
- Size: 15.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9971f803435b2edbe26c1a09c83285b946c505d61150f0b4bcd81138376e3ca0
|
|
| MD5 |
b7f5f3a73631d44467ceefe22a090f31
|
|
| BLAKE2b-256 |
9238022617d2ba12004fd7cbfce74de0ed9373f8f63b1e280e7c7328bb67f856
|