Skip to content

Redesign setup.sh: interactive wizard with guided key entry & live health dashboard #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
valITino merged 2 commits into from
Jun 12, 2026
Merged

Redesign setup.sh: interactive wizard with guided key entry & live health dashboard #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1c7926
Rework setup.sh into a guided, professional install wizard
claude Jun 12, 2026
cf5cb3a
Polish setup wizard: pre-flight review, safer keys, modern terminal UX
claude Jun 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DOCKER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Claude Desktop ──▶ MCP Gateway (localhost:8080/mcp) ──┬──▶ Kal
```bash
git clone https://github.com/valITino/blhackbox.git
cd blhackbox
./setup.sh # interactive wizard: prereqs, .env, pull, start, health
./setup.sh # guided wizard: prereqs, AI client, keys, Neo4j, live pull/health
```

### Manual — Default Stack (7 containers)
Expand Down
18 changes: 10 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,14 +306,16 @@ cd blhackbox
./setup.sh
```

The setup wizard will:

1. Check prerequisites (Docker, Docker Compose, disk space)
2. Let you choose optional components (Neo4j, MCP Gateway)
3. Prompt for your `ANTHROPIC_API_KEY` (required for Claude Code in Docker)
4. Generate `.env` and create the `output/` directory
5. Pull Docker images and start all services
6. Wait for health checks to pass
The setup wizard walks you through everything interactively:

1. **Check prerequisites** (Docker, Docker Compose, Git, disk space)
2. **Choose your AI client** — Claude (Claude Code in Docker, Claude Code Web, or Claude Desktop), ChatGPT/OpenAI, or DeepSeek. The choice decides which agent/profile starts and which key (if any) you need.
3. **Configure API keys with guidance** — for each key it explains what it's for, where it's used, and the exact steps to obtain it; every key is optional/skippable.
4. **Pick a knowledge graph** — none, local Neo4j (Docker), or Neo4j Aura (cloud). Aura mode walks you through `console.neo4j.io` and stores your connection details without starting a local container.
5. **Optionally add recon API keys** (WPScan, Shodan, VirusTotal, SecurityTrails) — all skippable; tools run without them.
6. **Generate `.env`** and create the `output/` directory
7. **Pull images with live progress** and start all services
8. **Show a live service-health dashboard** until services are healthy

Non-interactive flags:

Expand Down
Loading