Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,16 @@ npm install @mandarnilange/agentforge
export ANTHROPIC_API_KEY=sk-ant-...

# 3. Scaffold the reference template into .agentforge/
npx agentforge init --template simple-sdlc
npx @mandarnilange/agentforge init --template simple-sdlc

# 4. Run a single agent against a brief
npx agentforge exec analyst --input "Build a freelance invoicing SaaS"
npx @mandarnilange/agentforge exec analyst --input "Build a freelance invoicing SaaS"

# 5. Run the full pipeline (approval gates between phases)
npx agentforge run --project my-app --input "brief=Build a freelance invoicing SaaS"
npx @mandarnilange/agentforge run --project my-app --input "brief=Build a freelance invoicing SaaS"

# 6. Open the dashboard to watch it live
npx agentforge dashboard
npx @mandarnilange/agentforge dashboard
# → http://localhost:3001
```

Expand Down Expand Up @@ -386,7 +386,7 @@ Three ways to run AgentForge, smallest to largest. Same YAML, same binary — on
└─────────────────────────────────────────────────┘
```

For evaluation, demos, and most small projects. `npx agentforge dashboard` starts everything. If you prefer running it in Docker without Postgres or OTel:
For evaluation, demos, and most small projects. `npx @mandarnilange/agentforge dashboard` starts everything. If you prefer running it in Docker without Postgres or OTel:

```bash
docker compose up -d # Dashboard at :3001
Expand Down Expand Up @@ -517,7 +517,7 @@ A React SPA served by the same binary. Real-time pipeline view via Server-Sent E
- PDF export of a completed run

```bash
npx agentforge dashboard --port 3001
npx @mandarnilange/agentforge dashboard --port 3001
```

When `ANTHROPIC_API_KEY` isn't set, the dashboard renders a read-only banner — useful for browsing completed runs.
Expand Down Expand Up @@ -630,7 +630,7 @@ If you're embedding the engine into your own CLI or service — or you want the

```bash
npm install @mandarnilange/agentforge-core
npx agentforge-core init --template simple-sdlc
npx @mandarnilange/agentforge-core init --template simple-sdlc
```

Same YAML schema, same executors, same control plane. You wire your own entry point. Package-level docs: [`packages/core/README.md`](packages/core/README.md).
Expand Down
44 changes: 22 additions & 22 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,19 @@ npm install @mandarnilange/agentforge
export ANTHROPIC_API_KEY=sk-ant-your-key-here

# Scaffold your .agentforge/ directory (agents, pipelines, schemas)
npx agentforge init # blank template
npx agentforge init --template simple-sdlc # analyst → architect → developer starter
npx @mandarnilange/agentforge init # blank template
npx @mandarnilange/agentforge init --template simple-sdlc # analyst → architect → developer starter

# Start the dashboard
npx agentforge dashboard
npx @mandarnilange/agentforge dashboard

# In another terminal: run a pipeline
npx agentforge run --project my-saas --input "brief=Build a SaaS invoicing platform"
npx @mandarnilange/agentforge run --project my-saas --input "brief=Build a SaaS invoicing platform"

# Open http://localhost:3001/dashboard to watch progress
```

> **Contributing / running from source?** Clone the repo, `npm ci`, then swap `npx agentforge` for `npx tsx packages/platform/src/platform-cli.ts` in any command below (or `npx agentforge` if you're on the core package).
> **Contributing / running from source?** Clone the repo, `npm ci`, then swap `npx @mandarnilange/agentforge` for `npx tsx packages/platform/src/platform-cli.ts` in any command below (or `npx tsx packages/core/src/cli/index.ts` if you're on the core package).

---

Expand Down Expand Up @@ -83,18 +83,18 @@ npm run build
Verify the installation:

```bash
npx agentforge --version # prints 0.2.0
npx agentforge list # lists scaffolded agents (after init)
npx agentforge templates list # lists bundled pipeline templates
npx @mandarnilange/agentforge --version # prints 0.2.0
npx @mandarnilange/agentforge list # lists scaffolded agents (after init)
npx @mandarnilange/agentforge templates list # lists bundled pipeline templates
```

### Initialize the project

Scaffold the `.agentforge/` directory with agent, pipeline, and schema templates:

```bash
npx agentforge init # blank template
npx agentforge init --template simple-sdlc # analyst → architect → developer
npx @mandarnilange/agentforge init # blank template
npx @mandarnilange/agentforge init --template simple-sdlc # analyst → architect → developer
```

This creates:
Expand All @@ -110,13 +110,13 @@ This creates:

```bash
# Provide a project brief as inline text
npx agentforge run \
npx @mandarnilange/agentforge run \
--project my-app \
--pipeline simple-sdlc \
--input "brief=Build a task management app with user authentication"

# Or provide a brief file
npx agentforge run \
npx @mandarnilange/agentforge run \
--project my-app \
--input "brief=@path/to/brief.md"
```
Expand All @@ -128,7 +128,7 @@ The pipeline will:

### From Dashboard

1. Start the dashboard: `npx agentforge dashboard`
1. Start the dashboard: `npx @mandarnilange/agentforge dashboard`
2. Open http://localhost:3001/dashboard
3. Click "New Pipeline"
4. Fill in project name and brief
Expand All @@ -137,7 +137,7 @@ The pipeline will:
### Running a Single Agent

```bash
npx agentforge exec <agent-name> \
npx @mandarnilange/agentforge exec <agent-name> \
--input path/to/brief.md \
--output ./output/<agent-name> \
--verbose
Expand Down Expand Up @@ -171,23 +171,23 @@ Gates are human approval checkpoints between pipeline phases.
### Approve a gate (pipeline advances to next phase)

```bash
npx agentforge gate approve <gate-id> \
npx @mandarnilange/agentforge gate approve <gate-id> \
--reviewer "Alice" \
--comment "Looks good, approved"
```

### Reject a gate (pipeline fails)

```bash
npx agentforge gate reject <gate-id> \
npx @mandarnilange/agentforge gate reject <gate-id> \
--reviewer "Bob" \
--comment "Architecture needs rework"
```

### Request revision (agents re-run with feedback)

```bash
npx agentforge gate revise <gate-id> \
npx @mandarnilange/agentforge gate revise <gate-id> \
--notes "Add rate limiting to the API design" \
--reviewer "Alice"
```
Expand All @@ -199,7 +199,7 @@ Click on a pending gate in the Gates page. Use the Approve/Reject/Revise buttons
### List pending gates

```bash
npx agentforge get gates --pipeline <pipeline-run-id>
npx @mandarnilange/agentforge get gates --pipeline <pipeline-run-id>
```

---
Expand Down Expand Up @@ -241,14 +241,14 @@ Remote nodes allow you to distribute agent execution across multiple machines.

```bash
# On your server/cloud machine
npx agentforge dashboard --host 0.0.0.0 --port 3001
npx @mandarnilange/agentforge dashboard --host 0.0.0.0 --port 3001
```

### Start a remote node

```bash
# On a different machine (or same machine for testing)
npx agentforge node start \
npx @mandarnilange/agentforge node start \
--control-plane-url http://control-plane-host:3001 \
--token your-node-api-key \
--name gpu-node \
Expand All @@ -266,7 +266,7 @@ The node will:

```bash
# Run pipeline with Docker executor (launches container per agent job)
npx agentforge run \
npx @mandarnilange/agentforge run \
--project my-app \
--executor docker \
--executor-image my-executor:latest
Expand All @@ -276,7 +276,7 @@ npx agentforge run \

```bash
# Run pipeline delegating to a remote executor service
npx agentforge run \
npx @mandarnilange/agentforge run \
--project my-app \
--executor remote \
--executor-url http://gpu-node:8080
Expand Down
2 changes: 1 addition & 1 deletion docs/testing-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Validates CLI wiring, config loading, and agent registration without calling the

```bash
# Scaffold the simple-sdlc template into .agentforge/
npx agentforge init --template simple-sdlc
npx @mandarnilange/agentforge init --template simple-sdlc

# Dry run any agent
npx tsx packages/core/src/cli/index.ts exec analyst --input "Build a SaaS invoicing app" --dry-run
Expand Down
10 changes: 5 additions & 5 deletions packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ npm install @mandarnilange/agentforge-core
export ANTHROPIC_API_KEY=sk-ant-...

# Scaffold a starter .agentforge/ directory
npx agentforge-core init --template simple-sdlc
npx @mandarnilange/agentforge-core init --template simple-sdlc

# Run a single agent
npx agentforge-core exec analyst --input "Build a freelance invoicing SaaS"
npx @mandarnilange/agentforge-core exec analyst --input "Build a freelance invoicing SaaS"

# Run the full pipeline
npx agentforge-core run --project my-app --input "brief=Build a freelance invoicing SaaS"
npx @mandarnilange/agentforge-core run --project my-app --input "brief=Build a freelance invoicing SaaS"

# Start the web dashboard
npx agentforge-core dashboard
npx @mandarnilange/agentforge-core dashboard
# Open http://localhost:3001
```

Expand Down Expand Up @@ -232,7 +232,7 @@ Ships with **45 built-in schemas** covering requirements, architecture, code, da
| **architect** | 2 | Architect | architecture plan |
| **developer** | 3 | Developer | code output |

Scaffold it with `npx agentforge-core init --template simple-sdlc`. These are YAML definitions — modify them, extend them, or build your own from scratch.
Scaffold it with `npx @mandarnilange/agentforge-core init --template simple-sdlc`. These are YAML definitions — modify them, extend them, or build your own from scratch.

## CLI Reference

Expand Down
2 changes: 1 addition & 1 deletion packages/platform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export AGENTFORGE_STATE_STORE=postgres
export AGENTFORGE_POSTGRES_URL=postgres://user:pass@localhost:5432/agentforge
export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318

npx agentforge dashboard
npx @mandarnilange/agentforge dashboard
```

### Docker (Full Stack)
Expand Down