Skip to content

docs: Update README for egg-sdlc CLI [doc-updater] #666

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
jwbron merged 1 commit into from
Feb 14, 2026
Merged

docs: Update README for egg-sdlc CLI [doc-updater] #666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 13 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A structurally enforced SDLC pipeline for autonomous LLM agents — turning task

## How It Works

Run `egg` to start an interactive session, then use the `/sdlc` skill to launch a multi-agent pipeline. The agent cannot skip steps, self-approve work, or bypass review — these constraints are enforced by the gateway infrastructure, not by prompts.
Use the `egg-sdlc` CLI to launch a multi-agent pipeline. The agent cannot skip steps, self-approve work, or bypass review — these constraints are enforced by the gateway infrastructure, not by prompts.

```
┌───────────┐ ┌───────────┐ ┌───────────────┐ ┌──────────┐
Expand All @@ -26,12 +26,14 @@ Run `egg` to start an interactive session, then use the `/sdlc` skill to launch
3. **Implement** — Agent creates a draft PR and implements tasks. CI runs, automated review provides line-level feedback. Re-implementation cycles continue until all checks pass.
4. **Merge** — Draft PR is marked ready. Only a human can merge via GitHub UI.

The `/sdlc` skill supports two modes:
- **Issue mode** (`/sdlc 123`): GitHub-issue-driven pipeline with full remote integration
- **Local mode** (`/sdlc` with no args): Prompt-driven pipeline that runs entirely locally
The `egg-sdlc` CLI supports two modes:
- **Issue mode** (`egg-sdlc 123`): GitHub-issue-driven pipeline with full remote integration
- **Local mode** (`egg-sdlc` with no args): Prompt-driven pipeline that runs entirely locally

Both modes create a pipeline in the orchestrator, which spawns sandbox containers to execute each phase as a DAG. Pipeline state lives in a JSON contract (`.egg-state/contracts/{identifier}.json`) committed to the feature branch, giving full auditability of every phase transition.

For convenience, the `/sdlc` skill inside the `egg` interactive session redirects to `egg-sdlc`, so you can invoke it either way.

## The Gateway

The gateway is the enforcement engine. It sits between the agent sandbox and the outside world, validating every operation against the current pipeline phase and role permissions.
Expand Down Expand Up @@ -124,12 +126,13 @@ Roles are enforced by the gateway — each agent can only perform operations all
## Starting a Pipeline

```bash
# Start egg
egg
# Direct CLI (recommended)
egg-sdlc 123 # Issue mode — drives from GitHub issue #123
egg-sdlc # Local mode — prompt-driven, no GitHub interaction

# Inside the session, launch the SDLC pipeline:
/sdlc 123 # Issue mode — drives from GitHub issue #123
/sdlc # Local mode — prompt-driven, no GitHub interaction
# Or from inside an egg session
egg
/sdlc 123 # Redirects to egg-sdlc
```

The pipeline creates a draft PR automatically when entering the implement phase. Once all checks pass, the PR is marked ready for human review and merge.
Expand All @@ -156,7 +159,7 @@ egg

Running `egg` starts the gateway and sandbox automatically. On first run it will prompt you to configure repositories and credentials via `egg --setup`. By default it launches in public mode (full internet access); use `egg --private` for network-locked private repo mode.

Once inside a session, use `/sdlc` to launch the full pipeline, or work interactively with individual agent modes (`/coder-mode`, `/tester-mode`, etc.).
Use `egg-sdlc` to launch the full SDLC pipeline, or work interactively inside an `egg` session with individual agent modes (`/coder-mode`, `/tester-mode`, etc.).

See the [Local Quickstart Guide](docs/guides/local-quickstart.md) for detailed setup instructions including PAT-based authentication.

Expand Down
9 changes: 5 additions & 4 deletions sandbox/.claude/commands/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ This directory contains slash command documentation for Claude Code CLI in the s
## Available Commands

### /sdlc
Initialize and start an SDLC pipeline for an issue.
Redirects to the `egg-sdlc` CLI tool for launching SDLC pipelines.

**Usage**: `/sdlc <issue_number> [--repo owner/repo]`

**What it does**:
- Creates a new pipeline in the egg-orchestrator
- Starts automated multi-agent orchestration
- Shows how to monitor progress
- Provides instructions to use the `egg-sdlc` CLI directly
- The `egg-sdlc` CLI handles DAG visualization and HITL checkpoints

**Recommended**: Use `egg-sdlc` directly instead of `/sdlc` for better TTY support.

**File**: `sdlc.md`

Expand Down