Aller au contenu

CLI

Options et commandes de la CLI OpenSploit.

La CLI OpenSploit démarre par défaut le TUI lorsqu’il est exécuté sans aucun argument.

Fenêtre de terminal
opensploit

Mais elle accepte également les commandes documentées sur cette page. Cela vous permet d’interagir avec OpenSploit par programme.

Fenêtre de terminal
opensploit run "Explain how closures work in JavaScript"

tui

Démarrez l’interface utilisateur du terminal OpenSploit.

Fenêtre de terminal
opensploit [project]

Options

OptionCourtDescription
--continue-cContinuer la dernière session
--session-sID de session pour continuer
--forkForker la session en continuant (à utiliser avec --continue ou --session)
--promptPrompt à utiliser
--model-mModèle à utiliser sous forme de fournisseur/modèle
--agentAgent à utiliser
--portPort d’écoute
--hostnameNom d’hôte d’écoute

Commandes

La CLI OpenSploit dispose également des commandes suivantes.


agent

Gérer les agents pour OpenSploit.

Fenêtre de terminal
opensploit agent [command]

attach

Attachez un terminal à un serveur backend OpenSploit déjà en cours d’exécution démarré via les commandes serve ou web.

Fenêtre de terminal
opensploit attach [url]

Cela permet d’utiliser le TUI avec un backend OpenSploit distant. Par exemple :

Fenêtre de terminal
# Start the backend server for web/mobile access
opensploit web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backend
opensploit attach http://10.20.30.40:4096

Options

OptionCourtDescription
--dirRépertoire de travail dans lequel démarrer TUI
--session-sID de session pour continuer

create

Créez un nouvel agent avec une configuration personnalisée.

Fenêtre de terminal
opensploit agent create

Cette commande vous guidera dans la création d’un nouvel agent avec un prompt système personnalisé et une configuration d’outils.


list

Liste tous les agents disponibles.

Fenêtre de terminal
opensploit agent list

auth

Commande pour gérer les informations d’identification et la connexion des fournisseurs.

Fenêtre de terminal
opensploit auth [command]

login

OpenSploit est alimenté par la liste des fournisseurs sur Models.dev, vous pouvez donc utiliser opensploit auth login pour configurer les clés API pour tout fournisseur que vous souhaitez utiliser. Ceci est stocké dans ~/.local/share/opensploit/auth.json.

Fenêtre de terminal
opensploit auth login

Lorsque OpenSploit démarre, il charge les fournisseurs à partir du fichier d’informations d’identification, ainsi que les clés définies dans vos environnements ou un fichier .env dans votre projet.


list

Liste tous les fournisseurs authentifiés tels qu’ils sont stockés dans le fichier d’informations d’identification.

Fenêtre de terminal
opensploit auth list

Ou la version courte.

Fenêtre de terminal
opensploit auth ls

logout

Vous déconnecte d’un fournisseur en l’effaçant du fichier d’informations d’identification.

Fenêtre de terminal
opensploit auth logout

github

Gérez l’agent GitHub pour l’automatisation du dépôt.

Fenêtre de terminal
opensploit github [command]

install

Installez l’agent GitHub dans votre dépôt.

Fenêtre de terminal
opensploit github install

Cela configure le flux de travail GitHub Actions nécessaire et vous guide tout au long du processus de configuration. En savoir plus.


run

Exécutez l’agent GitHub. Ceci est généralement utilisé dans les GitHub Actions.

Fenêtre de terminal
opensploit github run
Options
OptionDescription
--eventÉvénement simulé GitHub pour lequel exécuter l’agent
--tokenJeton d’accès personnel GitHub

MCP

Gérer les serveurs Model Context Protocol.

Fenêtre de terminal
opensploit mcp [command]

add

Ajoutez un serveur MCP à votre configuration.

Fenêtre de terminal
opensploit mcp add

Cette commande vous guidera dans l’ajout d’un serveur MCP local ou distant.


list

Liste tous les serveurs MCP configurés et leur état de connexion.

Fenêtre de terminal
opensploit mcp list

Ou utilisez la version courte.

Fenêtre de terminal
opensploit mcp ls

auth

Authentifiez-vous auprès d’un serveur MCP compatible OAuth.

Fenêtre de terminal
opensploit mcp auth [name]

Si vous ne fournissez pas de nom de serveur, vous serez invité à sélectionner parmi les serveurs compatibles OAuth disponibles.

Vous pouvez également répertorier les serveurs compatibles OAuth et leur statut d’authentification.

Fenêtre de terminal
opensploit mcp auth list

Ou utilisez la version courte.

Fenêtre de terminal
opensploit mcp auth ls

logout

Supprimez les informations d’identification OAuth pour un serveur MCP.

Fenêtre de terminal
opensploit mcp logout [name]

debug

Déboguer les problèmes de connexion OAuth pour un serveur MCP.

Fenêtre de terminal
opensploit mcp debug <name>

models

Liste tous les modèles disponibles auprès des fournisseurs configurés.

Fenêtre de terminal
opensploit models [provider]

Cette commande affiche tous les modèles disponibles parmi vos fournisseurs configurés au format provider/model.

Ceci est utile pour déterminer le nom exact du modèle à utiliser dans votre config.

Vous pouvez éventuellement transmettre un ID de fournisseur pour filtrer les modèles en fonction de ce fournisseur.

Fenêtre de terminal
opensploit models anthropic

Options

OptionDescription
--refreshActualisez le cache des modèles à partir de models.dev
--verboseUtiliser une sortie de modèle plus détaillée (inclut des métadonnées telles que les coûts)

Utilisez l’option --refresh pour mettre à jour la liste des modèles mis en cache. Ceci est utile lorsque de nouveaux modèles ont été ajoutés à un fournisseur et que vous souhaitez les voir dans OpenSploit.

Fenêtre de terminal
opensploit models --refresh

run

Exécutez opensploit en mode non interactif en transmettant directement un prompt.

Fenêtre de terminal
opensploit run [message..]

Ceci est utile pour les scripts, l’automatisation ou lorsque vous souhaitez une réponse rapide sans lancer le TUI complet. Par exemple :

Fenêtre de terminal
opensploit run Explain the use of context in Go

Vous pouvez également vous connecter à une instance opensploit serve en cours d’exécution pour éviter les temps de démarrage à froid du serveur MCP à chaque exécution :

Fenêtre de terminal
# Start a headless server in one terminal
opensploit serve
# In another terminal, run commands that attach to it
opensploit run --attach http://localhost:4096 "Explain async/await in JavaScript"

Options

OptionCourtDescription
--commandLa commande à exécuter, utilisez le message pour les arguments
--continue-cContinuer la dernière session
--session-sID de session pour continuer
--forkForker la session en continuant (à utiliser avec --continue ou --session)
--sharePartager la session
--model-mModèle à utiliser sous forme de fournisseur/modèle
--agentAgent à utiliser
--file-fFichier(s) à joindre au message
--formatFormat : par défaut (formaté) ou json (événements JSON bruts)
--titleTitre de la session (utilise un prompt tronqué si aucune valeur n’est fournie)
--attachConnectez-vous à un serveur opensploit en cours d’exécution (par exemple, http://localhost:4096)
--portPort du serveur local (port aléatoire par défaut)

serve

Démarrez un serveur OpenSploit sans interface graphique pour un accès API. Consultez le serveur docs pour l’interface complète HTTP.

Fenêtre de terminal
opensploit serve

Cela démarre un serveur HTTP qui fournit un accès API aux fonctionnalités d’OpenSploit sans l’interface TUI. Définissez OPENCODE_SERVER_PASSWORD pour activer l’authentification de base HTTP (le nom d’utilisateur par défaut est opensploit).

Options

OptionDescription
--portPort d’écoute
--hostnameNom d’hôte d’écoute
--mdnsActiver la découverte mDNS
--corsOrigines de navigateur supplémentaires pour autoriser CORS

session

Gérer les sessions OpenSploit.

Fenêtre de terminal
opensploit session [command]

list

Liste toutes les sessions OpenSploit.

Fenêtre de terminal
opensploit session list
Options
OptionCourtDescription
--max-count-nLimiter aux N sessions les plus récentes
--formatFormat de sortie : tableau ou json (tableau)

stats

Affichez les statistiques d’utilisation et de coût des jetons pour vos sessions OpenSploit.

Fenêtre de terminal
opensploit stats

Options

OptionDescription
--daysAfficher les statistiques des N derniers jours (depuis le début)
--toolsNombre d’outils à afficher (tous)
--modelsAfficher la répartition de l’utilisation du modèle (masqué par défaut). Passez un numéro pour afficher les N premiers
--projectFiltrer par projet (tous les projets, chaîne vide : projet actuel)

export

Exportez les données de session au format JSON.

Fenêtre de terminal
opensploit export [sessionID]

Si vous ne fournissez pas d’ID de session, vous serez invité à sélectionner parmi les sessions disponibles.


import

Importez les données de session à partir d’un fichier JSON ou d’une URL de partage OpenSploit.

Fenêtre de terminal
opensploit import <file>

Vous pouvez importer à partir d’un fichier local ou d’une URL de partage OpenSploit.

Fenêtre de terminal
opensploit import session.json
opensploit import https://opncd.ai/s/abc123

web

Démarrez un serveur OpenSploit sans interface graphique avec une interface Web.

Fenêtre de terminal
opensploit web

Cela démarre un serveur HTTP et ouvre un navigateur Web pour accéder à OpenSploit via une interface Web. Définissez OPENCODE_SERVER_PASSWORD pour activer l’authentification de base HTTP (le nom d’utilisateur par défaut est opensploit).

Options

OptionDescription
--portPort d’écoute
--hostnameNom d’hôte d’écoute
--mdnsActiver la découverte mDNS
--corsOrigines de navigateur supplémentaires pour autoriser CORS

acp

Démarrez un serveur ACP (Agent Client Protocol).

Fenêtre de terminal
opensploit acp

Cette commande démarre un serveur ACP qui communique via stdin/stdout en utilisant nd-JSON.

Options

OptionDescription
--cwdRépertoire de travail
--portPort d’écoute
--hostnameNom d’hôte d’écoute

uninstall

Désinstallez OpenSploit et supprimez tous les fichiers associés.

Fenêtre de terminal
opensploit uninstall

Options

OptionCourtDescription
--keep-config-cConserver les fichiers de configuration
--keep-data-dConserver les données de session et les instantanés
--dry-runAfficher ce qui serait supprimé sans supprimer
--force-fIgnorer les invites de confirmation

upgrade

Met à jour opensploit vers la dernière version ou une version spécifique.

Fenêtre de terminal
opensploit upgrade [target]

Pour mettre à niveau vers la dernière version.

Fenêtre de terminal
opensploit upgrade

Pour passer à une version spécifique.

Fenêtre de terminal
opensploit upgrade v0.1.48

Options

OptionCourtDescription
--method-mLa méthode d’installation utilisée ; curl, npm, pnpm, bun, brew

Options globales

La CLI opensploit prend les flags globaux suivants.

OptionCourtDescription
--help-hAfficher l’aide
--version-vAfficher le numéro de version
--print-logsAfficher les logs sur stderr
--log-levelNiveau de log (DEBUG, INFO, WARN, ERROR)

Variables d’environnement

OpenSploit peut être configuré à l’aide de variables d’environnement.

VariablesTypeDescription
OPENCODE_AUTO_SHAREbooléenPartager automatiquement des sessions
OPENCODE_GIT_BASH_PATHchaîneChemin vers l’exécutable Git Bash sur Windows
OPENCODE_CONFIGchaîneChemin d’accès au fichier de configuration
OPENCODE_TUI_CONFIGchaîneChemin d’accès au fichier de configuration TUI
OPENCODE_CONFIG_DIRchaîneChemin d’accès au répertoire de configuration
OPENCODE_CONFIG_CONTENTchaîneContenu de configuration JSON en ligne
OPENCODE_DISABLE_AUTOUPDATEbooléenDésactiver les vérifications automatiques des mises à jour
OPENCODE_DISABLE_PRUNEbooléenDésactiver le nettoyage des anciennes données
OPENCODE_DISABLE_TERMINAL_TITLEbooléenDésactiver les mises à jour automatiques des titres du terminal
OPENCODE_PERMISSIONchaîneConfiguration des autorisations JSON intégrées
OPENCODE_DISABLE_DEFAULT_PLUGINSbooléenDésactiver les plugins par défaut
OPENCODE_DISABLE_LSP_DOWNLOADbooléenDésactiver les téléchargements automatiques du serveur LSP
OPENCODE_ENABLE_EXPERIMENTAL_MODELSbooléenActiver les modèles expérimentaux
OPENCODE_DISABLE_AUTOCOMPACTbooléenDésactiver le compactage automatique du contexte
OPENCODE_DISABLE_CLAUDE_CODEbooléenDésactiver la lecture de .claude (prompt + compétences)
OPENCODE_DISABLE_CLAUDE_CODE_PROMPTbooléenDésactiver la lecture ~/.claude/CLAUDE.md
OPENCODE_DISABLE_CLAUDE_CODE_SKILLSbooléenDésactiver le chargement de .claude/skills
OPENCODE_DISABLE_MODELS_FETCHbooléenDésactiver la récupération de modèles à partir de sources distantes
OPENCODE_FAKE_VCSchaîneFaux fournisseur VCS à des fins de test
OPENCODE_DISABLE_FILETIME_CHECKbooléenDésactiver la vérification de l’heure des fichiers pour l’optimisation
OPENCODE_CLIENTchaîneIdentifiant du client (par défaut cli)
OPENCODE_ENABLE_EXAbooléenActiver les outils de recherche Web Exa
OPENCODE_SERVER_PASSWORDchaîneActiver l’authentification de base pour serve/web
OPENCODE_SERVER_USERNAMEchaîneRemplacer le nom d’utilisateur d’authentification de base (par défaut opensploit)
OPENCODE_MODELS_URLchaîneURL personnalisé pour récupérer la configuration des modèles

Expérimental

Ces variables d’environnement activent des fonctionnalités expérimentales qui peuvent être modifiées ou supprimées.

VariablesTypeDescription
OPENCODE_EXPERIMENTALbooléenActiver toutes les fonctionnalités expérimentales
OPENCODE_EXPERIMENTAL_ICON_DISCOVERYbooléenActiver la découverte d’icônes
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooléenDésactiver la copie lors de la sélection dans TUI
OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnuméroDélai d’expiration par défaut pour les commandes bash en ms
OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAXnuméroNombre maximum de jetons de sortie pour les réponses LLM
OPENCODE_EXPERIMENTAL_FILEWATCHERbooléenActiver l’observateur de fichiers pour l’ensemble du répertoire
OPENCODE_EXPERIMENTAL_OXFMTbooléenActiver le formateur oxfmt
OPENCODE_EXPERIMENTAL_LSP_TOOLbooléenActiver l’outil expérimental LSP
OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHERbooléenDésactiver l’observateur de fichiers
OPENCODE_EXPERIMENTAL_EXAbooléenActiver les fonctionnalités Exa expérimentales
OPENCODE_EXPERIMENTAL_LSP_TYbooléenActiver la vérification expérimentale de type LSP
OPENCODE_EXPERIMENTAL_MARKDOWNbooléenActiver les fonctionnalités Markdown expérimentales
OPENCODE_EXPERIMENTAL_PLAN_MODEbooléenActiver le mode plan