YeePilot 入门

本指南适合谁

这是一份面向终端用户的快速上手指南，重点是日常使用中的实际操作，而不是开发者内部实现。

开始使用

安装后，通常用下面任一命令进入主界面：

yeepilot

或：

yeepilot run

这两个命令都会打开交互式聊天。如果您只想执行一次任务然后退出，可以使用：

yeepilot exec "show disk usage"

首次设置

第一次启动时，YeePilot 通常会进入设置向导。之后如有需要，也可以随时重新运行：

yeepilot setup

常见流程如下：

1. 选择 AI 提供商
2. 输入 API 密钥或认证方式
3. 选择初始模型
4. 确认语言和基础偏好
5. 检查安全策略

常见提供商

大多数用户会接触到这些提供商：

• openrouter
• openai
• anthropic

如果您希望灵活试用多个模型，openrouter 往往更方便。如果组织已经固定使用某个平台，直接跟随该平台通常更省心。

第一个可用提示词

可以直接输入自然语言目标，例如：

Show me disk usage on all mounted filesystems, sorted by usage percentage

YeePilot 会先把它转换成可审阅的执行计划。

命令确认流程

在执行命令或变更之前，YeePilot 会显示：

• 即将执行的精确命令
• 风险级别
• 确认提示

最重要的风险分类包括：

• SAFE 读取或检查类操作
• MODERATE 可控变更
• DANGEROUS 影响更大的操作
• BLOCKED 不应自动执行的操作

如果当前策略要求确认，那么没有您的明确批准就不会执行任何内容。

日常会用到的三个界面

终端用户通常只需要熟悉这三块：

• 主聊天区
• 右侧 sidecar
• 用于查看会话、设置、审计和用量的 Neural HUD

打开 Neural HUD

最常用的入口：

• 输入框为空时按 Esc
• F2 直接打开 Settings
• F3 直接打开 Keybinds
• /settings
• /keybinds

建议先记住的命令

/help
/plan on
/sessions
/file README.md
/vault
/update

推荐的基础工作流

1. 用 yeepilot 启动
2. 如果任务较敏感，先执行 /plan on
3. 清楚描述目标
4. 审核计划和风险级别
5. 只批准您理解的操作
6. 需要时用 HUD 查看用量、会话和设置

配置文件位置

主配置文件位于：

~/.yeepilot/config.yml

较老的安装可能还保留 config.yaml，但当前应以 config.yml 为准。

常用 CLI 命令

yeepilot status
yeepilot version
yeepilot update
yeepilot diagnostics pending
yeepilot support report --message "describe the problem"

接下来建议阅读

• 交互式聊天
• Neural HUD、设置与快捷键
• Agent Loop
• Vault
• 配置参考