CLI 手册
本地终端 Agent · 24 个子命令 · 31 个内置斜杠命令 · 安装见 下载页 · 模型接入见 API 文档
快速开始
neyino # 在项目目录启动(首条消息前用 /connect 连接模型) neyino run "..." # 非交互:带一条消息直接执行 neyino --help # 查看全部子命令
- 装完 3 步的图文版见下载页;连接模型可用
/connect(登录 Neyino Console 或粘贴nyi-密钥),也可设置环境变量NEYINO_API_KEY。 - 输入
/触发命令补全;Ctrl+P打开命令面板列出全部可用操作。
斜杠命令(TUI 内输入)
在输入框以 / 开头调用;带参数的命令在 / 后空格会弹出补全。桌面版另有 /presets(提示词预设)。
| 命令 | 别名 | 说明 |
|---|---|---|
/sessions | — | 切换会话 |
/new | — | 新建会话 |
/clear | — | 清空当前会话 |
/open | projects project | 打开会话或项目 |
/models | — | 列出并切换可用模型 |
/model <模型> | — | 直接设置当前模型(输入空格弹出候选) |
/agents | — | 切换 agent |
/crew [list|remote] | — | 进入 Crew 模式;list 看子会话,remote 开远程控制台 |
/lead | — | 把本会话切换为 Captain |
/usage | — | 查看用量统计 |
/memory | — | 查看记忆库 |
/remember <内容> | — | 记下一条长期记忆 |
/recall <查询> | — | 语义搜索记忆 |
/initialize <文件> | — | 从文件(如 AGENTS.md)导入记忆 |
/mcps | — | 查看 MCP 服务器状态 |
/variants | thinking effort | 切换模型变体(思考档) |
/connect | — | 连接模型服务或集成(Neyino Console / API Key / 其他厂商) |
/highlights | — | 查看当前版本更新亮点 |
/settings | — | 打开设置 |
/status | — | 查看余额、今日用量与限速 |
/update | — | 检查并安装新版本 |
/pair | web | 生成一次性配对链接(连接浏览器或手机) |
/restart | — | 重启后台服务 |
/reload | — | 重载配置(不重启服务) |
/debug | — | 查看调试信息 |
/doctor | — | 运行健康检查 |
/themes | — | 切换主题 |
/help | — | 打开帮助 |
/exit | quit q | 退出 neyino |
/init | — | 引导式创建 AGENTS.md(项目规范与记忆) |
/review [commit|branch|pr] | — | 审查改动,默认未提交的 |
自定义命令:在配置目录的 command/(或 commands/)下放 .md 文件,frontmatter 写 description,正文即模板,重载后以同名斜杠命令出现。MCP 服务器提供的 prompt 也会注册为斜杠命令。
命令行子命令
在 shell 中调用;每个子命令可用 neyino <子命令> --help 查看专属参数。
| 子命令 | 说明 |
|---|---|
upgrade / update | 升级到最新或指定版本 |
uninstall | 卸载(保留会话、配置与状态) |
acp | 启动 Agent Client Protocol 服务器(供编辑器集成) |
api | 向运行中的服务发请求(OpenAPI operation 或 method + path) |
debug | 调试与排障:agents / config / heap-dump / paths |
auth | 管理集成与凭据:list / login / logout / export / import / switch |
doctor | 运行健康检查并报告安装问题 |
node | 注册工作节点并派发任务:add / list / remove / dispatch |
bot | 把 IM 平台消息中继进会话(目前支持 telegram) |
memory | 操作本地记忆中枢(export 导出可分享片段) |
mcp | 管理 MCP 服务器:list / add / auth / logout / serve |
plugin | 管理插件:list / add / check / update / remove |
models | 列出全部可用模型 |
status | 查看积分余额、今日用量与限速 |
stats | 分享用量统计(--days / --year / --all / --models) |
mini | 启动极简交互界面 |
proxy | 在 127.0.0.1 起 Anthropic/Gemini wire 网关,供任意 AI 客户端使用 |
dispatch | 并行执行 jobs 文件(JSONL 或 JSON 数组)并收集结果 |
run | 带一条消息运行 neyino(非交互) |
session | 管理会话:list / delete / export / import |
service | 管理后台服务:start / restart / status / stop / get / set / unset |
reload | 重载配置 |
pair | 打印一次性链接,连接浏览器或手机应用 |
serve | 启动 v2 API 与 web 服务器 |
全局参数
| 参数 | 说明 |
|---|---|
--wizard | 交互式命令构建器:逐步问答,生成完整命令行(是全局 flag,不是斜杠命令) |
--standalone | 用私有服务运行,不连后台服务 |
--server <url> | 连接指定服务地址 |
--auto | 自动批准未显式拒绝的权限 |
-c, --continue | 续接上一会话 |
-s, --session <id> | 指定会话(不存在则创建) |
--prompt <text> | 启动时附带一条消息 |
--completions <shell> | 打印 shell 补全脚本(bash / zsh / fish / sh) |
--log-level / --print-logs | 设置日志级别 / 输出日志到 stderr |
-h / -v | 帮助 / 版本 |
按角色配模型(配置参考)
默认所有会话共用一个全局模型;可以给单个 agent 单独指定——比如船长用强模型、干杂活的用便宜快模型。改完执行 neyino reload(或 TUI 里 /reload)即生效,不用重启服务。
取模型的顺序(先命中先用):
- 会话里
/model显式切换过的模型(最高) agents.<id>.model—— 该角色的覆盖- 全局
model—— 默认兜底
配置片段(~/.config/neyino/neyino.jsonc):
{
"model": "xiaomi/mimo-v2.6-flash",
"agents": {
"captain": { "model": "xiaomi/mimo-v2.6-pro" },
"general": { "model": "deepseek/deepseek-flash" }
}
}
含义:全局默认 mimo-v2.6-flash;captain(船长)升级用 mimo-v2.6-pro;general(杂活)用便宜快的 deepseek-flash。只写需要覆盖的 agent,其余全部走全局。
常见坑:
- 模型引用必须和目录一致:
provider/model格式,用neyino models查全表。拼错不会报错——运行时会静默回退到全局默认;跑neyino doctor看agents.model一项即可抓出。 - reload ≠ 重启:reload 只重读配置,不影响在跑的会话;重启服务会打断进行中的任务——只有改了代码才需要重启。
- 两种写法等价:短串
"xiaomi/mimo-v2.6-pro",或对象{"providerID":"xiaomi","model":"mimo-v2.6-pro"};带变体写provider/model#variant。 - 覆盖不改变会话记录里的
model字段(它只记显式/model切换);实际用了哪个模型看新消息,或用neyino doctor核对归属。
hooks(工具生命周期钩子)
配置顶层 hooks 键(不是 experimental),在四个事件点执行 shell 命令。每条规则 = matcher(对工具名的正则,省略=匹配所有工具)+ command(事件 JSON 从 stdin 传入)+ timeout(如 "30 seconds",默认 60 秒)。改完 neyino reload 即生效。
真实可用片段——PostToolUse 给写入的 Python 文件跑语法检查(只查 .py,出错时 exit 2 把报错交给模型):
{
"hooks": {
"PostToolUse": [
{
"matcher": "write",
"command": "python3 -c 'import json,sys;d=json.load(sys.stdin);i=d[\"input\"];compile(i.get(\"content\") or \"\",i[\"path\"],\"exec\") if i[\"path\"].endswith(\".py\") else None' || exit 2",
"timeout": "30 seconds"
}
]
}
}
四个事件与退出码语义:
- PreToolUse:工具执行前。exit 2 = 拦截本次调用,stderr 原样作为拒绝理由给模型(实测:read 被拦后模型收到
read blocked by hook)。 - PostToolUse:工具执行后(成功、失败都触发)。exit 2 = stderr 追加进工具结果作为模型反馈(实测:坏 .py 的 SyntaxError 出现在模型看到的结果里,好文件与非 .py 零误报);其他退出码只记日志、不拦截。
- SessionStart / SessionEnd:会话开始 / 结束,stdin 收到
{"session_id","cwd","hook_event_name"},SessionEnd 多一个reason(如succeeded)。
常见坑:
- matcher 匹配的是工具名,不是文件:
write|edit匹配 write/edit 两个工具;要按扩展名过滤就在 command 里判(示例即此)。 - stdin 是一行 JSON:工具事件含
tool / input / status / result字段,用python3 -c '…json.load(sys.stdin)…'取字段;命令在会话所在目录执行。 - exit 2 是唯一有语义的退出码(Pre=拦截、Post=反馈):PostToolUse 里 exit 1 与其他码完全静默——lint 失败请显式
|| exit 2。 - 超时按
timeout强杀(默认 60 秒),超时记为失败但不拦截。 - 别在 hook 里做交互(读输入):hook 是无头执行,stdin 已被事件 JSON 占用。
MCP(接入外部工具服务器)
MCP = Model Context Protocol:把外部工具服务器(本地进程或远程 HTTP)接进会话。配置写在 neyino.json 的 mcp.servers 下。
neyino mcp add demo -- node server.js # 本地 stdio:服务器命令跟在 -- 后 neyino mcp add hub -- $(command -v neyino) mcp serve # 本机记忆中枢(见坑:勿用裸 neyino) neyino mcp add remote --url https://example.com/mcp --header Authorization=Bearer xxx neyino mcp add demo --global # 写全局配置 ~/.config/neyino/neyino.json(所有项目生效) neyino mcp list # 查看各服务器连接状态 neyino mcp auth <name> # 远程服务器 OAuth 授权;neyino mcp logout <name> 清凭据 neyino mcp serve # 反向:把本机记忆中枢以 stdio 暴露给 Claude/Cursor 等客户端
常见坑:
- 不读
.mcp.json:配置发现只认neyino.json / neyino.jsonc,Claude Desktop 那套.mcp.json在 neyino 里无效;--global写的是全局neyino.json,与项目配置同为mcp.servers键。 - OAuth vs 本地 stdio:远程(
--url)走 HTTP,需要登录的先mcp auth <name>;本地是 stdio 子进程,命令跟在--后,环境变量用--env key=value传。 - 参数互斥:
--url与--命令二选一(报Provide either --url … or a command after --, not both);--header只对远程有效;URL 写错报Invalid URL。 - preset
neyino mcp add neyino当前连不上(实测报Script not found "mcp":spawn 对neyino这个 command 名注入了BUN_BE_BUN,与子命令碰撞)——改用上面的$(command -v neyino)全路径写法,实测✓ connected。 - 新目录首次
mcp list可能短暂显示No MCP servers configured(位置冷启动),几秒后重试即可。
权限(allow / ask / deny)
配置顶层 permissions 数组,每条 = action(工具名)+ resource(对象)+ effect(allow / ask / deny)。两者都支持 glob:* 任意串、? 单字符,整串匹配。后写的规则覆盖先写的,一条都没命中时默认 ask。
{
"permissions": [
{ "action": "*", "resource": "*", "effect": "allow" },
{ "action": "shell", "resource": "rm -rf*", "effect": "deny" },
{ "action": "read", "resource": "*.env", "effect": "ask" }
]
}
含义:默认全放行;以 rm -rf 开头的 shell 命令硬拒绝;读 .env 文件要确认。「例外」规则写在后面才盖得过前面的 allow。
与 --auto 的关系(均实测):
- 规则判为
ask时:交互会话弹确认;非交互(neyino run、CI)不带--auto→ 直接拒绝,提示permission requested: … auto-rejecting。 neyino run --auto:自动批准所有未被显式 deny 的请求(help 原文 "Auto-approve permissions that are not explicitly denied")——实测 ask 规则的echo被放行执行。deny永远最优先:实测带--auto跑rm -rf …仍报Permission denied: shell。
常见坑:
- 顺序即优先级:求值取「最后一条命中的规则」——「先全 allow 再补 deny」必须把 deny 放数组最后,放前面会被覆盖。
shell的 resource 是整条命令串,glob 按命令前缀写(如rm -rf*)。~/$HOME展开只对read/edit/external_directory这几类 action 生效。- 无人值守(脚本、CI)要么加
--auto,要么把需要的动作显式allow——ask在非交互下等于拒绝。
--wizard(交互式命令引导)
全局 flag,任何子命令后都能加:进入交互式命令构建器(Command wizard),列出可选子命令逐步问答,生成完整命令行。实测 neyino --wizard 与 neyino run --wizard 均可进入,Current command 显示当前已选部分。
neyino --wizard # 从零构建一条命令 neyino run --wizard # 以 neyino run 为起点继续补参数
常见坑:
- 没有
/wizard斜杠命令(11-10 已勘误):TUI 里输入/wizard不会有反应——它是命令行 flag,不是 slash。 - 向导是交互式的:管道、脚本等无 TTY 场景下直接结束(EOF 退出码 0),别在 cron / CI 里用。
- 中途
Ctrl+C取消不产生副作用;生成的命令回车即可执行。
Crew 编排(多会话协作)
把一次任务拆给多名「船员」并行干:Captain(船长)接单拆分 → Chief(部门长)→ Crew(船员)执行,会话列表按角色显示徽章。
/crew:进入 Crew 模式——创建任务并打开控制台(含 URL、账号、密码)。/crew list:查看当前会话派生的子会话树。/crew remote:打开远程控制台(需先neyino service set remote true)。/lead:把本会话切换为 Captain(接单与汇报的唯一入口)。neyino node add/list/dispatch:把任务派到其他机器的节点上执行。
记忆(本地长期记忆)
记忆存本地 SQLite,会话中自动注入相关内容;知识图抽取与语义检索由已配置的模型驱动,未配模型时自动降级为词法检索。
/remember <内容>记一条 ·/recall <查询>语义搜索 ·/memory查看 ·/initialize <文件>从 AGENTS.md 等文件导入。neyino memory export:导出可分享的记忆片段(AGENTS.md 格式)。- 桌面版设置页有「记忆」管理与「记忆图书馆」(平面图 / 图谱 / 注入开关)。
Telegram Bot(手机指挥)
neyino bot telegram --token <BotFather 给的 token>
- 纯出站长轮询,无需公网端点;token 与配对信息存
~/.config/neyino/bot.json(仅本人可读)。 - 首条消息自动配对为 owner,此后只响应 owner,其他人静默忽略。
- 指令:
/new [目录]建会话 · 直接发文本派发任务 ·/sessions列会话 ·/stop中断 ·/watch [sid]完成时推送 ·/unwatch取消 ·/help。 /watch的列表持久化,重启后续看;完成通知在会话结束时推送到聊天。
网页控制台(浏览器指挥台)
neyino pair或 TUI/pair:生成一次性链接,用浏览器 / 手机打开控制台。- 控制台可列会话、发消息、看状态轮询;侧栏可切树状图(看清哪个是主会话、哪些是子会话)、行内改名、删除会话。
- 远程访问:
neyino service set remote true后经/crew remote或pair --remote外链打开。
常见问题
运行提示 "no available models" 或「连接模型服务后才能发送消息」?
/connect(登录 Neyino Console 或粘贴 nyi- 密钥,首次发送时也会自动弹出该窗口),或设置环境变量 NEYINO_API_KEY。连接后 /models 可看到全部模型(含 :free 免费档)。/wizard 怎么用?
wizard 不是斜杠命令,而是全局参数:任何子命令后加 --wizard(如 neyino run --wizard)会进入交互式命令构建器,逐步问答生成完整命令行。怎么开始免费用?
:free 后缀的模型免费(与 API 文档 的免费池同源,均不限量、限速 30 次/分)。付费模型按 token 扣积分,详见 API 文档计费说明。怎么更新到新版本?
命令太多记不住怎么办?
/ 有实时补全;Ctrl+P 打开命令面板(支持搜索);随时 neyino --help 与 neyino <子命令> --help。