Skip to main content

One-click launch of OpenClaw sandbox environment powered by Novita Agent Sandbox

Project description

NovitaClaw

One-click launch of OpenClaw sandbox environments powered by Novita Agent Sandbox.

Installation

pip install NovitaClaw

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
NovitaClaw launch --api-key sk_your_api_key

# Option 2: Set for a single command
NOVITA_API_KEY=sk_your_api_key NovitaClaw 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:

NovitaClaw --json launch                                      # launch sandbox
NovitaClaw --json list                                        # list sandboxes
NovitaClaw --json status <id>                                 # sandbox status & URLs
NovitaClaw --json stop <id>                                   # stop sandbox
NovitaClaw --json pair list <id> --channel telegram           # pending pairing requests
NovitaClaw --json pair approve <id> --channel telegram --code X  # approve pairing
NovitaClaw --json doctor <id>                                 # run diagnostics

Launch a Sandbox

NovitaClaw launch

A random Gateway Token is generated automatically. You can also specify a custom token:

NovitaClaw 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

NovitaClaw list

Check Sandbox Status

NovitaClaw 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

NovitaClaw 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.

Manage Channel Pairing

When a messaging channel (Telegram, Discord, etc.) uses dmPolicy: "pairing" (the default), new users who DM the bot receive a one-time pairing code. Use these commands to list and approve pairing requests:

# List pending pairing requests for a channel
NovitaClaw pair list <sandbox-id> --channel telegram

# Approve a pairing request with the code
NovitaClaw pair approve <sandbox-id> --channel telegram --code <CODE>

Supported channels: telegram, discord, whatsapp, signal, slack, feishu.

Pairing codes expire after 1 hour. To see pending requests, run pair list first.

Run OpenClaw Doctor

NovitaClaw doctor <sandbox-id>

Diagnoses configuration issues, file permissions, gateway health, and plugin status inside the sandbox.

Stop a Sandbox

NovitaClaw 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

novitaclaw-1.0.1.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

novitaclaw-1.0.1-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file novitaclaw-1.0.1.tar.gz.

File metadata

  • Download URL: novitaclaw-1.0.1.tar.gz
  • Upload date:
  • Size: 15.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for novitaclaw-1.0.1.tar.gz
Algorithm Hash digest
SHA256 1d2f272ef6927f8ef65c5948b28c198c9ee095c4630d1ce8833864effa3f0ae5
MD5 88b47d7c41313b4a739ecbbf05f7883b
BLAKE2b-256 0e1c4fe9cb58f3ffba8be93f00ff21bbe3667b1bdb774db667a20ab438ed9d5d

See more details on using hashes here.

File details

Details for the file novitaclaw-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: novitaclaw-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 18.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for novitaclaw-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6108fda136637d9ed14dd28784b9c85fe8c410ca0e448aaa1d848a64eb929c31
MD5 5635f45d4c6bc540844b39edba391909
BLAKE2b-256 81fdf657923d5a2d2a0120a9ab338c94e98c0a396532d56ecbc02b53d65f0e0f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page