mcpField
W
workspace-init

workspace-init

github.com/willoscarAgent 工作流51740 次安装4 周前更新
代码仓库

关于 workspace-init

workspace-init 用于在指定目录初始化研究工作区，生成基础文件与目录。它默认只创建缺失内容，明确批准前不会覆盖已有文件，并将工作流选择留给后续路由步骤。

主要功能

  1. 01验证目标目录
  2. 02创建基础模板文件和目录
  3. 03默认保留现有文件
  4. 04检查核心文件及 CSV 架构
  5. 05将工作区交由工作流路由

适用场景

  1. 01为研究项目创建工作区
  2. 02检查并补齐部分初始化的工作区

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/willoscar/research-units-pipeline-skills --skill workspace-init

安装后在 Claude Code 中输入/workspace-init确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

assets/workspace-template/
CHECKPOINTS.md
DECISIONS.md
GOAL.md
queries.md
STATUS.md
UNITS.csv
assets/workspace-template/citations/
ref.bib
verified.jsonl
assets/workspace-template/outline/
claim_evidence_matrix.md
mapping.tsv
outline.yml
taxonomy.yml
assets/workspace-template/output/
DRAFT.md
QUALITY_GATE.md
RUN_ERRORS.md
SNAPSHOT.md
assets/workspace-template/papers/
core_set.csv
paper_notes.jsonl
papers_dedup.jsonl
papers_raw.jsonl
scripts/
run.py

详细介绍

Workspace 初始化

初始化是一条边界：它会创建由 Workspace 管理的状态，并且不会更改现有状态，除非操作员明确决定覆盖。 它不会选择 Workflow，也不会执行 Unit。

输入

  • workspaces/<name>/ 下的目标目录。
  • 可选的明确覆盖决定。

输出

  • STATUS.md、CHECKPOINTS.md、UNITS.csv 和 DECISIONS.md。
  • GOAL.md 和 queries.md。
  • papers/、outline/、citations/ 和 output/ 目录。

步骤

1. 验证目标位置

解析目标路径并拒绝仓库根目录。在决定初始化是缺失、部分完成还是已完成之前，检查现有文件。绝不能根据部分 Workspace 推断已获覆盖许可。

完成标准：目标是 Workspace 路径，并且已知晓所有可能被替换的现有文件。

2. 实例化基础模板

将仓库自有模板复制到目标位置。默认仅创建缺失项；只有在明确决定替换后，才使用 --overwrite。

完成标准：所有缺失的基础文件和目录均已实例化，且未经明确许可未替换任何现有文件。

3. 验证核心约定

确认 STATUS.md、UNITS.csv、CHECKPOINTS.md 和 DECISIONS.md 均存在。解析 UNITS.csv 表头；如果 CSV 格式错误，应拒绝处理，而不是留下表面上已初始化的 Workspace。

完成标准：四个核心文件均存在，且 UNITS.csv 符合所需架构。

4. 移交给 Workflow 绑定

将 Workflow 选择和 Pipeline 专属 Unit 实例化交由 pipeline-router 或 Pipeline 适配器处理。通用模板不能证明 Goal 已完成路由。

完成标准：无需聊天记录中的任何状态，即可将 Workspace 传递给路由器。

上下文指引

  • 仅在检查或更改基础模板约定时，读取 assets/workspace-template/。
  • 仅在绑定 Workflow 后，读取选定的 pipelines/*.pipeline.md。
  • 如果用户要求在初始化后继续操作，请使用 research-pipeline-runner。

脚本

快速开始
uv run python .codex/skills/workspace-init/scripts/run.py \
  --workspace workspaces/<name>
所有选项
  • --workspace <path>：目标 Workspace。
  • --overwrite：在明确批准后替换现有的模板自有文件。
  • --unit-id、--inputs、--outputs、--checkpoint：与 Pipeline-runner 兼容的参数。
示例

使用前先检查接口：

uv run python .codex/skills/workspace-init/scripts/run.py --help

仅在明确决定重置后替换模板文件：

uv run python .codex/skills/workspace-init/scripts/run.py \
  --workspace workspaces/<name> \
  --overwrite

故障排除

  • 默认情况下，现有文件保持不变。这是预期的幂等行为，并非初始化失败。
  • 绝不要将脚本指向仓库根目录；请使用 workspaces/<name>/。

评论

支持 Markdown