From 36bec90d45c0b6ce70ec1a8b3f624bd9c68c5d54 Mon Sep 17 00:00:00 2001 From: konstapukarifastnetfi Date: Sun, 7 Jun 2026 08:25:58 +0300 Subject: [PATCH] docs: align command docs with shipped behavior (#2169) - multi-{plan,execute,backend,frontend,workflow}.md: add an in-file prerequisite note for the external ccg-workflow runtime. README.md already warns these commands need codeagent-wrapper and the .ccg prompt tree, but users meeting them via the installed slash commands never see the README; the commands-core module still installs all five by default - quality-gate.md: describe what scripts/hooks/quality-gate.js actually does. The doc advertised '/quality-gate [path] [--fix] [--strict]' with lint/type checks, but the script reads the file path from hook stdin JSON, toggles behavior via ECC_QUALITY_GATE_FIX / ECC_QUALITY_GATE_STRICT env vars, and runs formatters only (Biome/Prettier, gofmt, ruff format) - claude-devfleet SKILL.md: add a Setup section pointing at the DevFleet server repository (github.com/LEC-AI/claude-devfleet, already disclosed in mcp-configs/mcp-servers.json) plus the SECURITY.md port-verification note; the skill previously assumed a running instance with no way to obtain one - regenerate docs/COMMAND-REGISTRY.json for the quality-gate description --- commands/multi-backend.md | 2 ++ commands/multi-execute.md | 2 ++ commands/multi-frontend.md | 2 ++ commands/multi-plan.md | 2 ++ commands/multi-workflow.md | 2 ++ commands/quality-gate.md | 50 ++++++++++++++++++--------- docs/COMMAND-REGISTRY.json | 8 ++--- docs/ja-JP/commands/multi-backend.md | 2 ++ docs/ja-JP/commands/multi-execute.md | 2 ++ docs/ja-JP/commands/multi-frontend.md | 2 ++ docs/ja-JP/commands/multi-plan.md | 2 ++ docs/ja-JP/commands/multi-workflow.md | 2 ++ docs/tr/commands/multi-backend.md | 2 ++ docs/tr/commands/multi-execute.md | 2 ++ docs/tr/commands/multi-frontend.md | 2 ++ docs/tr/commands/multi-plan.md | 2 ++ docs/tr/commands/multi-workflow.md | 2 ++ docs/zh-CN/commands/multi-backend.md | 2 ++ docs/zh-CN/commands/multi-execute.md | 2 ++ docs/zh-CN/commands/multi-frontend.md | 2 ++ docs/zh-CN/commands/multi-plan.md | 2 ++ docs/zh-CN/commands/multi-workflow.md | 2 ++ skills/claude-devfleet/SKILL.md | 10 +++++- 23 files changed, 87 insertions(+), 21 deletions(-) diff --git a/commands/multi-backend.md b/commands/multi-backend.md index 2eb72a6d..95cc95d8 100644 --- a/commands/multi-backend.md +++ b/commands/multi-backend.md @@ -6,6 +6,8 @@ description: Run a backend-focused multi-model workflow for APIs, algorithms, da Backend-focused workflow (Research → Ideation → Plan → Execute → Optimize → Review), Codex-led. +> **Prerequisite:** Requires the external `ccg-workflow` runtime, which is **not** part of the base ECC install. Initialize it with `npx ccg-workflow` to provision `~/.claude/bin/codeagent-wrapper` and the `~/.claude/.ccg/prompts/*` role files this command depends on. Without that runtime, this command will not run correctly. + ## Usage ```bash diff --git a/commands/multi-execute.md b/commands/multi-execute.md index 57ac4486..167a9b55 100644 --- a/commands/multi-execute.md +++ b/commands/multi-execute.md @@ -6,6 +6,8 @@ description: Execute a multi-model implementation plan while preserving Claude a Multi-model collaborative execution - Get prototype from plan → Claude refactors and implements → Multi-model audit and delivery. +> **Prerequisite:** Requires the external `ccg-workflow` runtime, which is **not** part of the base ECC install. Initialize it with `npx ccg-workflow` to provision `~/.claude/bin/codeagent-wrapper` and the `~/.claude/.ccg/prompts/*` role files this command depends on. Without that runtime, this command will not run correctly. + $ARGUMENTS --- diff --git a/commands/multi-frontend.md b/commands/multi-frontend.md index 61f7c9a1..fc1c402d 100644 --- a/commands/multi-frontend.md +++ b/commands/multi-frontend.md @@ -6,6 +6,8 @@ description: Run a frontend-focused multi-model workflow for components, layouts Frontend-focused workflow (Research → Ideation → Plan → Execute → Optimize → Review), Gemini-led. +> **Prerequisite:** Requires the external `ccg-workflow` runtime, which is **not** part of the base ECC install. Initialize it with `npx ccg-workflow` to provision `~/.claude/bin/codeagent-wrapper` and the `~/.claude/.ccg/prompts/*` role files this command depends on. Without that runtime, this command will not run correctly. + ## Usage ```bash diff --git a/commands/multi-plan.md b/commands/multi-plan.md index 592ebff8..b50912b1 100644 --- a/commands/multi-plan.md +++ b/commands/multi-plan.md @@ -6,6 +6,8 @@ description: Create a multi-model implementation plan without modifying producti Multi-model collaborative planning - Context retrieval + Dual-model analysis → Generate step-by-step implementation plan. +> **Prerequisite:** Requires the external `ccg-workflow` runtime, which is **not** part of the base ECC install. Initialize it with `npx ccg-workflow` to provision `~/.claude/bin/codeagent-wrapper` and the `~/.claude/.ccg/prompts/*` role files this command depends on. Without that runtime, this command will not run correctly. + $ARGUMENTS --- diff --git a/commands/multi-workflow.md b/commands/multi-workflow.md index 32687ff9..5458945c 100644 --- a/commands/multi-workflow.md +++ b/commands/multi-workflow.md @@ -6,6 +6,8 @@ description: Run a full multi-model development workflow with research, planning Multi-model collaborative development workflow (Research → Ideation → Plan → Execute → Optimize → Review), with intelligent routing: Frontend → Gemini, Backend → Codex. +> **Prerequisite:** Requires the external `ccg-workflow` runtime, which is **not** part of the base ECC install. Initialize it with `npx ccg-workflow` to provision `~/.claude/bin/codeagent-wrapper` and the `~/.claude/.ccg/prompts/*` role files this command depends on. Without that runtime, this command will not run correctly. + Structured development workflow with quality gates, MCP services, and multi-model collaboration. ## Usage diff --git a/commands/quality-gate.md b/commands/quality-gate.md index 2cccb4cb..01ef940b 100644 --- a/commands/quality-gate.md +++ b/commands/quality-gate.md @@ -1,33 +1,51 @@ --- -description: Run the ECC quality pipeline for a file or project scope and report remediation steps. +description: Run the ECC formatter quality gate for a single file and report remediation steps. --- # Quality Gate Command -Run the ECC quality pipeline on demand for a file or project scope. +Operator entry point for the formatter quality gate that normally runs as the +`post:quality-gate` PostToolUse hook (`scripts/hooks/quality-gate.js`). + +## How it actually works + +The gate is a single-file formatter check driven by hook input, not CLI flags: + +- The script reads the target from the hook's stdin JSON + (`tool_input.file_path`); it does not take a path argument. +- Behavior toggles are environment variables: + - `ECC_QUALITY_GATE_FIX=true` - apply formatting fixes instead of check-only + - `ECC_QUALITY_GATE_STRICT=true` - log formatter failures as gate failures +- Coverage by file type: + - `.ts/.tsx/.js/.jsx/.json/.md` - Biome `check` or Prettier `--check`, + whichever the project ships (JS/TS under Biome is skipped here because + `post-edit-format` already runs `biome check --write`) + - `.go` - `gofmt` + - `.py` - `ruff format` +- Lint and type checks are not part of this gate. Use the `verification-loop` + skill or the language verification skills for lint/type/test pipelines. ## Usage -`/quality-gate [path|.] [--fix] [--strict]` +To run the gate manually against one file, pipe hook-style JSON into the +script (set the env toggles first if you want fix or strict behavior): -- default target: current directory (`.`) -- `--fix`: allow auto-format/fix where configured -- `--strict`: fail on warnings where supported +```bash +echo '{"tool_input":{"file_path":"src/example.ts"}}' \ + | ECC_QUALITY_GATE_FIX=true node scripts/hooks/quality-gate.js +``` -## Pipeline - -1. Detect language/tooling for target. -2. Run formatter checks. -3. Run lint/type checks when available. -4. Produce a concise remediation list. +Then report formatter findings and concrete remediation steps. ## Notes -This command mirrors hook behavior but is operator-invoked. +Hook wiring lives in `hooks/hooks.json` (`post:quality-gate`, profiles +`standard`/`strict` via `run-with-flags.js`). ## Arguments $ARGUMENTS: -- `[path|.]` optional target path -- `--fix` optional -- `--strict` optional + +- `[path]` optional file to check. The script itself takes no CLI + arguments - when a path is given, substitute it as `tool_input.file_path` + in the stdin JSON shown above before running the command diff --git a/docs/COMMAND-REGISTRY.json b/docs/COMMAND-REGISTRY.json index 92f16fee..e25a2d78 100644 --- a/docs/COMMAND-REGISTRY.json +++ b/docs/COMMAND-REGISTRY.json @@ -637,8 +637,8 @@ }, { "command": "quality-gate", - "description": "Run the ECC quality pipeline for a file or project scope and report remediation steps.", - "type": "general", + "description": "Run the ECC formatter quality gate for a single file and report remediation steps.", + "type": "testing", "primaryAgents": [], "allAgents": [], "skills": [], @@ -863,12 +863,12 @@ "statistics": { "byType": { "build": 2, - "general": 8, + "general": 7, "orchestration": 6, "planning": 2, "refactoring": 1, "review": 9, - "testing": 51 + "testing": 52 }, "topAgents": [ { diff --git a/docs/ja-JP/commands/multi-backend.md b/docs/ja-JP/commands/multi-backend.md index 8c72936a..17ce771f 100644 --- a/docs/ja-JP/commands/multi-backend.md +++ b/docs/ja-JP/commands/multi-backend.md @@ -2,6 +2,8 @@ バックエンド中心のワークフロー(調査 → アイデア創出 → 計画 → 実装 → 最適化 → レビュー)、Codex主導。 +> **前提条件:** このコマンドは外部の `ccg-workflow` ランタイムを必要とします。これはベースの ECC インストールには**含まれていません**。`npx ccg-workflow` を実行して初期化し、このコマンドが依存する `~/.claude/bin/codeagent-wrapper` と `~/.claude/.ccg/prompts/*` ロールファイルをプロビジョニングしてください。このランタイムがないと、このコマンドは正しく動作しません。 + ## 使用方法 ```bash diff --git a/docs/ja-JP/commands/multi-execute.md b/docs/ja-JP/commands/multi-execute.md index d7b1f73c..393b8f1b 100644 --- a/docs/ja-JP/commands/multi-execute.md +++ b/docs/ja-JP/commands/multi-execute.md @@ -2,6 +2,8 @@ マルチモデル協調実装 - 計画からプロトタイプを取得 → Claudeがリファクタリングして実装 → マルチモデル監査と配信。 +> **前提条件:** このコマンドは外部の `ccg-workflow` ランタイムを必要とします。これはベースの ECC インストールには**含まれていません**。`npx ccg-workflow` を実行して初期化し、このコマンドが依存する `~/.claude/bin/codeagent-wrapper` と `~/.claude/.ccg/prompts/*` ロールファイルをプロビジョニングしてください。このランタイムがないと、このコマンドは正しく動作しません。 + $ARGUMENTS --- diff --git a/docs/ja-JP/commands/multi-frontend.md b/docs/ja-JP/commands/multi-frontend.md index 50933946..3d2360b5 100644 --- a/docs/ja-JP/commands/multi-frontend.md +++ b/docs/ja-JP/commands/multi-frontend.md @@ -2,6 +2,8 @@ フロントエンド中心のワークフロー(調査 → アイデア創出 → 計画 → 実装 → 最適化 → レビュー)、Gemini主導。 +> **前提条件:** このコマンドは外部の `ccg-workflow` ランタイムを必要とします。これはベースの ECC インストールには**含まれていません**。`npx ccg-workflow` を実行して初期化し、このコマンドが依存する `~/.claude/bin/codeagent-wrapper` と `~/.claude/.ccg/prompts/*` ロールファイルをプロビジョニングしてください。このランタイムがないと、このコマンドは正しく動作しません。 + ## 使用方法 ```bash diff --git a/docs/ja-JP/commands/multi-plan.md b/docs/ja-JP/commands/multi-plan.md index 724a4995..43359574 100644 --- a/docs/ja-JP/commands/multi-plan.md +++ b/docs/ja-JP/commands/multi-plan.md @@ -2,6 +2,8 @@ マルチモデル協調計画 - コンテキスト取得 + デュアルモデル分析 → ステップバイステップの実装計画を生成。 +> **前提条件:** このコマンドは外部の `ccg-workflow` ランタイムを必要とします。これはベースの ECC インストールには**含まれていません**。`npx ccg-workflow` を実行して初期化し、このコマンドが依存する `~/.claude/bin/codeagent-wrapper` と `~/.claude/.ccg/prompts/*` ロールファイルをプロビジョニングしてください。このランタイムがないと、このコマンドは正しく動作しません。 + $ARGUMENTS --- diff --git a/docs/ja-JP/commands/multi-workflow.md b/docs/ja-JP/commands/multi-workflow.md index cf4766dc..d2eabf09 100644 --- a/docs/ja-JP/commands/multi-workflow.md +++ b/docs/ja-JP/commands/multi-workflow.md @@ -2,6 +2,8 @@ マルチモデル協調開発ワークフロー(調査 → アイデア創出 → 計画 → 実装 → 最適化 → レビュー)、インテリジェントルーティング: フロントエンド → Gemini、バックエンド → Codex。 +> **前提条件:** このコマンドは外部の `ccg-workflow` ランタイムを必要とします。これはベースの ECC インストールには**含まれていません**。`npx ccg-workflow` を実行して初期化し、このコマンドが依存する `~/.claude/bin/codeagent-wrapper` と `~/.claude/.ccg/prompts/*` ロールファイルをプロビジョニングしてください。このランタイムがないと、このコマンドは正しく動作しません。 + 品質ゲート、MCPサービス、マルチモデル連携を備えた構造化開発ワークフロー。 ## 使用方法 diff --git a/docs/tr/commands/multi-backend.md b/docs/tr/commands/multi-backend.md index 2394df3c..e551576e 100644 --- a/docs/tr/commands/multi-backend.md +++ b/docs/tr/commands/multi-backend.md @@ -2,6 +2,8 @@ Backend odaklı iş akışı (Research → Ideation → Plan → Execute → Optimize → Review), Codex liderliğinde. +> **Ön koşul:** Bu komut, temel ECC kurulumunun parçası **olmayan** harici `ccg-workflow` runtime'ını gerektirir. Bu komutun bağımlı olduğu `~/.claude/bin/codeagent-wrapper` ve `~/.claude/.ccg/prompts/*` rol dosyalarını sağlamak için `npx ccg-workflow` komutuyla başlatın. Bu runtime olmadan bu komut düzgün çalışmaz. + ## Kullanım ```bash diff --git a/docs/tr/commands/multi-execute.md b/docs/tr/commands/multi-execute.md index bd33f525..a9490efb 100644 --- a/docs/tr/commands/multi-execute.md +++ b/docs/tr/commands/multi-execute.md @@ -2,6 +2,8 @@ Multi-model işbirlikçi execution - Plandan prototype al → Claude refactor edip implement eder → Multi-model audit ve teslimat. +> **Ön koşul:** Bu komut, temel ECC kurulumunun parçası **olmayan** harici `ccg-workflow` runtime'ını gerektirir. Bu komutun bağımlı olduğu `~/.claude/bin/codeagent-wrapper` ve `~/.claude/.ccg/prompts/*` rol dosyalarını sağlamak için `npx ccg-workflow` komutuyla başlatın. Bu runtime olmadan bu komut düzgün çalışmaz. + $ARGUMENTS --- diff --git a/docs/tr/commands/multi-frontend.md b/docs/tr/commands/multi-frontend.md index a1946428..babf3cf5 100644 --- a/docs/tr/commands/multi-frontend.md +++ b/docs/tr/commands/multi-frontend.md @@ -2,6 +2,8 @@ Frontend odaklı iş akışı (Research → Ideation → Plan → Execute → Optimize → Review), Gemini liderliğinde. +> **Ön koşul:** Bu komut, temel ECC kurulumunun parçası **olmayan** harici `ccg-workflow` runtime'ını gerektirir. Bu komutun bağımlı olduğu `~/.claude/bin/codeagent-wrapper` ve `~/.claude/.ccg/prompts/*` rol dosyalarını sağlamak için `npx ccg-workflow` komutuyla başlatın. Bu runtime olmadan bu komut düzgün çalışmaz. + ## Kullanım ```bash diff --git a/docs/tr/commands/multi-plan.md b/docs/tr/commands/multi-plan.md index 8838f2fb..30e9d101 100644 --- a/docs/tr/commands/multi-plan.md +++ b/docs/tr/commands/multi-plan.md @@ -2,6 +2,8 @@ Multi-model işbirlikçi planlama - Context retrieval + Dual-model analiz → Adım adım implementation planı oluştur. +> **Ön koşul:** Bu komut, temel ECC kurulumunun parçası **olmayan** harici `ccg-workflow` runtime'ını gerektirir. Bu komutun bağımlı olduğu `~/.claude/bin/codeagent-wrapper` ve `~/.claude/.ccg/prompts/*` rol dosyalarını sağlamak için `npx ccg-workflow` komutuyla başlatın. Bu runtime olmadan bu komut düzgün çalışmaz. + $ARGUMENTS --- diff --git a/docs/tr/commands/multi-workflow.md b/docs/tr/commands/multi-workflow.md index ff5eb626..0e94a2c7 100644 --- a/docs/tr/commands/multi-workflow.md +++ b/docs/tr/commands/multi-workflow.md @@ -2,6 +2,8 @@ Multi-model işbirlikçi geliştirme iş akışı (Research → Ideation → Plan → Execute → Optimize → Review), akıllı yönlendirme ile: Frontend → Gemini, Backend → Codex. +> **Ön koşul:** Bu komut, temel ECC kurulumunun parçası **olmayan** harici `ccg-workflow` runtime'ını gerektirir. Bu komutun bağımlı olduğu `~/.claude/bin/codeagent-wrapper` ve `~/.claude/.ccg/prompts/*` rol dosyalarını sağlamak için `npx ccg-workflow` komutuyla başlatın. Bu runtime olmadan bu komut düzgün çalışmaz. + Kalite kontrol noktaları, MCP servisleri ve multi-model işbirliği ile yapılandırılmış geliştirme iş akışı. ## Kullanım diff --git a/docs/zh-CN/commands/multi-backend.md b/docs/zh-CN/commands/multi-backend.md index ccf55da1..5eb5c6ba 100644 --- a/docs/zh-CN/commands/multi-backend.md +++ b/docs/zh-CN/commands/multi-backend.md @@ -2,6 +2,8 @@ 后端导向的工作流程(研究 → 构思 → 规划 → 执行 → 优化 → 评审),由 Codex 主导。 +> **前提条件:** 此命令需要外部的 `ccg-workflow` 运行时,它**不**包含在基础 ECC 安装中。请运行 `npx ccg-workflow` 进行初始化,以配置此命令所依赖的 `~/.claude/bin/codeagent-wrapper` 和 `~/.claude/.ccg/prompts/*` 角色文件。没有该运行时,此命令将无法正常运行。 + ## 使用方法 ```bash diff --git a/docs/zh-CN/commands/multi-execute.md b/docs/zh-CN/commands/multi-execute.md index a3d7bc7b..83d067eb 100644 --- a/docs/zh-CN/commands/multi-execute.md +++ b/docs/zh-CN/commands/multi-execute.md @@ -2,6 +2,8 @@ 多模型协同执行 - 从计划获取原型 → Claude 重构并实施 → 多模型审计与交付。 +> **前提条件:** 此命令需要外部的 `ccg-workflow` 运行时,它**不**包含在基础 ECC 安装中。请运行 `npx ccg-workflow` 进行初始化,以配置此命令所依赖的 `~/.claude/bin/codeagent-wrapper` 和 `~/.claude/.ccg/prompts/*` 角色文件。没有该运行时,此命令将无法正常运行。 + $ARGUMENTS *** diff --git a/docs/zh-CN/commands/multi-frontend.md b/docs/zh-CN/commands/multi-frontend.md index 97eff167..cc52bf34 100644 --- a/docs/zh-CN/commands/multi-frontend.md +++ b/docs/zh-CN/commands/multi-frontend.md @@ -2,6 +2,8 @@ 前端聚焦的工作流(研究 → 构思 → 规划 → 执行 → 优化 → 评审),由 Gemini 主导。 +> **前提条件:** 此命令需要外部的 `ccg-workflow` 运行时,它**不**包含在基础 ECC 安装中。请运行 `npx ccg-workflow` 进行初始化,以配置此命令所依赖的 `~/.claude/bin/codeagent-wrapper` 和 `~/.claude/.ccg/prompts/*` 角色文件。没有该运行时,此命令将无法正常运行。 + ## 使用方法 ```bash diff --git a/docs/zh-CN/commands/multi-plan.md b/docs/zh-CN/commands/multi-plan.md index 5dca189a..46e60fb7 100644 --- a/docs/zh-CN/commands/multi-plan.md +++ b/docs/zh-CN/commands/multi-plan.md @@ -2,6 +2,8 @@ 多模型协同规划 - 上下文检索 + 双模型分析 → 生成分步实施计划。 +> **前提条件:** 此命令需要外部的 `ccg-workflow` 运行时,它**不**包含在基础 ECC 安装中。请运行 `npx ccg-workflow` 进行初始化,以配置此命令所依赖的 `~/.claude/bin/codeagent-wrapper` 和 `~/.claude/.ccg/prompts/*` 角色文件。没有该运行时,此命令将无法正常运行。 + $ARGUMENTS *** diff --git a/docs/zh-CN/commands/multi-workflow.md b/docs/zh-CN/commands/multi-workflow.md index 46295241..c29e661f 100644 --- a/docs/zh-CN/commands/multi-workflow.md +++ b/docs/zh-CN/commands/multi-workflow.md @@ -2,6 +2,8 @@ 多模型协同开发工作流程(研究 → 构思 → 规划 → 执行 → 优化 → 审查),带有智能路由:前端 → Gemini,后端 → Codex。 +> **前提条件:** 此命令需要外部的 `ccg-workflow` 运行时,它**不**包含在基础 ECC 安装中。请运行 `npx ccg-workflow` 进行初始化,以配置此命令所依赖的 `~/.claude/bin/codeagent-wrapper` 和 `~/.claude/.ccg/prompts/*` 角色文件。没有该运行时,此命令将无法正常运行。 + 结构化开发工作流程,包含质量门控、MCP 服务和多模型协作。 ## 使用方法 diff --git a/skills/claude-devfleet/SKILL.md b/skills/claude-devfleet/SKILL.md index 0f4dbd37..e72ddff7 100644 --- a/skills/claude-devfleet/SKILL.md +++ b/skills/claude-devfleet/SKILL.md @@ -10,11 +10,19 @@ origin: community Use this skill when you need to dispatch multiple Claude Code agents to work on coding tasks in parallel. Each agent runs in an isolated git worktree with full tooling. -Requires a running Claude DevFleet instance connected via MCP: +## Setup + +The DevFleet server is a separate project, not bundled with ECC. Install and +run it from its repository first: + +Then connect the running instance via MCP: ```bash claude mcp add devfleet --transport http http://localhost:18801/mcp ``` +Before first use, verify the process listening on port 18801 is the DevFleet +binary you installed (see SECURITY.md on localhost MCP servers). + ## How It Works ```