Lionote CLI 使用说明
Lionote CLI 是随 Lionote 桌面版提供的命令行工具。它让用户、脚本和具备本机终端权限的 AI Agent 可以读取、搜索、新建和修改本地笔记。
如何使用
- 你可以直接告诉你的Agent: “帮我用Lionote创建一篇名字为xxxx的新笔记",如果你的 Agent 够聪明,他会自动查找到本地的Lionote CLI。
- 如果你的 Agent 无法自动识别的到本地的 Lionote CLI,你可以参考下面的 【下载 Lionote Skill】,并手动放到 Agent的 SKILLS目录中。
下载 Lionote Skill
下载后,创建名为 lionote 的子目录,并将文件保存为 SKILL.md。重新启动或新建 Agent 会话后,Agent 才会加载该 Skill。
- Codex(Windows):
C:\Users\<用户名>\.codex\skills\lionote\SKILL.md - Codex(macOS/Linux):
~/.codex/skills/lionote/SKILL.md - Claude Code(当前项目):
<项目目录>/.claude/skills/lionote/SKILL.md - Claude Code(所有项目):
~/.claude/skills/lionote/SKILL.md
其他支持 Agent Skills 的工具也遵循相同结构:<该 Agent 的 skills 目录>/lionote/SKILL.md。Skill 只告诉 Agent 如何安全调用 CLI;使用前仍需下载并安装 Lionote,且 lionote-cli 必须能通过系统 PATH 执行。
开始使用
安装 Lionote 桌面版后,在新的终端窗口中运行:
lionote-cli --helpWindows 上也可以使用:
lionote-cli.exe --help命令应通过系统 PATH 调用,不要在脚本或 Agent 提示词中写死软件安装路径。若刚完成安装,请重新打开 PowerShell、Codex 或其他 Agent 会话,使其获得新的 PATH。
数据目录与数据库
CLI 会尝试自动定位 Lionote 数据目录;定位失败时,可用 --data-dir 显式指定。数据目录中包含 db.json 和 entity 文件夹。
lionote-cli --data-dir "<Lionote 数据目录>" list --json登录账号后,数据库可能命名为 <手机号>-db.json。存在多个账号时,可以额外指定数据库:
lionote-cli --data-dir "<Lionote 数据目录>" --db "<手机号>-db.json" list --json先检查本机状态
lionote-cli --version
lionote-cli capabilities --json
lionote-cli doctor --jsondoctor 会显示正在使用的数据目录、数据库、desktopRunning 和 writeSafe。写操作以 writeSafe 为准:只有返回 writeSafe: true 时才执行写入;desktopRunning 仅表示桌面端是否运行,不代表禁止写入。
常用命令
示例中的 <noteId>、<parentNoteId> 和 <Lionote 数据目录> 需要替换为实际值。建议脚本和 Agent 始终使用命令级 --json,便于稳定解析结果和错误。
列出、读取与搜索
lionote-cli list --json
lionote-cli read <noteId> --json
lionote-cli search --query "会议" --limit 20 --jsonsearch 会搜索笔记标题、摘要和标签。需要纯正文时,可使用 read <noteId> --plain。
新建笔记
lionote-cli create --title "AI 生成的笔记" --content "这里是正文" --json
lionote-cli create --parent <parentNoteId> --title "子笔记" --content "正文" --json长内容可以从文件或标准输入读取:
lionote-cli create --title "导入内容" --file "./note.md" --json修改或追加笔记
lionote-cli update <noteId> --title "新的标题" --json
lionote-cli update <noteId> --content "新的正文" --json
lionote-cli update <noteId> --append --content "追加内容" --jsonupdate 默认会替换传入的正文;需要保留原文时请使用 --append。同样可以通过 --file "./note.md" 或 --file - 传入较长内容。
其他可用操作
CLI 还支持通过高层 JSON 生成思维导图和流程图,并维护标签、收藏和双链:
lionote-cli mind set --id <noteId> --data "<思维导图 JSON>" --json
lionote-cli flow set --id <noteId> --data "<流程图 JSON>" --json
lionote-cli tag add --id <noteId> --name "项目" --json
lionote-cli fav set --id <noteId> --json
lionote-cli link add --id <sourceNoteId> --target <targetNoteId> --json执行 lionote-cli --help 可以查看全部命令和参数。
AI Agent 调用规则
- 先执行
lionote-cli capabilities --json了解能力,再执行lionote-cli doctor --json。 - 只有
writeSafe=true时才创建、追加或修改笔记;desktopRunning仅作状态提示。 - 修改已有笔记前先执行
read <noteId> --json,确认目标和当前内容。 - 能追加时优先使用
update <noteId> --append;替换整篇正文前,应向用户明确说明这是覆盖式修改。 - 使用稳定命令名
lionote-cli,不要猜测安装目录或数据目录;自动定位失败后再传入--data-dir。
CLI 负责实际执行命令。Skill 或 Agent 提示词只能帮助 AI 发现和正确调用 CLI,不能替代本机已安装且可访问的 CLI。
