Configurações da Cortex Code CLI¶
As configurações da Cortex Code CLI controlam permissões de ferramentas, conexões e comportamento de sessão. É possível definir as configurações usando uma política gerenciada (se fornecida por sua organização), arquivos de configuração, variáveis de ambiente e argumentos de linha de comando.
Arquivos de configuração¶
Os seguintes arquivos de configuração são usados pela Cortex Code CLI:
Arquivo |
Objetivo |
|---|---|
|
Arquivo de política gerenciada pela organização (opcional). Para locais específicos do OS, consulte Configurações gerenciadas (política da organização). |
|
Arquivo de configurações principal da Cortex Code CLI. |
|
Preferências de permissão. |
|
Configuração do servidor MCP (consulte Model Context Protocol (MCP)) |
|
Conexões do Snowflake (consulte Cortex Code CLI). Compartilhado com a Snowflake CLI. |
O layout completo do diretório de configuração principal é:
~/.snowflake/cortex/ # Main Cortex Code CLI config directory
├── settings.json # Main settings
├── mcp.json # MCP server configs
├── permissions.json # Saved permissions
├── hooks.json # Global hooks
├── history # Command history
├── conversations/ # Session files
├── cache/ # Temporary cache
│ ├── table_cache.json # SQL result metadata
│ └── sql_result_cache/ # Parquet files
├── logs/ # Log files
├── memory/ # Persistent memory
├── agents/ # Custom agents
├── skills/ # Global skills
├── commands/ # Custom commands
├── hooks/ # Hook scripts
└── remote_cache/ # Cloned repos
Precedência de configurações¶
As configurações são aplicadas na seguinte ordem de precedência (maior para menor):
Configurações gerenciadas (arquivo de política gerenciada pelo sistema, se presente). Consulte Configurações gerenciadas (política da organização).
Comandos na sessão (
/plan, entre outros)Argumentos de linha de comando
Variáveis de ambiente
Arquivos de configuração (
~/.snowflake/cortex/)Valores padrão incorporados na Cortex Code CLI
settings.json¶
~/.snowflake/cortex/settings.jsonArquivo de configurações principal para a Cortex Code CLI.
Exemplo de conteúdo:
{
"compactMode": true,
"autoUpdate": true,
"theme": "dark"
}
As seguintes configurações estão disponíveis:
compactMode: habilita a formatação de saída compacta.autoUpdate: habilita as atualizações automáticas.theme: define o tema da CLI (lightoudark).
permissions.json¶
~/.snowflake/cortex/permissions.jsonControla as permissões de acesso à ferramenta.
Exemplo de conteúdo:
{
"onlyAllow": ["read_file", "execute_sql"],
"defaultMode": "ask",
"dangerouslyAllowAll": false
}
As seguintes configurações estão disponíveis:
onlyAllow: lista de padrões de ferramenta permitidos.defaultMode: modo de permissão padrão (ask,allow,deny).dangerouslyAllowAll: permite todas as ferramentas sem avisos (não é seguro).
Configurações gerenciadas (política da organização)¶
As configurações gerenciadas permitem que administradores de IT apliquem políticas em toda a organização à Cortex Code CLI. Por exemplo, os administradores podem restringir quais ferramentas ou contas podem ser usadas, impor versões mínimas de CLI e desabilitar recursos de bypass.
Normalmente, essas configurações são implantadas por meio de ferramentas de gerenciamento de configuração empresariais (como MDM ou SCCM). Geralmente, os usuários não podem modificar as configurações gerenciadas, a menos que tenham privilégios de administrador/root.
Locais dos arquivos¶
O arquivo de configurações gerenciadas é armazenado em um caminho no nível do sistema:
Plataforma |
Caminho |
|---|---|
macOS |
|
Linux e WSL |
|
Esquema de configuração¶
O arquivo de configurações gerenciadas usa JSON com a seguinte estrutura:
{
"version": "1.0",
"permissions": { },
"settings": { },
"required": { },
"defaults": { },
"ui": { }
}
Permissões¶
A seção permissions restringe o que os usuários podem acessar. Por exemplo, você pode permitir ou negar padrões de ferramenta e de conta.
{
"permissions": {
"onlyAllow": ["pattern1", "pattern2"],
"deny": ["pattern3"],
"defaultMode": "allow",
"dangerouslyAllowAll": false
}
}
Campo |
Tipo |
Padrão |
Descrição |
|---|---|---|---|
|
|
— |
Lista de permissão de padrões. Se definido, somente itens correspondentes são permitidos. |
|
|
— |
Lista de negação de padrões. A negação tem precedência sobre a permissão. |
|
|
|
Comportamento quando não há correspondência com nenhuma regra. |
|
|
|
Controla se o modo bypass é permitido. |
Configurações¶
A seção settings aplica o comportamento de tempo de execução:
{
"settings": {
"forceNoHistoryMode": true,
"forceSandboxEnabled": true,
"forceSandboxMode": "regular"
}
}
Campo |
Tipo |
Padrão |
Descrição |
|---|---|---|---|
|
|
|
Não forçar a persistência do histórico de conversas. |
|
|
|
Forçar o sandbox sempre habilitado. |
|
|
— |
Forçar um modo sandbox específico. |
Obrigatório¶
A seção required pode impor versões mínimas:
{
"required": {
"minimumVersion": "0.25.0"
}
}
Campo |
Tipo |
Descrição |
|---|---|---|
|
|
Versão de CLI mínima As versões mais antigas exibem um erro e são encerradas. |
Padrões¶
A seção defaults fornece os valores padrão. Os usuários podem substituir esses padrões somente se permitidos pela política.
{
"defaults": {
"connectionName": "prod",
"profileName": "corporate",
"theme": "dark"
}
}
Campo |
Tipo |
Descrição |
|---|---|---|
|
|
Nome da conexão padrão do Snowflake. |
|
|
Perfil padrão a ser carregado. |
|
|
Tema padrão da UI (por exemplo, |
UI¶
A seção ui controla a apresentação da interface do usuário:
{
"ui": {
"showManagedBanner": true,
"bannerText": "[Secure] Managed by Corporate IT",
"hideDangerousOptions": true
}
}
Campo |
Tipo |
Padrão |
Descrição |
|---|---|---|---|
|
|
|
Exibir um banner indicando o estado gerenciado. |
|
|
— |
Texto personalizado do banner gerenciado. |
|
|
|
Ocultar opções perigosas da ajuda e da UI. |
Exemplos¶
Configuração corporativa básica¶
Permita a funcionalidade padrão, mas desabilite o modo bypass e mostre um banner gerenciado.
{
"version": "1.0",
"permissions": {
"dangerouslyAllowAll": false,
"defaultMode": "allow"
},
"settings": {},
"required": {
"minimumVersion": "0.25.0"
},
"ui": {
"showManagedBanner": true,
"bannerText": "Managed by IT"
}
}
Restringir a contas Snowflake específicas¶
Permita somente conexões com contas de produção e preparação.
{
"version": "1.0",
"permissions": {
"dangerouslyAllowAll": false,
"onlyAllow": [
"account(mycompany-prod)",
"account(mycompany-staging)"
],
"defaultMode": "allow"
}
}
Variáveis de ambiente¶
A Cortex Code CLI reconhece as seguintes variáveis de ambiente de configuração:
Variável |
Descrição |
|---|---|
|
Substitui o diretório padrão |
|
Substitui a seleção de modelo. |
|
Habilita a ferramenta de memória (definida como |
|
Requer confirmação para operações de gravação SQL no modo bypass. |
Nota
Para obter variáveis de ambiente adicionais relacionadas à permissão, consulte Segurança.
Substituições de linha de comando¶
As configurações da Cortex Code CLI podem ser substituídas por meio de argumentos de linha de comando como estes:
Exemplo |
Descrição |
|---|---|
|
Especifica a conexão. |
|
Define o diretório de trabalho. |
|
Continua a última sessão. |
|
Retoma uma sessão específica. |
|
Habilita o modo de planejamento. |
|
Desabilita os avisos de permissão (não é seguro). |
Armazenamento de sessões¶
As conversas e as configurações são armazenadas em:
Local |
Descrição |
|---|---|
|
Arquivos de sessão. |
|
Preferências de permissão. |
|
Configuração do MCP. |