Référence des commandes

Référence complète de toutes les commandes CLI de NovitaClaw.

`launch`

Crée une nouvelle instance de sandbox.

Bash

novitaclaw launch [OPTIONS]

Option	Description
`--api-key`	Clé API Novita
`--gateway-token`	Jeton de passerelle personnalisé (facultatif, généré automatiquement par défaut)
`--timeout`	Délai d’expiration de la création en secondes (par défaut : `60`)
`--type`	Type de sandbox : `persistent` (par défaut) ou `on-demand`
`--idle-timeout`	Délai d’inactivité en secondes pour le mode à la demande (par défaut : `300`, plage : 60–86400)

`list`

Liste les instances de sandbox actives.

Bash

novitaclaw list --api-key YOUR_API_KEY

Option	Description
`--api-key`	Clé API Novita
`--quiet`, `-q`	Afficher uniquement les ID de sandbox, un par ligne (utile pour les scripts)

`status`

Vérifie l’état d’une instance de sandbox. Affiche les URL de webhook pour tous les canaux configurés.

Bash

novitaclaw status <SANDBOX_ID> --api-key YOUR_API_KEY

Option	Description
`--api-key`	Clé API Novita
`--json`	Sortie au format JSON (utile pour extraire les URL de webhook)

`stop`

Termine une instance de sandbox.

Bash

novitaclaw stop <SANDBOX_ID> --api-key YOUR_API_KEY

Option	Description
`--api-key`	Clé API Novita
`--yes`, `-y`	Ignorer l’invite de confirmation

`pause`

Met en pause une instance de sandbox. Aucune facturation pendant la pause.

Bash

novitaclaw pause <SANDBOX_ID> --api-key YOUR_API_KEY

`resume`

Reprend une instance de sandbox en pause (~1 s pour la restauration).

Bash

novitaclaw resume <SANDBOX_ID> --api-key YOUR_API_KEY

`config set`

Met à jour la configuration d’exécution de la sandbox.

Bash

# Update idle timeout (60–86400 seconds)
novitaclaw config set <SANDBOX_ID> idle-timeout 600

# Update sandbox lifetime timeout (300–2592000 seconds)
novitaclaw config set <SANDBOX_ID> timeout 3600

`tui`

Se connecte à une sandbox via l’interface de terminal.

Bash

novitaclaw tui <SANDBOX_ID> --token <GATEWAY_TOKEN>

`doctor`

Exécute des diagnostics et des vérifications de réparation sur une instance de sandbox.

Bash

novitaclaw doctor <SANDBOX_ID> --api-key YOUR_API_KEY

Option	Description
`--api-key`	Clé API Novita
`--deep`	Analyser les services système pour détecter des installations supplémentaires de la passerelle
`--fix`	Appliquer les réparations recommandées (alias de `--repair`)
`--force`	Appliquer des réparations agressives (écrase la configuration de service personnalisée)
`--generate-gateway-token`	Générer et configurer un jeton de passerelle
`--no-workspace-suggestions`	Désactiver les suggestions du système de mémoire de l’espace de travail
`--repair`	Appliquer les réparations recommandées sans demander de confirmation
`--yes`	Accepter les valeurs par défaut sans demander de confirmation

`gateway update`

Met à jour OpenClaw vers la dernière version dans une sandbox.

Bash

novitaclaw gateway update <SANDBOX_ID> --api-key YOUR_API_KEY

Option	Description
`--api-key`	Clé API Novita
`--restart`	Redémarrer la passerelle après la mise à jour

`gateway restart`

Redémarre OpenClaw Gateway dans une sandbox.

Bash

novitaclaw gateway restart <SANDBOX_ID> --api-key YOUR_API_KEY

`services setup`

Installe et démarre Web Terminal et File Manager sur une sandbox existante. Utilisez cette commande pour ajouter des services à d’anciennes sandbox lancées avant l’inclusion de ces services.

Bash

novitaclaw services setup <SANDBOX_ID> --api-key YOUR_API_KEY

`pair list`

Liste les demandes d’appairage en attente pour un canal.

Bash

novitaclaw pair list <SANDBOX_ID> --channel <CHANNEL_NAME> --api-key YOUR_API_KEY

`pair approve`

Approuve une demande d’appairage pour un canal.

Bash

novitaclaw pair approve <SANDBOX_ID> --channel <CHANNEL_NAME> --code <PAIRING_CODE> --api-key YOUR_API_KEY

`pair feishu`

Configure Feishu (Lark) comme canal de messagerie.

Bash

novitaclaw pair feishu <SANDBOX_ID> \
  --app-id cli_xxx \
  --app-secret secret_xxx \
  --mode webhook \
  --verification-token tok_xxx \
  --encrypt-key key_xxx

Option	Description
`--app-id`	ID d’application Feishu
`--app-secret`	Secret d’application Feishu
`--mode`	`event` (par défaut) ou `webhook`
`--verification-token`	Jeton de vérification du webhook (mode webhook uniquement)
`--encrypt-key`	Clé de chiffrement du webhook (mode webhook uniquement)
`--webhook-host`	Adresse de liaison du webhook (par défaut : `0.0.0.0`)
`--webhook-port`	Port d’écoute du webhook (par défaut : `3000`)
`--webhook-path`	Chemin d’URL du webhook (par défaut : `/feishu/events`)

`pair telegram`

Configure Telegram comme canal de messagerie.

Bash

# Polling mode (default)
novitaclaw pair telegram <SANDBOX_ID> \
  --bot-token <BOT_TOKEN>

# Webhook mode
novitaclaw pair telegram <SANDBOX_ID> \
  --bot-token <BOT_TOKEN> \
  --mode webhook \
  --webhook-url https://example.com/webhook/telegram \
  --webhook-secret <SECRET>

Option	Description
`--bot-token`	Jeton de bot Telegram provenant de BotFather
`--mode`	`polling` (par défaut) ou `webhook`
`--webhook-url`	URL publique du webhook (mode webhook uniquement)
`--webhook-secret`	Secret du webhook (mode webhook uniquement)
`--webhook-host`	Adresse de liaison du webhook (par défaut : `0.0.0.0`)
`--webhook-port`	Port d’écoute du webhook (par défaut : `8787`)
`--webhook-path`	Chemin d’URL du webhook (par défaut : `/webhook/telegram`)
`--dm-policy`	Politique de messages privés (par défaut : `pairing`)

`pair slack`

Configure Slack comme canal de messagerie.

Bash

# Socket mode (default)
novitaclaw pair slack <SANDBOX_ID> \
  --bot-token xoxb-... \
  --app-token xapp-...

# HTTP mode
novitaclaw pair slack <SANDBOX_ID> \
  --bot-token xoxb-... \
  --mode http \
  --signing-secret <SECRET>

Option	Description
`--bot-token`	Jeton de bot Slack (`xoxb-...`)
`--app-token`	Jeton d’application Slack (`xapp-...`, mode socket uniquement)
`--mode`	`socket` (par défaut) ou `http`
`--signing-secret`	Secret de signature Slack (mode HTTP uniquement)
`--webhook-host`	Adresse de liaison du webhook (par défaut : `0.0.0.0`)
`--webhook-port`	Port d’écoute du webhook (par défaut : `8788`)
`--webhook-path`	Chemin d’URL du webhook (par défaut : `/webhook/slack`)

`update`

Vérifie les mises à jour de la CLI et effectue la mise à niveau vers la dernière version.

Bash

novitaclaw update

Utilisation programmatique

Utilisez la sortie JSON pour l’automatisation :

Bash

novitaclaw -j launch --api-key YOUR_API_KEY

Exemple de réponse :

{
  "success": true,
  "data": {
    "sandbox_id": "xxx",
    "webui": "https://xxx.sandbox.novita.ai?token=xxx",
    "gateway_ws": "wss://xxx.sandbox.novita.ai",
    "gateway_token": "xxx",
    "terminal_url": "https://7681-xxx.sandbox.novita.ai",
    "filemanager_url": "https://7682-xxx.sandbox.novita.ai",
    "services_username": "admin",
    "services_password": "xxx"
  }
}

Variables d’environnement

Variable	Description
`NOVITA_API_KEY`	Clé API, évite d’avoir à utiliser l’indicateur `--api-key`
`OPENCLAW_GATEWAY_TOKEN`	Jeton de passerelle prédéfini

Dépannage

Commande introuvable

Essayez l’une de ces options :

Bash

# Use full path (Linux)
~/.local/bin/novitaclaw launch

# Typical macOS user path
~/Library/Python/3.x/bin/novitaclaw launch

Délai de connexion dépassé

Augmentez le délai de lancement :

Bash

novitaclaw launch --timeout 180 --api-key YOUR_API_KEY

Foire aux questions

Problème	Pourquoi cela se produit	Que faire
”Command not found” / “Not recognized”	Le PATH Python n’a pas été configuré pendant l’installation	Réinstallez Python et cochez “Add to PATH”, ou ajoutez le répertoire bin manuellement
”Permission Denied”	Autorisations insuffisantes	Windows : exécutez le terminal en tant qu’administrateur. Mac/Linux: préfixez avec `sudo`
”Invalid API Key”	La clé a été copiée incorrectement	Vérifiez qu’il n’y a pas d’espaces supplémentaires autour de la chaîne `sk_`, ou générez une nouvelle clé
La sandbox ne s’arrête pas	Une confirmation est requise pour éviter toute suppression accidentelle	Saisissez `y` lorsque vous y êtes invité, ou utilisez `--yes` pour ignorer la confirmation
Mac : commande `pip` introuvable	macOS utilise `pip3` par défaut	Utilisez `pip3 install novitaclaw` au lieu de `pip`

Get started

Model APIs

Agent Sandbox

GPUs

Observability

Resources

Référence des commandes

`launch`

`list`

`status`

`stop`

`pause`

`resume`

`config set`

`tui`

`doctor`

`gateway update`

`gateway restart`

`services setup`

`pair list`

`pair approve`

`pair feishu`

`pair telegram`

`pair slack`

`update`

Utilisation programmatique

Variables d’environnement

Dépannage

Commande introuvable

Délai de connexion dépassé

Foire aux questions

​launch

​list

​status

​stop

​pause

​resume

​config set

​tui

​doctor

​gateway update

​gateway restart

​services setup

​pair list

​pair approve

​pair feishu

​pair telegram

​pair slack

​update

​Utilisation programmatique

​Variables d’environnement

​Dépannage

​Commande introuvable

​Délai de connexion dépassé

​Foire aux questions

`launch`

`list`

`status`

`stop`

`pause`

`resume`

`config set`

`tui`

`doctor`

`gateway update`

`gateway restart`

`services setup`

`pair list`

`pair approve`

`pair feishu`

`pair telegram`

`pair slack`

`update`

Utilisation programmatique

Variables d’environnement

Dépannage

Commande introuvable

Délai de connexion dépassé

Foire aux questions