Referência da Cortex Code CLI¶
Referência de linha de comando para a Cortex Code CLI.
Iniciando o Cortex Code¶
Comando |
Descrição |
|---|---|
|
Iniciar no diretório atual |
|
Iniciar com uma conexão específica |
|
Iniciar no diretório específico |
|
Combinar diretório de trabalho e conexão |
|
Continuar a última sessão |
|
Retomar uma sessão específica |
Opções de CLI¶
Opção |
Descrição |
|---|---|
|
Usar uma conexão específica do Snowflake |
|
Definir o diretório de trabalho para operações de arquivo |
|
Especificar o modelo de AI a ser usado |
|
Modo de plano: exigir aprovação antes de todas as ações |
|
Aprovar automaticamente todas as ações planejadas |
|
Desabilitar os prompts de permissão de chamada de ferramenta (cuidado) |
|
Retomar a conversa mais recente |
|
Retomar uma sessão específica por ID, ou |
|
Passar o prompt especificado, imprimir a resposta e sair |
|
Ler o prompt do arquivo, executar e sair |
|
Saída JSON (para script) |
|
Mostrar a versão instalada |
|
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
Retomar a última sessão com uma conexão específica:
cortex --continue -c production
Prompt único (saída JSON):
cortex -p "List all Python files" --output-format stream-json
Comandos¶
update¶
Comando |
Descrição |
|---|---|
|
Atualizar para a versão mais recente |
|
Verificar após a atualização |
mcp¶
Comando |
Descrição |
|---|---|
|
Listar os servidores configurados |
|
Adicionar um novo servidor (interativo) |
|
Remover servidor |
Consulte Model Context Protocol (MCP) para obter mais detalhes.
Modo interativo¶
Atalhos do teclado¶
Atalho |
Ação |
|---|---|
|
Cancelar a operação atual |
|
Sair da Cortex Code CLI |
|
Limpar a tela do terminal (mantém a conversa) |
|
Navegar no histórico de comandos |
|
Conclusão do comando |
Comandos com barra¶
Gerenciamento de sessão¶
Comando |
Descrição |
|---|---|
|
Mostrar ajuda interativa |
|
Habilitar o modo de planejamento |
|
Desabilitar modo de planejamento |
|
Limpar a tela |
|
Iniciar uma nova sessão |
|
Renomear a sessão atual |
|
Sair da Cortex Code CLI |
|
Listar e retomar sessões |
|
Voltar n etapas na conversa ou escolher interativamente |
|
Listar habilidades disponíveis |
|
Mostrar status do servidor MCP |
|
Bifurcar a sessão atual em uma nova sessão |
Modelo e modo¶
Comando |
Descrição |
|---|---|
|
Mostrar/selecionar modelo de AI |
|
Habilitar modo de plano |
|
Desabilitar modo de plano |
|
Habilitar modo bypass (aprovar automaticamente todas as chamadas de ferramentas incluídas) |
|
Desabilitar modo bypass |
|
Mostrar configuração atual |
Snowflake e dados¶
Comando |
Descrição |
|---|---|
|
Executar consulta SQL |
|
Limitar linhas exibidas |
|
Abrir visualizador de tabela |
|
Gerenciamento de conexões Snowflake |
Ferramentas de desenvolvimento¶
Comando |
Descrição |
|---|---|
|
Executar comando do shell |
|
Revisar alterações do git |
|
Gerenciar árvores de trabalho do git |
|
Operações dbt |
|
Visualização de linhagem do dbt |
Configuração¶
Comando |
Descrição |
|---|---|
|
Visualizar/modificar configurações |
|
Selecionar tema de cores |
|
Gerenciar configurações de sandbox |
|
Adicionar diretório de trabalho |
Extensibilidade¶
Comando |
Descrição |
|---|---|
|
Gerenciar habilidades |
|
Status do servidor MCP |
|
Visualizar configuração de ganchos |
|
Gerenciar comandos personalizados |
|
Visualizar subagentes |
Utilitários¶
Comando |
Descrição |
|---|---|
|
Mostrar lista de tarefas |
|
Enviar feedback de sessão (salvo localmente como arquivo .tgz) |
|
Atualizar o Cortex Code |
Armazenamento de sessões¶
Comando |
Descrição |
|---|---|
|
Arquivos de sessão |
|
Configurações gerais |
|
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
Com limite de linhas:
/sql SELECT * FROM large_table --limit 1000
Multilinha (use Ctrl+J para novas linhas):
/sql SELECT
customer_id,
SUM(amount) as total
FROM orders
GROUP BY customer_id
Os resultados são abertos automaticamente no visualizador de tabela (Ctrl+T).
/worktree: árvores de trabalho do git¶
Comando |
Descrição |
|---|---|
|
Criar nova árvore de trabalho |
|
Listar todas as árvores de trabalho |
|
Alternar para árvore de trabalho |
|
Excluir árvore de trabalho |
/sandbox: controle de sandbox¶
Comando |
Descrição |
|---|---|
|
Seletor interativo |
|
Habilitar sandbox de contêiner |
|
Desabilitar sandbox de contêiner |
|
Mostrar status do sandbox |
|
Habilitar sandbox de OS |
|
Desabilitar sandbox de OS |
|
Permitir automaticamente comandos em sandbox |
|
Exibir prompt para todos os comandos |
/mcp: servidores MCP¶
Comando |
Descrição |
|---|---|
|
Mostrar visualizador de status |
|
Listar todos os servidores |
|
Iniciar servidor |
|
Obter detalhes do servidor |
|
Remover servidor |
Modo de lote¶
Comando |
Descrição |
|---|---|
|
Executar prompt único e sair |
|
Ler prompt do arquivo |
|
Saída de JSON |
|
Contexto de controle |
Códigos de saída¶
Código |
Descrição |
|---|---|
|
Sucesso |
|
Erro geral |
|
Erro de configuração |
|
Erro de conexão |
|
Permissão negada |
|
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:
Crie o arquivo
~/.snowflake/connections.toml, se ainda não existir.mkdir -p ~/.snowflake touch ~/.snowflake/connections.toml
Use o comando
chmodpara definir as permissões para que somente você possa lê-lo e gravá-lo.chmod 600 ~/.snowflake/connections.toml
Abra o arquivo em um editor de texto (neste caso,
nano).nano ~/.snowflake/connections.tomlAdicione linhas, como as mostradas a seguir, para definir uma conexão. Digite o nome da conexão no lugar de
myaccounte 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 valorauthenticatoroupassword, 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>"
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 |
|---|---|
|
|
|
|
|
|
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
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
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
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
Tente invocar o comando cortex com uma conexão explicitamente especificada usando a opção -c. Por exemplo:
cortex -c myaccount
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