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
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Documentation

- **Visual flow diagrams in the entry-point docs.** A "one source → every tool + pre-action gate"
mermaid in `README.md` and a "your day with Forge" loop in `ONBOARDING.md` (alongside the
propose→verify diagram in the substrate README) — making the model easier to grasp at a glance,
while preserving the docs' existing dry-precise voice.

### Added

- **Uniform `--json`.** `doctor`, `route`, `preflight`, `verify`, and `scope` now accept `--json`
Expand Down
10 changes: 10 additions & 0 deletions ONBOARDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@
> agents (Claude Code, Codex, Cursor, Gemini, Aider…). Author your rules once; it
> configures every tool and adds memory, blast-radius checks, and guardrails.

```mermaid
flowchart TD
I["forge init"] --> Cfg["every tool configured<br/>from one source"]
Cfg --> Work["you work as usual"]
Work --> Gate["substrate checks each task:<br/>ask first? · which model? · what breaks?"]
Gate --> Edit["agent edits, with guardrails"]
Edit --> Learn["cortex learns from corrections"]
Learn -.->|next task is smarter| Work
```

## 1. Install (once)

The recommended paths need no token and no clone:
Expand Down
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,21 @@ a cost governor, and a **cognitive substrate** that checks a task *before* the a
touches your code. Works with **Claude Code, Codex, Cursor, Gemini, Aider, Copilot,
Windsurf, Zed, and Continue** (plus MCP config for Roo and VS Code).

```mermaid
flowchart LR
S["source/rules.json<br/>(author once)"] -->|forge sync| E{{emit}}
E --> C["CLAUDE.md"]
E --> A["AGENTS.md"]
E --> R[".cursor / .gemini<br/>.aider / …"]
E --> M["MCP config"]
S -.->|forge substrate| G["pre-action gate<br/>assumptions · route · impact · verify"]
G -.-> Agent(("your AI agent"))
C --> Agent
A --> Agent
R --> Agent
M --> Agent
```

> **Status: beta.** The core (`init`, `sync`, `substrate`, `impact`, `cortex`, guards)
> is tested and in daily use; some flags may change before `1.0`.

Expand Down
Loading