diff --git a/README.md b/README.md index ca1daf3..1357fcf 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,38 @@ -# Context Studio Wizard +# ๐Ÿง™ Context Studio Wizard > Scaffold a fully configured multi-agent AI development environment in seconds. --- -## What it does +## โœจ What it does One command. One conversation. A complete project drops out: ``` -~/.context-studio/core/ โ† installed once, shared globally +~/.context-studio/core/ โ† ๐Ÿ”ง installed once, shared globally ~/projects/my-project/ -โ”œโ”€โ”€ .devcontainer/ โ† Node 22 ยท Rust ยท Claude Code ยท Electron deps -โ”œโ”€โ”€ workflow/ โ† agents, roles, A2A config, project docs -โ””โ”€โ”€ src/ โ† your code +โ”œโ”€โ”€ .devcontainer/ โ† ๐Ÿณ Node 22 ยท Rust ยท Claude Code ยท Electron deps +โ”œโ”€โ”€ workflow/ โ† ๐Ÿค– agents, roles, A2A config, project docs +โ””โ”€โ”€ src/ โ† ๐Ÿ’ป your code ``` Open in devcontainer โ†’ start Context Studio โ†’ talk to your agent team. --- -## Prerequisites +## ๐Ÿ“‹ Prerequisites -| Tool | Purpose | -|------|---------| -| `git` | Clone repos | -| `docker` or `podman` | Run devcontainer | -| SSH key โ†’ `github.com` | Access context-studio-core | -| `ANTHROPIC_API_KEY` | Claude agents | +| | Tool | Purpose | +|---|------|---------| +| ๐Ÿ”€ | `git` | Clone repos | +| ๐Ÿณ | `docker` or `podman` | Run devcontainer | +| ๐Ÿ”‘ | SSH key โ†’ `github.com` | Access context-studio-core | +| ๐Ÿ—๏ธ | `ANTHROPIC_API_KEY` | Claude agents | --- -## Usage +## ๐Ÿš€ Usage ```bash ./wizard.sh @@ -40,28 +40,28 @@ Open in devcontainer โ†’ start Context Studio โ†’ talk to your agent team. The wizard guides you through: -1. **Core setup** โ€” clones `context-studio-core` to `~/.context-studio/core/` (once) -2. **Project name & location** -3. **Workflow** โ€” generate from scratch _or_ clone an existing repo -4. **Agent preset** _(if generating)_ +1. ๐Ÿ”ง **Core setup** โ€” clones `context-studio-core` to `~/.context-studio/core/` (once) +2. ๐Ÿ“ **Project name & location** +3. โš™๏ธ **Workflow** โ€” generate from scratch _or_ clone an existing repo +4. ๐Ÿค– **Agent preset** _(if generating)_ | Preset | Agents | |--------|--------| - | `minimal` | coordinator ยท 2ร— coder ยท researcher ยท tester | - | `standard` | 2ร— coordinator ยท 3ร— coder ยท 2ร— researcher ยท tester ยท reviewer | + | `minimal` | ๐ŸŽฏ coordinator ยท 2ร— coder ยท researcher ยท tester | + | `standard` | ๐ŸŽฏ๐ŸŽฏ 2ร— coordinator ยท 3ร— coder ยท 2ร— researcher ยท tester ยท reviewer | -5. **Done** โ€” git repo initialized, devcontainer ready +5. โœ… **Done** โ€” git repo initialized, devcontainer ready --- -## Open the project +## ๐Ÿ“‚ Open the project -**VS Code** +**๐Ÿ–ฅ๏ธ VS Code** ```bash code ~/projects/my-project # โ†’ "Reopen in Container" ``` -**CLI** +**โŒจ๏ธ CLI** ```bash cd ~/projects/my-project docker build -t my-project .devcontainer/ @@ -72,7 +72,7 @@ docker run -it --rm \ my-project bash ``` -**Start Context Studio** _(inside container)_ +**โ–ถ๏ธ Start Context Studio** _(inside container)_ ```bash node $CS_CORE_DIR/core/start.js # Electron UI node $CS_CORE_DIR/core/start.js --ui-mode=headless # servers only @@ -80,7 +80,7 @@ node $CS_CORE_DIR/core/start.js --ui-mode=headless # servers only --- -## Mobility +## ๐ŸŒ Mobility Commit your project. On any machine: @@ -90,25 +90,25 @@ cd my-project code . # done ``` -Core is re-cloned automatically on first run. Only `ANTHROPIC_API_KEY` is needed on the host. +> Core is re-cloned automatically on first run. Only `ANTHROPIC_API_KEY` is needed on the host. --- -## Repository layout +## ๐Ÿ—‚๏ธ Repository layout ``` -wizard.sh โ† entry point -lib/ - utils.sh โ† prompts, colors, helpers - core.sh โ† global core install/update - project.sh โ† devcontainer + project scaffold - workflow.sh โ† generate or clone workflow config -templates/ - Dockerfile โ† Node 22 + Rust + build tools + Claude Code - devcontainer.json โ† mounts, env vars, VS Code extensions - agents-minimal.json โ† 5-agent preset - agents-standard.json โ† 9-agent preset - system.json โ† A2A server defaults - roles/ โ† coordinator, coder, researcher, tester, reviewer - hooks/rules/ โ† per-role tool restrictions +๐Ÿง™ wizard.sh โ† entry point +๐Ÿ“ lib/ + utils.sh โ† prompts, colors, helpers + core.sh โ† global core install/update + project.sh โ† devcontainer + project scaffold + workflow.sh โ† generate or clone workflow config +๐Ÿ“ templates/ + Dockerfile โ† Node 22 + Rust + build tools + Claude Code + devcontainer.json โ† mounts, env vars, VS Code extensions + agents-minimal.json โ† 5-agent preset + agents-standard.json โ† 9-agent preset + system.json โ† A2A server defaults + ๐Ÿ“ roles/ โ† coordinator, coder, researcher, tester, reviewer + ๐Ÿ“ hooks/rules/ โ† per-role tool restrictions ```