核心用法
craft CLI 是一款专为 Craft.do 文档生态打造的命令行管理工具,旨在解决 LLM 与结构化文档交互的痛点。其核心设计围绕「机器优先、人类友好」的双模输出:默认 JSON 格式供脚本和 LLM 消费,同时提供 --format table/markdown 满足人工阅读需求。
主要功能模块
- 空间管理:通过
config set-api绑定不同 Craft 空间(如 wavedepth 商务空间与个人空间),配合craft-helper.sh实现秒级切换 - 文档 CRUD:完整的增删改查能力,
create支持从文件、内联 Markdown、父文档嵌套三种方式创建 - 搜索与导出:全文搜索匹配,支持一键导出为本地 Markdown 文件
- LLM 集成:JSON 管道输出天然适配
jq处理,便于自动化工作流构建
显著优点
1. Token 效率优化:JSON 原生输出避免 HTML 解析噪声,显著降低 LLM 上下文消耗
2. 多空间隔离:单 CLI 实例管理多个 Craft 工作区,通过 API URL 切换实现数据隔离
3. 错误码体系化:0-3 分级退出码(成功/用户错误/API 错误/配置错误),便于脚本异常捕获
4. 格式灵活:同一命令输出可在机器可读与人工可读间无缝切换
潜在局限
- 依赖 Craft.do 生态:非通用 Markdown 工具,绑定特定云服务
- API 稳定性风险:基于未公开的
/api/v1端点,未来可能随官方调整而失效 - 无离线能力:纯在线工具,网络中断即不可用
- 权限粒度粗:空间级 API Token,无法细化到文档级权限
适合人群
- 需要将 Craft 文档纳入自动化工作流的知识工作者
- 频繁在多个 Craft 空间切换的跨团队协作者
- 构建 RAG 或文档代理系统的开发者
常规风险
- Token 泄露:API URL 包含完整访问凭证,误提交至版本控制将导致数据泄露
- 误操作覆盖:
update命令无版本回滚机制,错误--file参数可能永久丢失内容 - Rate Limit 中断:高频批量操作可能触发限流,需实现指数退避重试