Referenz für die Cortex Code-CLI

Befehlszeilenreferenz für die Cortex Code-CLI.

Starten von Cortex Code

Befehl

Beschreibung

cortex

Starten im aktuellen Verzeichnis

cortex -c production

Starten mit spezifischer Verbindung

cortex -w /path/to/project

Starten in einem bestimmten Verzeichnis

cortex -w /new/project -c myconn

Kombinieren von Arbeitsverzeichnis und Verbindung

cortex --continue

Fortsetzen der letzten Sitzung

cortex --resume <Sitzungs-ID>

Fortsetzen einer bestimmten Sitzung

CLI-Optionen

Option

Beschreibung

-c, --connection <Name>

Verwenden einer bestimmten Snowflake-Verbindung

-w, --workdir <Pfad>

Festlegen eines Arbeitsverzeichnisses für Dateioperationen

-m, --model <model_name>

Angeben des zu verwendenden AI-Modells

--plan

Planmodus: Genehmigung vor allen Aktionen erforderlich

--bypass

Automatisches Genehmigen aller geplanten Aktionen

--dangerously-allow-all-tool-calls

Deaktivieren von Aufforderungen zur Bestätigung von Tool-Aufrufen (mit Vorsicht verwenden)

--continue

Fortsetzen der letzten Konversation

-r, --resume <Sitzungs-ID>

Fortsetzen einer bestimmten Sitzung anhand der ID oder von last für die letzte Sitzung

-p, --print  "<Aufforderung>"

Übergeben einer angegebene Eingabeaufforderung, Drucken der Antwort und Beenden

-f, --file <Datei>

Lesen der Eingabeaufforderung aus der Datei, Ausführen und Beenden

--output-format stream-json

JSON-Ausgabe (für Scripting)

-V, --version

Anzeigen der installierten Version

--help

Anzeigen der CLI-Hilfe

Verbindungen müssen in ~/.snowflake/connections.toml definiert sein. Siehe Cortex Code-CLI für das Einrichten der Verbindung. Sitzungs-IDs werden beim Start und beim Beenden angezeigt und in ~/.snowflake/cortex/conversations/ gespeichert.

Beispiele

Starten mit dem Arbeitsverzeichnis:

cortex -w /path/to/project
Copy

Fortsetzen der letzten Sitzung mit bestimmter Verbindung:

cortex --continue -c production
Copy

Eindeutige Eingabeaufforderung (JSON-Ausgabe):

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

Befehle

update

Befehl

Beschreibung

cortex update

Aktualisieren auf die neueste Version

cortex --version

Überprüfen nach dem Update

mcp

Befehl

Beschreibung

cortex mcp list

Auflisten der konfigurierten Server

cortex mcp add

Hinzufügen eines neuen Servers (interaktiv)

cortex mcp remove <server_name>

Entfernen des Servers

Weitere Informationen dazu finden Sie unter Model Context Protocol (MCP).

Interaktiver Modus

Tastaturkürzel

Shortcut

Aktion

Ctrl+C

Aktuelle Operation abbrechen

Ctrl+C Ctrl+C

Cortex Code-CLI beenden

Ctrl+L

Terminalbildschirm löschen (speichert die Konversation)

Up/Down arrows

Im Befehlsverlauf navigieren

Tab

Befehlsvervollständigung

Befehle mit vorangestelltem Schrägstrich

Sitzungsmanagement

Befehl

Beschreibung

/help

Interaktive Hilfe anzeigen

/plan

Planungsmodus aktivieren

/plan_off

Planungsmodus deaktivieren

/clear, /cls

Bildschirm löschen

/new

Neue Sitzung starten

/rename <Titel>

Aktuelle Sitzung umbenennen

/exit, /quit

Cortex Code-CLI beenden

/resume, /r, /sessions

Sitzungen auflisten und fortsetzen

/rewind

n Schritte in der Konversation zurückgehen oder interaktiv auswählen

/skill list

Verfügbare Fähigkeiten auflisten

/mcp-status

MCP-Serverstatus anzeigen

/fork

Aktuelle Sitzung in eine neue Sitzung verzweigen

Modell und Modus

Befehl

Beschreibung

/model

AI-Modell anzeigen/auswählen

/plan

Planmodus aktivieren

/plan-off

Planmodus deaktivieren

/bypass

Umgehungsmodus aktivieren (alle automatisch genehmigen, einschließlich Tool-Aufrufe)

/bypass-off

Umgehungsmodus deaktivieren

/status

Aktuelle Konfiguration anzeigen

Snowflake und Daten

Befehl

Beschreibung

/sql <Abfrage>

SQL-Abfrage ausführen

/sql <Abfrage> --limit <n>

Angezeigten Zeilen begrenzen

/table [<Datei>], /csv

Tabellen-Viewer öffnen

/connections, /conn

Snowflake-Verbindungen verwalten

Entwicklungs-Tools

Befehl

Beschreibung

/sh, ! <Befehl>

Shell-Befehl ausführen

/diff, /changes, /review

Git-Änderungen überprüfen

/worktree

Git-Arbeitsstrukturbäumen verwalten

/dbt

dbt-Operationen

/lineage

dbt-Herkunft visualisieren

Konfiguration

Befehl

Beschreibung

/settings

Einstellungen anzeigen/ändern

/theme

Farbthema auswählen

/sandbox

Sandbox-Einstellungen verwalten

/add-dir <Pfad>

Arbeitsverzeichnis hinzufügen

Erweiterbarkeit

Befehl

Beschreibung

/skill, /skills

Fähigkeiten verwalten

/mcp

MCP-Serverstatus

/hooks

Hook-Konfiguration anzeigen

/commands, /cmds

Benutzerdefinierte Befehle verwalten

/agents

Subagenten anzeigen

Dienstprogramme

Befehl

Beschreibung

/tasks

Aufgabenliste anzeigen

/feedback

Sitzungsfeedback bereitstellen (lokal als .tgz-Datei gespeichert)

/update

Cortex Code aktualisieren

Sitzungsspeicher

Befehl

Beschreibung

~/.snowflake/cortex/conversations/

Sitzungsdateien

~/.snowflake/cortex/settings.json

Allgemeine Einstellungen

~/.snowflake/cortex/permissions.json

Berechtigungseinstellungen

Siehe Cortex Code CLI-Einstellungen für Details zur Konfiguration.

Befehlsdetails

/sql: SQL-Beispiele ausführen

Grundlegende Abfrage:

/sql SELECT * FROM users
Copy

Mit Zeilenbeschränkung:

/sql SELECT * FROM large_table --limit 1000
Copy

Mehrzeilig (Strg + J für Zeilenumbrüche verwenden);

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

Ergebnisse werden automatisch im Tabellen-Viewer geöffnet (Strg+T).

/worktree: Git-Arbeitsstrukturbäume

Befehl

Beschreibung

/worktree create feature-branch

Neuen Arbeitsstrukturbaum erstellen

/worktree list

Alle Arbeitsstrukturbäume auflisten

/worktree switch feature-branch

Zum Arbeitsstrukturbaum wechseln

/worktree delete feature-branch

Arbeitsstrukturbaum löschen

/sandbox: Sandbox-Kontrolle

Befehl

Beschreibung

/sandbox

Interaktiver Selektor

/sandbox on

Container-Sandbox aktivieren

/sandbox off

Container-Sandbox deaktivieren

/sandbox status

Sandbox-Status anzeigen

/sandbox runtime on

OS-Sandbox aktivieren

/sandbox runtime off

OS-Sandbox deaktivieren

/sandbox mode auto

Sandbox-Befehle automatisch zulassen

/sandbox mode regular

Eingabeaufforderung für alle Befehle

/mcp: MCP-Server

Befehl

Beschreibung

/mcp

Statusanzeige anzeigen

/mcp list

Alle Server auflisten

/mcp start <Server>

Server starten

/mcp get <Server>

Serverdetails abrufen

/mcp remove <Server>

Entfernen des Servers

Batchmodus

Befehl

Beschreibung

cortex -p "<Aufforderung>"

Einzelne Eingabeaufforderung ausführen und beenden

cortex -f request.txt

Eingabeaufforderung aus Datei lesen

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

JSON Ausgabe

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

Steuerungskontext

Exitcodes

Code

Beschreibung

0

Success

1

Allgemeiner Fehler

2

Konfigurationsfehler

3

Verbindungsfehler

4

Berechtigung verweigert

130

Durch Benutzer unterbrochen (Strg+C)

Konfiguration und Einrichtung

Aktualisieren der Cortex Code-CLI

Die Cortex Code-CLI aktualisiert sich selbst, sobald eine neue Version verfügbar ist. Sie können auch manuell auf die neueste Version aktualisieren, indem Sie cortex update ausführen. Geben Sie cortex update <version> an, um die angegebene Version zu installieren.

Um automatische Aktualisierungen zu deaktivieren, bearbeiten Sie die Datei ~/.snowflake/cortex/settings.json und fügen Sie "autoUpdate": false hinzu.

Manuelles Hinzufügen einer Verbindung

Um die Datei ~/.snowflake/connections.toml manuell zum Definieren Ihrer Verbindung zu erstellen oder zu bearbeiten, führen Sie die folgenden Schritte aus:

  1. Erstellen Sie die Datei ~/.snowflake/connections.toml, wenn sie noch nicht existiert.

    mkdir -p ~/.snowflake
    touch ~/.snowflake/connections.toml
    
    Copy
  2. Verwenden Sie den chmod-Befehl, um die Berechtigungen so festzulegen, dass nur Sie die Datei lesen und in sie schreiben können.

    chmod 600 ~/.snowflake/connections.toml
    
    Copy
  3. Öffnen Sie die Datei in einem Texteditor (hier nano).

    nano ~/.snowflake/connections.toml
    
    Copy
  4. Fügen Sie Zeilen wie die folgenden hinzu, um eine Verbindung zu definieren. Geben Sie den Namen der Verbindung anstelle von myaccount ein und ersetzen Sie die Platzhalterwerte durch Ihre Snowflake-Kontodaten. Verwenden Sie browserbasiertes SSO (externe Browser-Authentifizierung) oder ein PAT (programmgesteuertes Zugriffstoken). Sie können ein PAT von Snowsight erhalten (siehe Verwenden von programmatische Zugriffstoken für die Authentifizierung). Schließen Sie nur den authenticator- oder den password-Wert ein, abhängig von der von Ihnen gewählten Authentifizierungsmethode.

    [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. Speichern und schließen Sie die Datei.

Einrichten von Shell-Vervollständigungen

Um Ihrer Shell die Möglichkeit zu geben, Cortex Code-CLI-Befehle und -Optionen automatisch zu vervollständigen, folgen Sie den Anweisungen unten für Ihre Shell.

Tipp

Wenn Sie nicht sicher sind, welche Shell Sie verwenden, geben Sie echo $(basename $SHELL) in Ihrem Terminal aus. Der ausgegebene Name ist die Standard-Shell für Ihr Konto und ist möglicherweise nicht genau, wenn Sie eine andere Shell manuell gestartet haben.

Shell

Befehl

bash

Cortex-Vervollständigung bash > ~/.bash_completion.d/cortex

zsh

Cortex-Vervollständigung zsh > ~/.zsh/completions/_cortex

fish

Cortex-Vervollständigung fish> ~/.config/fish/completions/cortex.fish

Nachdem Sie den entsprechenden -Befehl oben für Ihre Shell ausgeführt haben, starten Sie Ihre Shell mit exec $SHELL neu.

Verzeichnisstruktur

Durch die Installation der Cortex Code-CLI wird die folgende Verzeichnisstruktur in Ihrem Basisverzeichnis erstellt:

~/.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

Problembehandlung

Im Folgenden finden Sie häufige Fehlermeldungen, die während der Installation und des Setup auftreten können.

Befehl nicht gefunden

Stellen Sie sicher, dass das Installationsverzeichnis ~/.local/bin ist in Ihrer PATH-Umgebungsvariable enthalten ist. Wenn Sie beispielsweise bash verwenden, geben Sie die folgenden Befehle aus:

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

Berechtigung verweigert

Stellen Sie sicher, dass die ausführbare cortex-Datei über Ausführungsberechtigungen verfügt. Geben Sie den folgenden Befehl aus:

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

Verbindungsfehler

Stellen Sie sicher, dass die Verbindungsdatei :file:`~/.snowflake/connections.toml`vorhanden ist und gültige Verbindungsdetails enthält.

cat ~/.snowflake/connections.toml
Copy

Versuchen Sie, den cortex-Befehl auszuführen, wobei Sie die Verbindung explizit mit der -c-Option angeben. Beispiel:

cortex -c myaccount
Copy

Siehe auch:

Cortex Code-CLI

Installation, Setup und erste Eingabeaufforderungen

Cortex Code CLI-Einstellungen

Referenz zur Konfigurationsdatei

Beispiele für Cortex Code CLI-Workflow

Beispiele zu Funktionen und Workflows