Polish README with icons and symbols
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
09ff27be92
commit
8d089c05a2
1 changed files with 42 additions and 42 deletions
84
README.md
84
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
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue