文档
快速开始
- 1
生成密钥
登录后进入控制台的「Keys」页面,点击「生成密钥」。密钥用于 API 鉴权, 请妥善保存,不要提交到代码仓库。
前往控制台 - 2
写入 MCP 配置
在编辑器的 MCP 配置文件中加入以下内容,把
LOCUS_TOKEN换成上一步生成的密钥。 各编辑器的配置文件位置见 集成页面。mcp.json{ "mcpServers": { "locus": { "command": "npx", "args": ["-y", "locus-code-mcp"], "env": { "LOCUS_BASE_URL": "https://ace.panrun.me/relay", "LOCUS_TOKEN": "<控制台生成的密钥>" } } } } - 3
开始检索
重启编辑器后,AI 助手就可以调用
locus_mcp_search工具, 用自然语言检索你的代码库。首次请求成功后,可以在控制台的「请求日志」里看到记录。
- 1
生成密钥
与 MCP 方式相同:在控制台的「Keys」页面生成密钥。下一步会把它存进 Windows 凭据管理器,不需要写进任何配置文件。
前往控制台 - 2
获取 Skill
Skill 单独维护在 zj0808/locus-skill,克隆到本地后,把目录放到 AI 助手读取 Skill 的位置(例如 Claude Code 的
.claude/skills/)。下文的SKILL_DIR指这个目录里包含SKILL.md的那一层。shellgit clone https://github.com/zj0808/locus-skill.git - 3
配置密钥
两种方式,任选其一。
方式 A:环境变量(最简单)
设置
ACE_API_KEY就能直接检索,不需要执行登录命令。 适合 CI、容器,或者不想把密钥写进系统凭据的场景。PowerShell$env:ACE_API_KEY = "<控制台生成的密钥>" $env:ACE_BASE_URL = "https://ace.panrun.me/relay"上面只在当前终端会话内有效。想让新开的终端也生效,写成用户级环境变量:
PowerShell# 写入用户级环境变量,新开的终端都生效 [Environment]::SetEnvironmentVariable("ACE_API_KEY", "<控制台生成的密钥>", "User")注意:读的是进程环境变量,不是项目里的
.env文件——放一个.env到目录里不会被加载。方式 B:登录命令(存进系统凭据)
执行下面的命令,会打开控制台并在终端里安全地提示输入密钥, 密钥保存在 Windows 凭据管理器(目标名
Ace.Locus.ApiKey), 不落到任何配置文件。已经有密钥时用auth set-key直接设置, 不打开浏览器;用auth status查看当前状态。PowerShellpwsh -NoProfile -File "SKILL_DIR/scripts/ace.ps1" auth login两者同时存在时
ACE_API_KEY优先。 - 4
开始检索
AI 助手会在需要查找代码时自动调用这个 Skill,你也可以直接执行:
PowerShellpwsh -NoProfile -File "SKILL_DIR/scripts/ace.ps1" search ` --query "校验用户邮箱并返回布尔值的函数" ` --project-path "backend" ` --max-turns 2常用参数与
locus_mcp_search一致:--project-path、--path-filter、--max-turns 1..5、--max-results 1..30、--result-mode complete|focused、--tree-depth 1..6、--exclude-path(可重复)。查看索引状态用index-status,加--refresh触发刷新。 - 5
切换 API 地址(可选)
默认 API 地址是
https://ace.panrun.me/relay,保存在%APPDATA%\Ace\config.json,属于非敏感配置。需要长期改用其他地址时执行ace.ps1 config set base-url URL;临时覆盖用环境变量ACE_BASE_URL。
常见问题
MCP 和 Skill 该选哪个?
两者用的是同一套检索引擎和同一个 API,结果没有差别。编辑器支持 MCP 协议就用 MCP,跨平台可用; 想省掉 MCP 服务器配置、并且在 Windows 上使用,就用 Skill——密钥存在系统凭据管理器里,不落到配置文件。 两种方式可以同时装,互不影响。
额度怎么计算?
每个账号每天有固定的检索次数额度,鉴权失败的请求不消耗额度。剩余额度在控制台总览页实时显示。 MCP 与 Skill 共用同一份账号额度。
密钥泄露了怎么办?
在控制台「Keys」页面轮换密钥,旧密钥会立即失效。 使用 Skill 时,再执行一次 auth set-key 更新本地凭据。
检索请求经过哪些环节?
本地 locus-code-mcp 客户端负责目录树、本地 rg/读文件和多轮检索;请求经 Locus API 做鉴权与计费后转发到上游模型,结果再流式返回。
怎样更快更准?
大仓请把检索范围收窄到子包(例如 packages/api),而不是整个 monorepo 根目录。 JS/TS 项目可先建本地符号索引以提升命中:在项目里执行 graph 索引后,客户端会自动用 graph 候选引导检索。 简单问题用较少轮次(max_turns=1~2),跨模块链路追踪再加到 3~5。