Référence CLI Cortex Code

Référence de ligne de commande pour le CLI Cortex Code.

Démarrage de Cortex Code

Commande

Description

cortex

Commencer dans le répertoire actuel

cortex -c production

Commencer par une connexion spécifique

cortex -w /path/to/project

Commencer dans un répertoire spécifique

cortex -w /new/project -c myconn

Combiner workdir et la connexion

cortex --continue

Continuer la dernière session

cortex --resume <id_session>

Reprendre une session spécifique

Options CLI

Option

Description

-c, --connection <nom>

Utiliser une connexion Snowflake spécifique

-w, --workdir <chemin>

Définir le répertoire de travail des opérations sur les fichiers

-m, --model <model_name>

Spécifier le modèle d’AI à utiliser

--plan

Mode plan : nécessite une approbation avant toute action

--bypass

Approuver automatiquement toutes les actions planifiées

--dangerously-allow-all-tool-calls

Désactiver les invites d’autorisation d’appel d’outils (avertissement)

--continue

Reprendre la conversation la plus récente

-r, --resume <id_session>

Reprendre une session spécifique par ID, ou last pour la dernière session

-p, --print  "<prompt>"

Transmettre l’invite spécifiée, imprimer la réponse et quitter

-f, --file <file>

Lire l’invite du fichier, exécuter et quitter

--output-format stream-json

Sortie JSON (pour les scripts)

-V, --version

Afficher la version installée

--help

Afficher l’aide CLI

Les connexions doivent être définies dans ~/.snowflake/connections.toml. Voir CLI de Cortex Code pour la configuration de la connexion. Les IDs de session sont affichés au démarrage, à la sortie et stockés dans ~/.snowflake/cortex/conversations/.

Exemples

Commencer par un répertoire de travail :

cortex -w /path/to/project
Copy

Reprendre la dernière session avec une connexion spécifique :

cortex --continue -c production
Copy

Invite unique (sortie JSON) :

cortex -p "List all Python files" --output-format stream-json
Copy

Commandes

update

Commande

Description

cortex update

Mettre à jour avec la dernière version

cortex --version

Vérifier après la mise à jour

mcp

Commande

Description

cortex mcp list

Liste des serveurs configurés

cortex mcp add

Ajouter un nouveau serveur (interactif)

cortex mcp remove <server_name>

Supprimer le serveur

Voir Protocole de contexte de modèle (MCP) pour plus de détails.

Mode interactif

Raccourcis clavier

Raccourci

Action

Ctrl+C

Annuler l’opération en cours

Ctrl+C Ctrl+C

Quitter le CLI Cortex Code

Ctrl+L

Effacer l’écran du terminal (maintient la conversation)

Up/Down arrows

Naviguer dans l’historique des commandes

Tab

Exécution de la commande

Commandes avec barre oblique

Gestion des sessions

Commande

Description

/help

Afficher l’aide interactive

/plan

Activer le mode planification

/plan_off

Désactiver le mode planification

/clear, /cls

Effacer l’écran

/new

Démarrer une nouvelle session

/rename <title>

Renommer la session actuelle

/exit, /quit

Quitter le CLI Cortex Code

/resume, /r, /sessions

Lister et reprendre les sessions

/rewind

Revenir n étapes en arrière dans la conversation ou sélectionner de manière interactive

/skill list

Afficher les capacités disponibles

/mcp-status

Afficher le statut du serveur MCP

/fork

Créer une nouvelle session à partir de la session actuelle

Modèle et mode

Commande

Description

/model

Afficher/sélectionner le modèle d’AI

/plan

Activer le mode plan

/plan-off

Désactiver le mode plan

/bypass

Activer le mode contournement (approuver automatiquement tout, y compris les appels d’outils)

/bypass-off

Désactiver le mode de contournement

/status

Afficher la configuration actuelle

Snowflake et données

Commande

Description

/sql <requête>

Exécuter la requête SQL

/sql <requête> --limit <n>

Limiter les lignes affichées

/table [<file>], /csv

Ouvrir la visionneuse de table

/connections, /conn

Gérer les connexions Snowflake

Outils de développement

Commande

Description

/sh, ! <command>

Exécuter la commande shell

/diff, /changes, /review

Examiner les modifications Git

/worktree

Gérer les arborescences de calcul Git

/dbt

Opérations dbt

/lineage

Visualisation de la lignée dbt

Configuration

Commande

Description

/settings

Afficher/modifier les paramètres

/theme

Sélectionner un thème de couleur

/sandbox

Gérer les paramètres sandbox

/add-dir <chemin>

Ajouter un répertoire de travail

Extensibilité

Commande

Description

/skill, /skills

Gérer les capacités

/mcp

Statut du serveur MCP

/hooks

Voir la configuration des hooks

/commands, /cmds

Gérer les commandes personnalisées

/agents

Voir les sous-agents

Utilitaires

Commande

Description

/tasks

Afficher la liste des tâches

/feedback

Fournir des commentaires sur la session (enregistrés localement sous forme de fichier .tgz)

/update

Mettre à jour Cortex Code

Stockage des sessions

Commande

Description

~/.snowflake/cortex/conversations/

Fichiers de session

~/.snowflake/cortex/settings.json

Paramètres généraux

~/.snowflake/cortex/permissions.json

Préférences d’autorisation

Voir Paramètres CLI de Cortex Code pour des détails sur la configuration.

Détails de commande

/sql : Exécutez des exemples SQL

Requête de base :

/sql SELECT * FROM users
Copy

Avec limite de lignes :

/sql SELECT * FROM large_table --limit 1000
Copy

Multiligne (utilisez Ctrl+J pour les nouvelles lignes) ;

/sql SELECT
  customer_id,
  SUM(amount) as total
FROM orders
GROUP BY customer_id
Copy

Les résultats s’ouvrent automatiquement dans la visionneuse de table (Ctrl+T).

/worktree : Arborescences de calcul Git

Commande

Description

/worktree create feature-branch

Créer une nouvelle arborescence de calcul

/worktree list

Lister toutes les arborescences de calcul

/worktree switch feature-branch

Basculer vers l’arborescence de calcul

/worktree delete feature-branch

Supprimer l’arborescence de calcul

/sandbox : Contrôle de la sandbox

Commande

Description

/sandbox

Sélecteur interactif

/sandbox on

Activer la sandbox de conteneur

/sandbox off

Désactiver la sandbox de conteneur

/sandbox status

Afficher le statut de la sandbox

/sandbox runtime on

Activer la sandbox de l’OS

/sandbox runtime off

Désactiver la sandbox de l’OS

/sandbox mode auto

Autorisation automatique des commandes sandbox

/sandbox mode regular

Invite pour toutes les commandes

/mcp : serveurs MCP

Commande

Description

/mcp

Afficher la visionneuse de statut

/mcp list

Lister tous les serveurs

/mcp start <server>

Démarrer le serveur

/mcp get <server>

Obtenir les détails du serveur

/mcp remove <server>

Supprimer le serveur

Mode par lot

Commande

Description

cortex -p "<prompt>"

Exécuter une invite unique et quitter

cortex -f request.txt

Lire l’invite du fichier

cortex --output-format stream-json -p "<prompt>"

Sortie JSON

cortex -c prod --workdir /app -p "..."

Contexte de contrôle

Codes de sortie

Code

Description

0

Succès

1

Erreur générale

2

Erreur de configuration

3

Erreur de connexion

4

Autorisation refusée

130

Interrompu par l’utilisateur (Ctrl+C)

Configuration et définition

Mise à jour du CLI Cortex Code

Le CLI Cortex Code se met à jour lorsqu’une nouvelle version est disponible. Vous pouvez également le mettre à jour manuellement vers la dernière version en exécutant la commande cortex update. Exécutez cortex update <version> pour installer la version spécifiée.

Pour désactiver les mises à jour automatiques, modifiez ~/.snowflake/cortex/settings.json et ajoutez "autoUpdate": false.

Ajout manuel d’une connexion

Pour créer ou modifier manuellement le fichier ~/.snowflake/connections.toml pour définir votre connexion, suivez les étapes ci-dessous :

  1. Créez le fichier ~/.snowflake/connections.toml s’il n’existe pas déjà.

    mkdir -p ~/.snowflake
    touch ~/.snowflake/connections.toml
    
    Copy
  2. Utilisez la commande chmod pour définir ses autorisations afin que vous seul soyez doté des autorisations de lecture et d’écriture.

    chmod 600 ~/.snowflake/connections.toml
    
    Copy
  3. Ouvrez le fichier dans un éditeur de texte (ici, nano).

    nano ~/.snowflake/connections.toml
    
    Copy
  4. Ajoutez des lignes comme les suivantes pour définir une connexion. Saisissez le nom de la connexion à la place de myaccount et remplacez les valeurs par défaut par les détails de votre compte Snowflake. Utilisez une SSO basée sur un navigateur (authentification externe du navigateur) ou un PAT (jeton d’accès programmatique). Vous pouvez obtenir un PAT depuis l’Snowsight (voir Utilisation de jetons d’accès programmatique pour l’authentification). Incluez uniquement la valeur authenticator ou password, en fonction de la méthode d’authentification que vous choisissez.

    [myaccount]
    account       = "<ACCOUNT>"
    user          = "<USERNAME>"
    authenticator = "externalbrowser" # For browser-based SSO; omit for PAT
    password      = "<PAT>"           # For PAT authentication; omit for SSO
    warehouse     = "<WAREHOUSE>"
    role          = "<ROLE>"
    database      = "<DATABASE>"
    schema        = "<SCHEMA>"
    
    Copy
  5. Enregistrez le fichier et fermez-le.

Configuration des complétions du shell

Pour donner à votre shell la possibilité de compléter automatiquement les commandes et options du CLI Cortex Code, procédez comme suit.

Astuce

Si vous n’êtes pas certain du shell que vous utilisez, exécutez echo $(basename $SHELL) dans votre terminal. Le nom affiché est le shell par défaut de votre compte et peut ne pas être précis si vous avez démarré manuellement un autre shell.

Shell

Commande

bash

complétion cortex bash > ~/.bash_completion.d/cortex

zsh

complétion cortex zsh > ~/.zsh/completions/_cortex

fish

complétion cortex fish > ~/.config/fish/completions/cortex.fish

Après avoir exécuté la commande appropriée ci-dessus pour votre shell, redémarrez-le avec exec $SHELL.

Structure des répertoires

Installer CLI Cortex Code crée la structure de répertoire suivante dans votre répertoire personnel :

~/.snowflake/cortex/
   ├── settings.json          # Main configuration
   ├── mcp.json               # MCP server configs
   ├── conversations/         # Session history
   ├── skills/                # Global skills
   ├── commands/              # Custom commands
   ├── hooks/                 # Hook scripts
   ├── profiles/              # Team profiles
   └── cache/                 # Temporary cache
Copy

Résolution des problèmes

Les messages d’erreur suivants sont les messages d’erreur courants que vous pouvez rencontrer lors de l’installation et de la configuration.

Commande introuvable

Assurez-vous que le répertoire d’installation ~/.local/bin est inclus dans votre variable d’environnement PATH. Par exemple, si vous utilisez bash, exécutez les commandes suivantes :

export PATH="~/.local/bin:$PATH"
echo 'export PATH="~/.local/bin:$PATH"' >> ~/.bashrc
Copy

Autorisation refusée

Assurez-vous que l’exécutable cortex dispose des autorisations d’exécution. Exécutez la commande suivante :

chmod +x ~/.local/bin/cortex
Copy

Erreurs de connexion

Assurez-vous que le fichier de connexion ~/.snowflake/connections.toml existe et contient des informations de connexion valides.

cat ~/.snowflake/connections.toml
Copy

Essayez d’invoquer la commande cortex avec une connexion explicitement spécifiée à l’aide de l’option -c. Par exemple :

cortex -c myaccount
Copy

Voir aussi :

CLI de Cortex Code

Installation, configuration et premières invites

Paramètres CLI de Cortex Code

Référence du fichier de configuration

Exemples de workflow de la CLI Cortex Code

Capacités et exemples de flux de travail