快速开始 · 装机
macOS(Apple 芯片 / Intel)与 Linux,一行命令安装:
curl -fsSL https://runxun.com/downloads/xuncode/install.sh | sh
xun --version脚本会自动识别系统与架构、校验 sha256、安装到 /usr/local/bin(无权限时退回 ~/.local/bin)。Windows 版即将上线。离线 / 内网环境可在下载页取二进制包手动安装。
配置模型
迅码不绑定单一模型。写入全局配置 ~/.xun/config.toml:
api_base = "https://api.maxmodel.com/v1" # 网关 / vLLM / Ollama 端点
api_key = "你的 Key" # vLLM / Ollama 可留空
model = "gemini-2.5-flash"内网 vLLM 用 http://内网IP:8000/v1,本地 Ollama 用 http://127.0.0.1:11434/v1。临时切换模型:xun --model <名称>,或交互界面内 /model <名称>。
第一次对话
cd 你的项目
xun # 交互式启动
xun "修复 login 模块的空指针" # 带任务启动,立即开工直接输入任务即可。迅码会自己读代码、列待办、改文件、跑命令 —— 每一步敏感操作都先请你批准(y 允许 · a 本会话总是允许 · 回车拒绝)。建议先 xun init 生成 XUN.md(项目记忆)与 xun.toml(项目权限)。
命令与斜杠命令
子命令:
xun "<任务>" # 运行任务
xun -p "<任务>" # 无头模式,输出到 stdout(CI / 脚本)
xun --plan "<任务>" # 计划模式:先出计划再执行
xun review [ref] # 代码审查(默认审当前改动)
xun fix [目标] # 定位并修复 bug / 失败的测试
xun init # 初始化项目
xun checkpoint list|rollback <id>
xun audit list|verify|export <路径>
xun license # 查看企业许可证状态交互界面内斜杠命令:/v 语音 · /plan 计划 · /model 切模型 · /todos 待办 · /checkpoints 检查点 · /mcp 工具 · /clear 清空 · /help · /quit。
可信执行
可信执行是迅码的核心:AI 提议操作、你定夺,每条命令逐段评估风险,敏感操作先批准,全程留审计。
权限模式([permissions] mode 或旗标):default 只读放行、其余询问;accept-edits 项目内编辑放行;yolo(--yes)非危险操作全放行 —— 但 rm、git push、sudo 等危险命令始终强制询问。
规则按 deny > ask > allow 判定:
[permissions]
allow = ["Bash(cargo build:*)", "Read(src/**)"]
ask = ["Bash(git:*)"]
deny = ["Read(~/.ssh/**)"]链式命令逐段拆解评估 —— ls && rm -rf / 会因 rm 段被拦,命令替换与内嵌脚本也逐层展开;无法解析的命令保守询问。项目级 xun.toml 只能收紧、不能放宽全局权限(防仓库投毒)。
审计链:每个决策与结果写入本机 ~/.xun/audit.jsonl,哈希链串联,任何篡改都会断链。
xun audit list # 最近记录
xun audit verify # 校验完整性,断链定位到行
xun audit export a.jsonl # 合规留档计划模式
改动大或需求不明时,先只读调研、产出可审阅的计划:
xun --plan "重构 auth 模块,把回调改成 async/await"计划模式下迅码只有读取与检索工具,产出编号计划(每步写明涉及文件、改动要点、如何验证);你批准后才动手,动手前自动建检查点。交互界面内用 /plan <任务>。
检查点与回滚
在 git 仓库中,迅码每个任务开始前自动快照工作区(用 git 影子引用,不碰你的暂存区、不产生提交)。改坏了一键回滚:
xun checkpoint list
xun checkpoint rollback <id>回滚恢复被修改 / 删除的已跟踪文件;检查点之后新建的文件不会被自动删除。
语音下指令
对着说比敲字快。交互界面内输入 /v,按说即录、回车结束、转写结果经你确认后才执行。识别全程在你的 Mac 本地完成、不出机器;与润迅语音输入共享术语词典,人名 / 命令 / 专有名词零配置继承。仅 Apple 芯片 Mac 支持;首次使用需在「系统设置 → 隐私与安全性 → 麦克风」放行终端。
技能与子任务
技能是你封装的可复用方法,放 ~/.xun/skills/<名>/SKILL.md(全局)或项目 .xun/skills/。迅码启动时只读名称与描述,任务相关时再加载完整正文。子任务:复杂任务中迅码可把独立子问题派给子 Agent 处理,共享同样的权限与审计。已有的 CLAUDE.md / AGENTS.md 会被识别并可沿用。
MCP 扩展
接入外部工具服务器(数据库、内部 API、专有工具)。在 config.toml 或 xun.toml 声明:
[mcp.servers.calc]
command = "python3"
args = ["/opt/mcp/calc-server.py"]xun mcp 查看已连接工具。MCP 工具默认每次调用都请求批准,可用 allow = ["Mcp(calc:*)"] 放行信任的工具。
无头模式 / CI
xun -p "<任务>" 执行后输出到 stdout 并退出,适合脚本与 CI。无头模式下待批准操作一律自动拒绝;需要改文件 / 跑命令时配 --yes(危险命令仍拦截),或在 xun.toml 用精确 allow 规则显式授权。
# PR 自动审查(只读)
xun -p "审查本次改动,列出正确性与安全问题" | tee review.txt企业私有化
迅码支持完全私有化部署:模型、网关、代码、数据全部在你的内网,一个字节不出去。模型请求只发往配置的端点;无遥测、无上传;审计链只落本机;企业许可证 Ed25519 离线校验,不联网激活。需要离线安装包、企业许可证与部署支持,请联系我们。