add-tool

分类: 工具与效率 | 上传者: yelmuratoff | 下载: 0 | 版本: v1.0（最新）

向 AgentSync 的同步引擎添加对新 AI 编码工具的支持。在添加新工具、集成新的 AI 助手或要求支持新的 IDE/编辑器时使用。 --- # 添加新工具支持向 AgentSync 添加新的 AI 编码工具，以便 `agentsyncsync` 向其分发指令。 ## 步骤 1. **研究现有工具配置** — 阅读 `.ai/src/tools/claude.yaml` 或 `.ai/src/tools/cursor.yaml` 以了解模式。 2. **创建工具 YAML** — 将 `.ai/src/tools/_TEMPLATE.yaml` 复制到 `.ai/src/tools/<tool>.yaml`。 3. **配置目标** — 定义每个内容类型的位置： - `agents` → 主指令文件 - `rules` → 规则目录或合并文件 - `skills` → 技能目录（如果支持） - `commands` → 命令目录（如果支持） - `subagents` → 代理目录（如果支持） - `settings` / `mcp` → 特定于工具的配置文件 4. **处理格式差异** — 检查工具是否需要： - `.mdc` 扩展名而不是 `.md`（光标） - Frontmatter 换行（光标规则为 `alwaysApply: true`） - 内联技能/规则合并到代理文件中 (`inline_into_agents: true`) - 规则目录中 AGENTS.md 内容的 `00-context.md` 模式 - 代理的 TOML 格式 (Codex) 5. **添加同步逻辑** - 如果工具需要自定义转换，请在“lib/sync.sh”中添加处理程序（查找“sync_tool”函数和现有的特定于工具的块）。 6. **添加到 `lib/templates/tools/`** — 创建默认的 YAML 配置。 7. **编写测试** — 在以下位置添加断言： - `tests/sync.bats` — 验证输出文件是否存在 - `tests/sync_options.bats` — 验证 `--only`/`--skip` 过滤 - `tests/check.bats` — 验证 `agentsync check` 检测到偏差 8. **在所有平台上进行测试** — 在本地运行 `bats tests/sync.bats`，验证 CI 通过。 ## 陷阱 - 每个工具都有其怪癖。阅读该工具的文档以了解其需要说明文件的位置。 - 某些工具共享输出路径（例如，Copilot 使用 `.github/`）。检查与现有工具的碰撞。 - 自定义 YAML 解析器不支持数组或多行 YAML 块 — 也保留

更新日志: Source: GitHub https://github.com/yelmuratoff/agent_sync

目录结构

当前层级: tree/main/.ai/src/skills/add-tool/

📄 SKILL.md 2.4 KB

SKILL.md

---
name: add-tool
description: >
  Add support for a new AI coding tool to AgentSync's sync engine.
  USE WHEN adding a new tool, integrating a new AI assistant, or asked to support a new IDE/editor.
---

# Add New Tool Support

Add a new AI coding tool to AgentSync so `agentsync sync` distributes instructions to it.

## Steps

1. **Study an existing tool config** — Read `.ai/src/tools/claude.yaml` or `.ai/src/tools/cursor.yaml` for the pattern.
2. **Create the tool YAML** — Copy `.ai/src/tools/_TEMPLATE.yaml` to `.ai/src/tools/<tool>.yaml`.
3. **Configure targets** — Define where each content type goes:
   - `agents` → main instructions file
   - `rules` → rules directory or merged file
   - `skills` → skills directory (if supported)
   - `commands` → commands directory (if supported)
   - `subagents` → agents directory (if supported)
   - `settings` / `mcp` → tool-specific config files
4. **Handle format differences** — Check if the tool needs:
   - `.mdc` extension instead of `.md` (Cursor)
   - Frontmatter wrapping (`alwaysApply: true` for Cursor rules)
   - Inline skill/rule merging into agents file (`inline_into_agents: true`)
   - `00-context.md` pattern for AGENTS.md content in rules dir
   - TOML format for agents (Codex)
5. **Add sync logic** — If the tool needs custom transformation, add a handler in `lib/sync.sh` (look for the `sync_tool` function and existing tool-specific blocks).
6. **Add to `lib/templates/tools/`** — Create a default YAML config.
7. **Write tests** — Add assertions in:
   - `tests/sync.bats` — verify output files exist
   - `tests/sync_options.bats` — verify `--only`/`--skip` filtering
   - `tests/check.bats` — verify `agentsync check` detects drift
8. **Test on all platforms** — Run `bats tests/sync.bats` locally, verify CI passes.

## Gotchas

- Every tool has quirks. Read the tool's docs for where it expects instruction files.
- Some tools share output paths (e.g., Copilot uses `.github/`). Check for collisions with existing tools.
- The custom YAML parser doesn't support arrays or multiline YAML blocks — keep tool configs flat.
- Don't forget to add the tool to `lib/helpers/list.sh` so `agentsync list` shows it.
- Tool names must be lowercase and match the YAML filename (e.g., `claude.yaml` → tool name `claude`).
- The `example/` directory output is gitignored — after adding a tool, run sync in `example/` to verify output.

登录后下载/点赞/收藏 ❤ 6 | ★ 0

add-tool

目录结构

SKILL.md

举报内容

提示