使用 craft CLI 工具管理 Craft文档,支持列表、搜索、创建、更新、删除,以及导出为 JSON、表格或 Markdown 格式。
CLI 技能, 通过 CLI 工具与 CLI 文档交互
功能概述
CLI 技能, 通过 CLI 工具与 CLI 文档交互是一项面向实际任务的技能,主要用于快速, 节能, LLM 准备;手提CLI 二进制应安装在 /usr/ local/ bin/ craft;
核心要点
- 如果没有安装的话:. two Cr。
- 它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。
- 使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。
使用与执行
该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;
结果检查与注意事项
若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
Craft CLI 技能
通过 craft CLI 工具与 Craft 文档交互。快速、令牌高效、面向大语言模型(LLM)优化。
安装
craft CLI 二进制文件应安装在 /usr/local/bin/craft 路径下。
若尚未安装,请执行:
curl -L https://github.com/nerveband/craft-cli/releases/download/v1.0.0/craft-darwin-arm64 -o craft chmod +x craft sudo mv craft /usr/local/bin/
配置
当前可用两个 Craft 空间:
wavedepth 空间(业务用途)
~/clawd/skills/craft-cli/craft config set-api https://connect.craft.do/links/5VruASgpXo0/api/v1
个人空间
~/clawd/skills/craft-cli/craft config set-api https://connect.craft.do/links/HHRuPxZZTJ6/api/v1
快速切换(辅助脚本)
# 切换至 wavedepth 空间 ~/clawd/skills/craft-cli/craft-helper.sh wavedepth # 切换至个人空间 ~/clawd/skills/craft-cli/craft-helper.sh personal # 查看当前空间 ~/clawd/skills/craft-cli/craft-helper.sh current
查看当前配置:
~/clawd/skills/craft-cli/craft config get-api
命令
列出文档
# JSON 格式(默认,适用于 LLM) ~/clawd/skills/craft-cli/craft list # 人类可读的表格格式 ~/clawd/skills/craft-cli/craft list --format table # Markdown 格式 ~/clawd/skills/craft-cli/craft list --format markdown
搜索文档
# 搜索文档 ~/clawd/skills/craft-cli/craft search "查询关键词" # 表格格式输出结果 ~/clawd/skills/craft-cli/craft search "查询词" --format table
获取文档
# 根据文档 ID 获取(JSON 格式) ~/clawd/skills/craft-cli/craft get# 保存为文件 ~/clawd/skills/craft-cli/craft get --output document.md # 指定其他格式 ~/clawd/skills/craft-cli/craft get --format markdown
创建文档
# 仅指定标题创建 ~/clawd/skills/craft-cli/craft create --title "我的新文档" # 从文件创建 ~/clawd/skills/craft-cli/craft create --title "我的文档" --file content.md # 内联 Markdown 创建 ~/clawd/skills/craft-cli/craft create --title "速记笔记" --markdown "# Hello\nThis is content" # 创建为另一文档的子文档 ~/clawd/skills/craft-cli/craft create --title "子文档" --parent
更新文档
# 更新标题 ~/clawd/skills/craft-cli/craft update--title "新标题" # 从文件更新内容 ~/clawd/skills/craft-cli/craft update --file updated-content.md # 使用内联 Markdown 更新 ~/clawd/skills/craft-cli/craft update --markdown "# Updated\nNew content" # 同时更新标题与内容 ~/clawd/skills/craft-cli/craft update --title "新标题" --file content.md
删除文档
~/clawd/skills/craft-cli/craft delete
信息类命令
# 显示 API 信息及最近文档 ~/clawd/skills/craft-cli/craft info # 列出所有可用文档 ~/clawd/skills/craft-cli/craft docs
版本
~/clawd/skills/craft-cli/craft version
输出格式
- json(默认):机器可读 JSON 格式,适用于 LLM 和脚本处理
- table:人类可读的表格格式
- markdown:Markdown 格式化输出
可通过配置设置默认格式,或在每条命令中使用 --format 参数临时指定。
API URL 覆盖
可在任意命令中临时覆盖已配置的 API URL:
~/clawd/skills/craft-cli/craft list --api-url https://connect.craft.do/links/ANOTHER_LINK/api/v1
错误处理
CLI 提供清晰的错误信息,并返回对应退出码:
- 退出码 0:成功
- 退出码 1:用户错误(输入无效、参数缺失等)
- 退出码 2:API 错误(服务端问题)
- 退出码 3:配置错误
常见错误提示:
authentication failed. Check API URL— API URL 无效或未授权resource not found— 文档 ID 不存在rate limit exceeded. Retry later— 请求频率超限no API URL configured. Run 'craft config set-api— 缺少 API URL 配置' first
使用示例
工作流:列出与搜索
# 列出 wavedepth 空间中的全部文档 ~/clawd/skills/craft-cli/craft config set-api https://connect.craft.do/links/5VruASgpXo0/api/v1 ~/clawd/skills/craft-cli/craft list --format table # 搜索特定文档 ~/clawd/skills/craft-cli/craft search "proposal" --format table
工作流:创建与更新
# 创建新文档 ~/clawd/skills/craft-cli/craft create --title "项目笔记" --markdown "# 初始笔记\n\n从这里开始。" # 从输出中获取文档 ID,然后更新 ~/clawd/skills/craft-cli/craft update--title "更新后的项目笔记" # 验证更新结果 ~/clawd/skills/craft-cli/craft get --format markdown
工作流:导出文档
# 获取指定文档并保存为文件 ~/clawd/skills/craft-cli/craft get--output exported-notes.md
LLM 集成
# 以 JSON 格式获取全部文档(可管道传递至后续处理)
~/clawd/skills/craft-cli/craft list | jq '.[] | {id, title}'
# 搜索并提取特定字段
~/clawd/skills/craft-cli/craft search "meeting" | jq '.[].title'
提示
- 默认使用 JSON 格式 供 LLM 消费(该格式即为默认)
- 向人类展示结果时使用 table 格式
- 执行操作前请检查配置:
craft config get-api - 使用
craft config set-api快速切换空间 - 如需临时覆盖 API URL,请使用
--api-url参数而非修改全局配置
GitHub 仓库
源代码与文档地址:https://github.com/nerveband/craft-cli
版本
当前版本:1.6.0
热门AI工具
相关专题
本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。
0
2026.11.17
本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。
0
2026.11.17
本专题整理GoFrame框架的入门知识,从模块化设计理念、环境准备到跑通第一个Web服务,讲清目录分层、配置加载、日志与中间件的用法,并对比Gin、Go-Zero的差异,帮助Go开发者建立整体认知。
0
2026.11.17
SQLAlchemy 一对多关系怎么建立?本专题整理父子表外键、relationship 双向映射、关联查询、级联删除和加载优化等相关文章,帮助你理解并实现常见的 ORM 关系建模。
0
2026.11.17
SQLAlchemy 如何增删改查?本专题整理 ORM 新增记录、条件查询、更新和删除、Session 事务提交与批量处理等实用文章,帮助你掌握 Python 数据库操作流程。
0
2026.11.17
SQLAlchemy ORM 模型怎么写?本专题整理模型类定义、Mapped 字段映射、主键与约束、表结构创建和常见报错的相关文章,帮助你从基础配置到实际建模逐步掌握 SQLAlchemy。
0
2026.11.17
本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。
0
2026.11.12
本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。
0
2026.11.12
本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。
0
2026.11.12
热门下载
相关下载
精品课程
共6课时 | 12.1万人学习
共79课时 | 161.9万人学习
共6课时 | 54.8万人学习
最新文章