Cortex Code CLI 参考¶

示例¶

从工作目录开始：

cortex -w /path/to/project

使用特定连接恢复上次会话：

cortex --continue -c production

一次性提示（JSON 输出）：

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

update¶

mcp¶

有关详细信息，请参阅 模型上下文协议 (MCP)。

键盘快捷键¶

斜杠命令¶

会话存储¶

有关配置详细信息，请参阅 Cortex Code CLI 设置。

命令详细信息¶

/sql SELECT * FROM users

/sql SELECT * FROM large_table --limit 1000

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

更新 Cortex Code CLI¶

当有新版本可用时，Cortex Code CLI 会自行更新。您还可以通过执行 cortex update 手动更新到最新版本。执行 cortex update <version> 可安装指定版本。

要禁用自动更新，请编辑 ~/.snowflake/cortex/settings.json 并添加 "autoUpdate": false。

手动添加连接¶

要手动创建或编辑 ~/.snowflake/connections.toml 文件来定义连接，请按照以下步骤操作：

1. 创建 ~/.snowflake/connections.toml 文件（如果该文件尚不存在）。

   mkdir -p ~/.snowflake
   touch ~/.snowflake/connections.toml
   

   Copy

2. 使用 chmod 命令来设置其权限，以便只有您才能读取和写入。

   chmod 600 ~/.snowflake/connections.toml
   

   Copy

3. 在文本编辑器中打开文件（此处使用 nano）。

   nano ~/.snowflake/connections.toml
   

   Copy

4. 添加如下所示的行来定义连接。输入连接的名称来代替 myaccount，并将占位符值替换为您的 Snowflake 账户详细信息。使用基于浏览器的 SSO（外部浏览器身份验证）或 PAT（编程访问令牌）。您可以从 Snowsight 获取 PAT（请参阅 用于身份验证的编程访问令牌）。仅包括 authenticator 值或 password 值，具体取决于您选择的身份验证方法。

   [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. 保存并关闭文件。

设置 shell 补全¶

要让您的 shell 能够自动补全 Cortex Code CLI 命令和选项，请按照以下适用于您的 shell 的说明进行操作。

为您的 shell 运行上述相应命令后，使用 exec $SHELL 重新启动您的 shell。

目录结构¶

安装 Cortex Code CLI 可在主目录中创建以下目录结构：

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

未找到命令¶

确保安装目录 ~/.local/bin 包含在您的 PATH 环境变量中。例如，如果您使用的是 bash，则执行以下命令：

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

权限被拒绝¶

确保 cortex 可执行文件具有执行权限。执行以下命令：

chmod +x ~/.local/bin/cortex

连接错误¶

确保连接文件 ~/.snowflake/connections.toml 存在并包含有效的连接详细信息。

cat ~/.snowflake/connections.toml

通过使用 -c 选项显式指定的连接，尝试执行 cortex 命令。例如：

cortex -c myaccount