Skip to content

示例与模板

仓库 samples/ 提供可直接复制到工作区或参考的示例。每个示例聚焦一个能力,按顺序复制到自己的项目即可。

TIP

第一次验证建议先跑 Workspace,然后按需要选 Automations / Hooks / Skills。

配置示例

名称用途仓库链接
Workspace一个完整的 workspace 模板,含 start.shconfig.template.json、可选 OpenSandbox 启动脚本samples/workspace

工作区行为示例

名称用途仓库链接
Automations · example-local-task本地任务模板(task.md + workflow.mdsamples/automations
Hooks · windowsPowerShell hooks(拦截危险 Exec、记录文件写入)samples/hooks/windows
Hooks · linuxBash hooks(拦截危险 Exec、记录文件写入)samples/hooks/linux

Skills 模板

名称用途仓库链接
dev-guide项目开发规范示例,包含模块开发参考文档samples/skills/dev-guide
feature-workflow大型功能开发工作流,用于拆解、实现、验证复杂需求samples/skills/feature-workflow
dotcraft-llm-error-diagnosisLLM / agent / 工具调用 / session 失败时的只读诊断流程samples/skills/llm-error-diagnosis

Plugins 模板

仓库 samples/plugins/ 收录可参考的 DotCraft 插件骨架。开发自定义插件时,建议先用内置 $plugin-creator 生成结构,再参考这些示例完善 manifest、tool 进程和说明。

常见使用流程

Workspace

bash
cd /path/to/your-project
dotcraft setup --language Chinese --provider-mode create \
  --provider-protocol anthropic --provider-id anthropic \
  --model claude-sonnet-4-5 --api-key <anthropic-api-key> \
  --profile developer

这是第一次使用 DotCraft 最稳的路径。完成后,.craft/ 包含工作区配置和 bootstrap 文件。如果你想要一个可复用的源码工作区或长期运行在服务器上的工作区,再使用 samples/workspace

bash
cd samples/workspace
mkdir -p .craft
cp config.template.json .craft/config.json
bash start.sh

模板里最常需要修改的字段:

字段建议
DashBoard.Host / DashBoard.Port按本机绑定地址或端口调整
Tools.Sandbox.Enabled仅在实际运行 OpenSandbox 时开启
Tools.Sandbox.Domain改成你自己的 OpenSandbox 地址,不要和 Dashboard 端口冲突
Tools.Sandbox.Image替换成你希望 sandbox 使用的容器镜像

Hooks

samples/hooks/<platform>/ 内容复制到工作区:

text
<workspace>/.craft/hooks.json
<workspace>/.craft/hooks/...

Linux / macOS 下记得给脚本加可执行权限:

bash
chmod +x hooks/*.sh

WARNING

创建或修改 Hooks 后,需要重启 DotCraft 才能生效。

不想手写时,可在对话中描述需求,让内置 create-hooks skill 帮你生成。

Skills

text
.craft/skills/dev-guide/
.craft/skills/feature-workflow/

复制后保留结构,逐步用项目自己的术语、路径和验收标准替换。

故障排查

示例配置复制后不生效

确认配置在当前工作区 .craft/config.json,并重启相关 Host。启动级字段不会自动热更新,详见 设置生效层级

找不到示例源码文件

确认你在 DotCraft 仓库根目录。示例源码位于 samples/,文档站页面位于 docs/

不知道先跑哪个示例

先按照 快速开始 完成 Desktop + 模型配置,再按需要选择本页对应的示例。

相关入口

Apache License 2.0