快速开始
第一次使用 North Coder 的完整路径。
本页帮助你从安装后的空状态跑通一次完整使用流程:添加项目、创建工作区、发送任务、审阅改动,并在需要时打开外部应用。
1. 安装并启动
先按当前平台完成安装:
| 平台 | 文档 |
|---|---|
| macOS | macOS 和 Linux |
| Linux Server | macOS 和 Linux |
| Windows | Windows |
桌面端安装完成后直接打开 North Coder。Linux Server 启动后通过浏览器访问服务地址。
2. 配置模型
首次打开后,Agent 还无法工作——需要先配好模型。点击左上角齿轮图标进入设置页,填写 API Key 并选择模型。
建议先用一个模型跑通,确认连通后再添加更多 Profile。详细的模型字段和推荐配置见 设置 → 模型。
3. 添加项目
项目通常对应一个真实代码仓库或本地目录。添加项目后,North Coder 会基于该项目创建独立工作区。
建议选择:
- 已经能本地构建和测试的项目目录。
- Git 状态清晰的仓库。
- 你有读写权限的目录。
4. 创建工作区
工作区是 Agent 处理任务的隔离环境。创建时需要关注:
| 字段 | 含义 |
|---|---|
| 项目 | 这次任务所属的代码项目。 |
| Source ref | 从哪个分支、tag 或 commit 开始。 |
| Target branch | 任务完成后希望合入的目标分支。 |
| 工作分支 | Agent 修改代码使用的分支名。 |
如果只是探索或阅读代码,可以从当前主分支创建工作区。如果要做一个可合并的改动,建议使用清晰的工作分支名。
5. 发送第一条任务
进入工作区后,在会话输入框描述你的目标。好的任务描述通常包含:
- 你希望完成的结果。
- 相关页面、文件、模块或命令。
- 必须遵守的限制。
- 期望验证方式,例如运行测试、构建或手工检查。
示例:
阅读这个项目的 README 和 package scripts,帮我找出本地启动方式,并确认文档是否过时。把设置页里的模型选择器文案改清楚,保持现有样式,完成后跑相关前端检查。如果任务涉及架构、API、数据模型、安全策略或多模块协作,先切到 RFC Mode 做设计和拆分,再执行具体子任务。
如果需求已经明确,但你希望 Agent 先只读探索代码、给出可审阅的实现计划,再决定是否执行,可以使用 Plan Mode。
6. 审阅文件和改动
Agent 工作过程中,你可以切换到文件和改动相关视图:
- 查看源码文件。
- 搜索文件名或内容。
- 对比改动 diff。
- 查看运行命令输出。
- 需要时打开 IDE 或终端继续手工验证。
如果改动来自外部编辑器,回到 North Coder 后可以刷新文件和改动状态。
7. 打开外部应用
桌面客户端顶部有外部应用入口,可以打开:
- IDE。
- 终端。
- Finder 或资源管理器。
- 浏览器访问链接。
浏览器入口可用于从默认浏览器打开当前客户端。更多说明见 外部应用 和 桌面客户端远程访问。