john/claude-engineering-plugin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(ce-setup): add getting started sections to READMEs (#548)

Browse Source
This commit is contained in:
Trevin Chow
2026-04-10 17:47:21 -07:00
committed by GitHub
parent e931ed92b1
commit 9aa65c1fe6
2 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -46,6 +46,10 @@ Brainstorm -> Plan -> Work -> Review -> Compound -> Repeat
Each cycle compounds: brainstorms sharpen plans, plans inform future plans, reviews catch more issues, patterns get documented.
### Getting started
After installing, run `/ce-setup` in any project. It checks your environment, installs missing tools (agent-browser, gh, jq, vhs, silicon, ffmpeg), and bootstraps project config.
---
## Install

8
plugins/compound-engineering/README.md
View File

@@ -2,6 +2,10 @@
AI-powered development tools that get smarter with every use. Make each unit of engineering work easier than the last.
## Getting Started
After installing, run `/ce-setup` in any project. It diagnoses your environment, installs missing tools, and bootstraps project config in one interactive flow.
## Components
| Component | Count |
@@ -53,6 +57,7 @@ The primary entry points for engineering work, invoked as slash commands:
| `/test-browser` | Run browser tests on PR-affected pages |
| `/test-xcode` | Build and test iOS apps on simulator using XcodeBuildMCP |
| `/onboarding` | Generate `ONBOARDING.md` to help new contributors understand the codebase |
| `/ce-setup` | Diagnose environment, install missing tools, and bootstrap project config |
| `/ce-update` | Check compound-engineering plugin version and fix stale cache (Claude Code only) |
| `/todo-resolve` | Resolve todos in parallel |
| `/todo-triage` | Triage and prioritize pending todos |
@@ -73,7 +78,6 @@ The primary entry points for engineering work, invoked as slash commands:
|-------|-------------|
| `claude-permissions-optimizer` | Optimize Claude Code permissions from session history |
| `document-review` | Review documents using parallel persona agents for role-specific feedback |
| `ce-setup` | Diagnose and configure environment: checks CLI deps, MCP servers, env vars, plugin version, and repo-local config; offers guided installation for missing tools |
### Content & Collaboration
@@ -183,6 +187,8 @@ Agents are specialized subagents invoked by skills — you typically don't call
claude /plugin install compound-engineering
```
Then run `/ce-setup` to check your environment and install recommended tools.
## Version History
See the repo root [CHANGELOG.md](../../CHANGELOG.md) for canonical release history.