ContextStudioWizard/README.md
Karamelmar 452a603cdf Add auto-install for missing prerequisites
- New lib/prereqs.sh: detects distro (Arch, Debian/Ubuntu, RHEL/Fedora,
  openSUSE) and installs git + podman/docker if missing
- Podman preferred over docker; user chooses if neither present
- Docker install also enables systemd service and adds user to docker group
- README updated: prereqs table now shows auto-install support

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-09 12:05:08 +01:00

118 lines
3.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 🧙 Context Studio Wizard
> Scaffold a fully configured multi-agent AI development environment in seconds.
---
## ✨ What it does
One command. One conversation. A complete project drops out:
```
~/.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
```
Open in devcontainer → start Context Studio → talk to your agent team.
---
## 📋 Prerequisites
| | Tool | Notes |
|---|------|---------|
| 🔀 | `git` | Auto-installed if missing |
| 🐳 | `podman` _(preferred)_ or `docker` | Auto-installed if missing |
| 🔑 | SSH key → `github.com` | Must be set up manually |
| 🗝️ | `ANTHROPIC_API_KEY` | Must be set in your environment |
**Auto-install supported on:** Arch · Debian/Ubuntu · RHEL/Fedora · openSUSE
> The wizard detects your distro and installs `git` and `podman`/`docker` automatically if they are missing. SSH key and API key must be set up by you.
---
## 🚀 Usage
```bash
./wizard.sh
```
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)_
| Preset | Agents |
|--------|--------|
| `minimal` | 🎯 coordinator · 2× coder · researcher · tester |
| `standard` | 🎯🎯 2× coordinator · 3× coder · 2× researcher · tester · reviewer |
5.**Done** — git repo initialized, devcontainer ready
---
## 📂 Open the project
**🖥️ VS Code**
```bash
code ~/projects/my-project # → "Reopen in Container"
```
**⌨️ CLI**
```bash
cd ~/projects/my-project
docker build -t my-project .devcontainer/
docker run -it --rm \
-v "$(pwd)":/workspace \
-v "$HOME/.context-studio/core":/opt/context-studio/core \
-e ANTHROPIC_API_KEY="$ANTHROPIC_API_KEY" \
my-project bash
```
**▶️ 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
```
---
## 🌍 Mobility
Commit your project. On any machine:
```bash
git clone <your-project-repo>
cd my-project
code . # done
```
> Core is re-cloned automatically on first run. Only `ANTHROPIC_API_KEY` is needed on the host.
---
## 🗂️ 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
```