Skip to content

williamnie/aegisFlow

Repository files navigation

AegisFlow

English | 简体中文

AegisFlow is a multi-agent CLI orchestrator that turns an idea into a structured delivery flow: requirement intake, PRD, technical design, independent review, roundtable decision-making, task planning, development, and integration review.

What It Does

  • Guides idea intake and asks only the minimum follow-up questions needed to scope a realistic MVP.
  • Produces requirement artifacts such as idea-brief.md, requirement-pack.md, and validation reviews before PRD generation.
  • Generates prd.md and design.md in the current workspace.
  • Runs independent multi-agent reviews, summarizes consensus, and starts a roundtable when reviewers disagree.
  • Supports pausing after design or continuing into development in single-terminal or multi-terminal mode.
  • Creates implementation plans, per-task execution logs, integration review notes, delivery summaries, and a final handoff.
  • Persists session state so the same run can be resumed later with the same session-id.

Requirements

  • Node.js 18 or newer
  • One or more supported agent CLIs available in your PATH

Supported engine detection currently covers codex, claude, and gemini / gemini-cli.

Install

npm install -g aegisflow

After installation, you can start it with:

aegis

An alias is also available:

aegisflow

Usage

aegis
aegis --sessions
aegis --setup
aegis <session-id>
aegis <session-id> --from <stage>
aegis -h
aegis --help
aegis -v
aegis --version
aeigs
aegisflow
  • aegis: start a new run in the current directory.
  • aegis --sessions: list saved sessions, including the project path and last known stage.
  • aegis <session-id>: resume or continue a specific session.
  • aegis <session-id> --from <stage>: restart from a specific stage, clearing artifacts for that stage and everything after it before rerunning.
  • aegis --setup: rerun interactive setup and engine detection.
  • aegis -h / aegis --help: show CLI help and output locations.
  • aegis -v / aegis --version: print the installed version.
  • aeigs and aegisflow: aliases of aegis.

Common --from values:

  • stage0 / idea
  • stage0.5 / requirement-gate
  • stage1 / prd
  • stage2 / tech-design
  • stage3 / reviews
  • stage4 / roundtable
  • stage4.5 / strategy
  • stage5 / task-plan
  • stage6 / execution
  • stage7 / integration

Examples:

aegis --sessions
aegis demo-session --from stage6
aegis demo-session --from execution
aegis demo-session --from strategy

Default session IDs now use the last two workspace directory names plus a timestamp, for example xiaobei-aegis-flow-2026-03-17T03-29-28-379Z.

Workflow

  1. Idea intake and requirement gate
  2. PRD drafting
  3. Technical design drafting
  4. Independent reviews and consensus summary
  5. Optional roundtable for conflicting design decisions
  6. Development strategy selection
  7. Task planning and execution
  8. Integration review and final handoff

Workflow Diagram

flowchart TD
    subgraph S1["Requirement Phase"]
        A["Idea"] --> B["Clarifying Questions"]
        B --> C["Scope Alignment / MVP Boundary"]
        C --> D["Requirement Validation"]
    end

    subgraph S2["Solution Phase"]
        D --> E["PRD"]
        E --> F["Technical Design"]
    end

    subgraph S3["Review Phase"]
        F --> G["Independent Multi-Agent Review"]
        G --> H["Consensus Summary"]
        H --> I{"Any disagreement?"}
        I -- "Yes" --> J["Roundtable Discussion / Decision"]
        I -- "No" --> K["Task Planning"]
        J --> K
    end

    subgraph S4["Execution Phase"]
        K --> L["Implementation"]
        L --> M["Integration Review"]
        M --> N["Delivery Summary"]
        N --> O["Final Handoff"]
    end
Loading

Output Layout

Only the final workspace deliverables are written into the current working directory:

  • prd.md
  • design.md

Session metadata and archived artifacts are stored under ~/.aegisflow/sessions/<session-id>/.

Common archived files include:

  • idea-brief.md
  • requirement-pack.md
  • consensus-report.md
  • roundtable-minutes.md
  • implementation-plan.md
  • integration-review.md
  • delivery-summary.md
  • final-handoff.md

Per-task execution records are stored under ~/.aegisflow/sessions/<session-id>/archive/task-runs/.

Setup And Configuration

On first run, AegisFlow guides you through setup and creates a global config file at ~/.aegisflow/config.json.

  • Use --setup any time you want to redetect engines or change routing preferences.
  • A sample config is provided in aegisflow.config.json.example.
  • Model execution timeout is configurable via timeouts.modelExecutionMinutes in ~/.aegisflow/config.json and defaults to 30.
  • Environment variable overrides are available for common settings such as AEGISFLOW_LANGUAGE, AEGISFLOW_DESIGN_LEAD, AEGISFLOW_FALLBACK_ORDER, AEGISFLOW_CODEX_CMD, AEGISFLOW_CLAUDE_CMD, AEGISFLOW_GEMINI_CMD, and the matching *_ARGS variables.

Local Development

npm install
npm run dev
npm run build
npm run release:check

Publish

Before publishing, make sure the package name is available on npm and then run:

npm publish

If you publish through GitHub Actions:

  1. Add an NPM_TOKEN repository secret.
  2. Bump the version in package.json.
  3. Update CHANGELOG.md.
  4. Push a tag like v1.0.1.

About

一个基于多智能体协作的命令行工具,将你的原始想法自动推进为完整 PRD、技术设计、评审记录,并调度本地开发工具链完成交付。A multi-agent collaborative CLI tool that automatically transforms your raw ideas into complete PRDs, technical designs, review records, and orchestrates local development toolchains to deliver the final product.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors