Skip to content

docs: clarify multi-model command setup#931

Merged
affaan-m merged 1 commit into
affaan-m:mainfrom
KT-lcz:main
Mar 28, 2026
Merged

docs: clarify multi-model command setup#931
affaan-m merged 1 commit into
affaan-m:mainfrom
KT-lcz:main

Conversation

@KT-lcz

@KT-lcz KT-lcz commented Mar 26, 2026

Copy link
Copy Markdown
Contributor

Document that multi-* commands require the ccg-workflow runtime so users know they must initialize the extra wrapper and prompt assets before use.

Document that multi-* commands require the ccg-workflow runtime so users know they must initialize the extra wrapper and prompt assets before use.
@greptile-apps

greptile-apps Bot commented Mar 26, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds a clearly scoped warning callout to the main README.md and README.zh-CN.md quick-start sections, informing users that the five multi-* commands (/multi-plan, /multi-execute, /multi-backend, /multi-frontend, /multi-workflow) require the external ccg-workflow runtime and will not work without running npx ccg-workflow first.\n\nKey changes:\n- Inserts a ⚠️ blockquote immediately after the base-install "That's it!" line in both files, listing the ccg-workflow init command and its two concrete filesystem artifacts (~/.claude/bin/codeagent-wrapper, ~/.claude/.ccg/prompts/*)\n- Content is verified accurate against the actual command definitions (commands/multi-plan.md, commands/multi-workflow.md), which do invoke ~/.claude/bin/codeagent-wrapper and reference ~/.claude/.ccg/prompts/* role files\n- Chinese translation (README.zh-CN.md) mirrors the English block faithfully\n\nGap to address:\n- docs/zh-CN/README.md and docs/ja-JP/README.md contain the same Step 1/2/3 quick-start structure and mention multi-* commands in their changelogs, but were not updated; users reading those files won't see the warning

Confidence Score: 4/5

Safe to merge; only documentation is changed and all claims are accurate — one P2 consistency gap in sister localised READMEs is worth a follow-up but does not block this PR.

The added content is factually correct (verified against command source files), well-placed in the quick-start flow, and improves the user experience. The only gap is that two other localised READMEs (docs/zh-CN/README.md, docs/ja-JP/README.md) with the same structure were not updated, which is a non-blocking consistency issue.

docs/zh-CN/README.md and docs/ja-JP/README.md should receive the equivalent warning block in a follow-up.

Important Files Changed

Filename Overview
README.md Adds a warning callout block after the base install "That's it!" line, correctly documenting that multi-* commands require the ccg-workflow runtime and listing its two concrete file-system dependencies.
README.zh-CN.md Adds the equivalent zh-CN warning block; translation is accurate and mirrors the English structure faithfully.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User installs plugin
/plugin install everything-claude-code] --> B[Step 2: Install rules
npx ecc-install]
    B --> C{Want to use
multi-* commands?}
    C -- No --> D[✅ Ready to use
28 agents · 125 skills · 60 commands]
    C -- Yes --> E[Install ccg-workflow runtime
npx ccg-workflow]
    E --> F{Runtime installed
successfully?}
    F -- Yes --> G[Provides
~/.claude/bin/codeagent-wrapper
~/.claude/.ccg/prompts/*]
    G --> H[✅ /multi-plan
/multi-execute
/multi-backend
/multi-frontend
/multi-workflow]
    F -- No --> I[❌ multi-* commands
will not run correctly]
Loading

Reviews (1): Last reviewed commit: "docs: clarify multi-model command setup" | Re-trigger Greptile

Comment thread README.md
> - `~/.claude/bin/codeagent-wrapper`
> - `~/.claude/.ccg/prompts/*`
>
> Without `ccg-workflow`, these `multi-*` commands will not run correctly.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Warning block missing from other localised quick-start READMEs

Two additional localised READMEs share the same "Step 1 → Step 2 → Step 3 → ✨ That's it!" installation structure and also reference multi-* commands, but were not updated in this PR:

  • docs/zh-CN/README.md — line 212 reads ✨ **搞定!** 你现在可以使用 28 个智能体、116 项技能和 59 个命令了。, followed immediately by *** and the cross-platform section; no ccg-workflow warning present.
  • docs/ja-JP/README.md — line 146 reads ✨ **完了です!** これで13のエージェント、43のスキル、31のコマンドにアクセスできます。, followed by --- and the cross-platform section; no ccg-workflow warning present.

Users reading either of those files will be left without the setup guidance that this PR adds to the root README.md and README.zh-CN.md. Consider applying the same warning block in both files for consistency.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 2 files


Since this is your first cubic review, here's how it works:

  • cubic automatically reviews your code and comments on bugs and improvements
  • Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
  • Add one-off context when rerunning by tagging @cubic-dev-ai with guidance or docs links (including llms.txt)
  • Ask questions if you need clarification on any suggestion

@affaan-m

Copy link
Copy Markdown
Owner

thanks for the PR. quick triage: maintainer review pending. if there are docs, screenshots, or repro steps, please drop them here.

@affaan-m affaan-m merged commit f077975 into affaan-m:main Mar 28, 2026
3 checks passed
peiking88 pushed a commit to peiking88/everything-claude-code that referenced this pull request Apr 4, 2026
docs: clarify multi-model command setup
FrancescoRosciano pushed a commit to FRosciano-Mambo/everything-claude-code that referenced this pull request Jun 1, 2026
docs: clarify multi-model command setup
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants