用途
storage-zk 用于在使用 wiki CLI 管理个人 Wiki 笔记时提供操作指引,覆盖创建、链接、搜索、更新与导出笔记等场景。它同时说明 wiki CLI 与底层 zk 命令之间的关系与差异,帮助避免使用不存在的命令或遗漏必要参数。
主要能力
- 创建笔记:
wiki new --title "My Note",可用--print-path返回路径。 - 列出与搜索:
wiki list、wiki list --match="pattern",支持正则或纯文本。 - 查找反向链接:
wiki list --linked-by=<note-id>。 - 注册项目上下文:
wiki project add,用于将当前项目与笔记本关联。 - 发现当前笔记本:
wiki project discover。 - 导出格式:JSON、CSV(RFC 4180 兼容)、oneline、long、table(默认)。
使用方式
wiki CLI 会自动发现笔记本路径,搜索顺序为:环境变量 NOTEBOOK_PATH、祖先目录中的 .zk/config.toml、~/Notes/ 中的上下文注册表、全局回退 ~/.config/zk/config.toml(若定义了 notebook.dir)。因此通常无需手动指定路径。
若直接使用 zk,必须始终包含 -W 参数,例如 zk list -W /path/to/notebook --match="search",否则可能匹配到非预期的笔记本。
链接创建:zk 没有 zk link 命令,链接通过直接编辑 Markdown 文件完成,常用 wiki 风格 [[other-note-id]],也支持 Markdown 链接。ID 可以是去掉扩展名的文件名或 frontmatter 中的显式 ID。
导出:zk 没有 zk export 命令,使用 zk list -W <dir> --format=X > file 或 wiki list --format=X > file 重定向输出。CSV 需用正规 CSV 解析器(如 Python csv 模块)处理,因为标题可能含逗号。
批量导出前建议:备份笔记本、先用 --match="test" 小样本验证格式、确认导出内容范围、用 jq 校验 JSON 有效性,再移动到最终位置。
适用场景
- 需要以多种格式导出笔记。
- 希望项目与笔记本自动映射。
- 同时处理多个项目与笔记本。
- 需要查找反向链接或按模式检索笔记。
限制
- 不适用于编辑笔记本配置(参见 zk 的 config.toml 文档)。
- 不适用于高级模板(模板为 Handlebars,参见 zk 文档)。
- 不涉及 LSP 设置(语言服务器集成为独立配置)。
- zk 没有 link 或 export 命令,链接与导出需按上述方式手动或重定向完成。
- 其他过滤选项需通过
zk list --help确认,不同版本可能新增过滤器。