Referência da Cortex Code CLI

Referência de linha de comando para a Cortex Code CLI.

Iniciando o Cortex Code

Comando

Descrição

cortex

Iniciar no diretório atual

cortex -c production

Iniciar com uma conexão específica

cortex -w /path/to/project

Iniciar no diretório específico

cortex -w /new/project -c myconn

Combinar diretório de trabalho e conexão

cortex --continue

Continuar a última sessão

cortex --resume <session_id>

Retomar uma sessão específica

Opções de CLI

Opção

Descrição

-c, --connection <nome>

Usar uma conexão específica do Snowflake

-w, --workdir <caminho>

Definir o diretório de trabalho para operações de arquivo

-m, --model <model_name>

Especificar o modelo de AI a ser usado

--plan

Modo de plano: exigir aprovação antes de todas as ações

--bypass

Aprovar automaticamente todas as ações planejadas

--dangerously-allow-all-tool-calls

Desabilitar os prompts de permissão de chamada de ferramenta (cuidado)

--continue

Retomar a conversa mais recente

-r, --resume <session_id>

Retomar uma sessão específica por ID, ou last para a última sessão

-p, --print  "<prompt>"

Passar o prompt especificado, imprimir a resposta e sair

-f, --file <arquivo>

Ler o prompt do arquivo, executar e sair

--output-format stream-json

Saída JSON (para script)

-V, --version

Mostrar a versão instalada

--help

Mostrar a ajuda da CLI

As conexões devem ser definidas em ~/.snowflake/connections.toml. Consulte Cortex Code CLI para ver a configuração de conexão. Os IDs de sessão são mostrados na inicialização, na saída e armazenados em ~/.snowflake/cortex/conversations/.

Exemplos

Iniciar com o diretório de trabalho:

cortex -w /path/to/project
Copy

Retomar a última sessão com uma conexão específica:

cortex --continue -c production
Copy

Prompt único (saída JSON):

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

Comandos

update

Comando

Descrição

cortex update

Atualizar para a versão mais recente

cortex --version

Verificar após a atualização

mcp

Comando

Descrição

cortex mcp list

Listar os servidores configurados

cortex mcp add

Adicionar um novo servidor (interativo)

cortex mcp remove <server_name>

Remover servidor

Consulte Model Context Protocol (MCP) para obter mais detalhes.

Modo interativo

Atalhos do teclado

Atalho

Ação

Ctrl+C

Cancelar a operação atual

Ctrl+C Ctrl+C

Sair da Cortex Code CLI

Ctrl+L

Limpar a tela do terminal (mantém a conversa)

Up/Down arrows

Navegar no histórico de comandos

Tab

Conclusão do comando

Comandos com barra

Gerenciamento de sessão

Comando

Descrição

/help

Mostrar ajuda interativa

/plan

Habilitar o modo de planejamento

/plan_off

Desabilitar modo de planejamento

/clear, /cls

Limpar a tela

/new

Iniciar uma nova sessão

/rename <título>

Renomear a sessão atual

/exit, /quit

Sair da Cortex Code CLI

/resume, /r, /sessions

Listar e retomar sessões

/rewind

Voltar n etapas na conversa ou escolher interativamente

/skill list

Listar habilidades disponíveis

/mcp-status

Mostrar status do servidor MCP

/fork

Bifurcar a sessão atual em uma nova sessão

Modelo e modo

Comando

Descrição

/model

Mostrar/selecionar modelo de AI

/plan

Habilitar modo de plano

/plan-off

Desabilitar modo de plano

/bypass

Habilitar modo bypass (aprovar automaticamente todas as chamadas de ferramentas incluídas)

/bypass-off

Desabilitar modo bypass

/status

Mostrar configuração atual

Snowflake e dados

Comando

Descrição

/sql <consulta>

Executar consulta SQL

/sql <consulta> --limit <n>

Limitar linhas exibidas

/table [<arquivo>], /csv

Abrir visualizador de tabela

/connections, /conn

Gerenciamento de conexões Snowflake

Ferramentas de desenvolvimento

Comando

Descrição

/sh, ! <comando>

Executar comando do shell

/diff, /changes, /review

Revisar alterações do git

/worktree

Gerenciar árvores de trabalho do git

/dbt

Operações dbt

/lineage

Visualização de linhagem do dbt

Configuração

Comando

Descrição

/settings

Visualizar/modificar configurações

/theme

Selecionar tema de cores

/sandbox

Gerenciar configurações de sandbox

/add-dir <caminho>

Adicionar diretório de trabalho

Extensibilidade

Comando

Descrição

/skill, /skills

Gerenciar habilidades

/mcp

Status do servidor MCP

/hooks

Visualizar configuração de ganchos

/commands, /cmds

Gerenciar comandos personalizados

/agents

Visualizar subagentes

Utilitários

Comando

Descrição

/tasks

Mostrar lista de tarefas

/feedback

Enviar feedback de sessão (salvo localmente como arquivo .tgz)

/update

Atualizar o Cortex Code

Armazenamento de sessões

Comando

Descrição

~/.snowflake/cortex/conversations/

Arquivos de sessão

~/.snowflake/cortex/settings.json

Configurações gerais

~/.snowflake/cortex/permissions.json

Preferências de permissão

Consulte Configurações da Cortex Code CLI para ver detalhes de configuração.

Detalhes de comandos

/sql: executar exemplos de SQL

Consulta básica:

/sql SELECT * FROM users
Copy

Com limite de linhas:

/sql SELECT * FROM large_table --limit 1000
Copy

Multilinha (use Ctrl+J para novas linhas):

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

Os resultados são abertos automaticamente no visualizador de tabela (Ctrl+T).

/worktree: árvores de trabalho do git

Comando

Descrição

/worktree create feature-branch

Criar nova árvore de trabalho

/worktree list

Listar todas as árvores de trabalho

/worktree switch feature-branch

Alternar para árvore de trabalho

/worktree delete feature-branch

Excluir árvore de trabalho

/sandbox: controle de sandbox

Comando

Descrição

/sandbox

Seletor interativo

/sandbox on

Habilitar sandbox de contêiner

/sandbox off

Desabilitar sandbox de contêiner

/sandbox status

Mostrar status do sandbox

/sandbox runtime on

Habilitar sandbox de OS

/sandbox runtime off

Desabilitar sandbox de OS

/sandbox mode auto

Permitir automaticamente comandos em sandbox

/sandbox mode regular

Exibir prompt para todos os comandos

/mcp: servidores MCP

Comando

Descrição

/mcp

Mostrar visualizador de status

/mcp list

Listar todos os servidores

/mcp start <servidor>

Iniciar servidor

/mcp get <servidor>

Obter detalhes do servidor

/mcp remove <servidor>

Remover servidor

Modo de lote

Comando

Descrição

cortex -p "<prompt>"

Executar prompt único e sair

cortex -f request.txt

Ler prompt do arquivo

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

Saída de JSON

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

Contexto de controle

Códigos de saída

Código

Descrição

0

Sucesso

1

Erro geral

2

Erro de configuração

3

Erro de conexão

4

Permissão negada

130

Interrompido pelo usuário (Ctrl+C)

Configuração e instalação

Atualizando a Cortex Code CLI

A Cortex Code CLI é automaticamente atualizada quando uma nova versão fica disponível. Você também pode atualizar manualmente para a versão mais recente emitindo cortex update. Emita cortex update <versão> para instalar a versão especificada.

Para desabilitar as atualizações automáticas, edite ~/.snowflake/cortex/settings.json e adicione "autoUpdate": false.

Adicionando manualmente uma conexão

Para criar ou editar manualmente o arquivo ~/.snowflake/connections.toml para definir sua conexão, siga as etapas abaixo:

  1. Crie o arquivo ~/.snowflake/connections.toml, se ainda não existir.

    mkdir -p ~/.snowflake
    touch ~/.snowflake/connections.toml
    
    Copy
  2. Use o comando chmod para definir as permissões para que somente você possa lê-lo e gravá-lo.

    chmod 600 ~/.snowflake/connections.toml
    
    Copy
  3. Abra o arquivo em um editor de texto (neste caso, nano).

    nano ~/.snowflake/connections.toml
    
    Copy
  4. Adicione linhas, como as mostradas a seguir, para definir uma conexão. Digite o nome da conexão no lugar de myaccount e substitua os valores de espaço reservado pelos detalhes da sua conta Snowflake. Use SSO baseado em navegador (autenticação de navegador externo) ou PAT (token de acesso programático). Você pode obter um PAT pelo Snowsight (consulte Uso de tokens de acesso programático para autenticação). Inclua apenas o valor authenticator ou password, dependendo do método de autenticação que você escolher.

    [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. Salve e feche o arquivo.

Configurando as conclusões do shell

Para dar ao seu shell a capacidade de preencher automaticamente comandos e opções da Cortex Code CLI, siga as instruções abaixo referente ao seu shell.

Dica

Se você não tiver certeza de qual shell está usando, emita echo $(basename $SHELL) em seu terminal. O nome impresso é o shell padrão para a sua conta, e pode não ser preciso se você iniciou outro shell manualmente.

Shell

Comando

bash

cortex completion bash > ~/.bash_completion.d/cortex

zsh

cortex completion zsh > ~/.zsh/completions/_cortex

fish

cortex completion fish > ~/.config/fish/completions/cortex.fish

Depois de executar o comando apropriado acima para o seu shell, reinicie o shell com exec $SHELL.

Estrutura de diretórios

A instalação da Cortex Code CLI cria a seguinte estrutura de diretórios em seu diretório inicial:

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

Solução de problemas

Veja a seguir mensagens de erro comuns que você pode encontrar durante a instalação e configuração.

Comando não encontrado

Certifique-se de que o diretório de instalação ~/.local/bin esteja incluído na variável de ambiente PATH. Por exemplo, se você usa bash, emita os seguintes comandos:

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

Permissão negada

Certifique-se de que o executável cortex tenha permissões de execução. Emita o seguinte comando:

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

Erros de conexão

Certifique-se de que o arquivo de conexão ~/.snowflake/connections.toml exista e contenha detalhes de conexão válidos.

cat ~/.snowflake/connections.toml
Copy

Tente invocar o comando cortex com uma conexão explicitamente especificada usando a opção -c. Por exemplo:

cortex -c myaccount
Copy

Consulte também

Cortex Code CLI

Instalação, configuração e primeiros prompts

Configurações da Cortex Code CLI

Referência de arquivo de configuração

Exemplos de fluxo de trabalho da Cortex Code CLI

Exemplos de recursos e fluxo de trabalho