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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
- **Substrate now auto-runs in Claude Code.** The `UserPromptSubmit` hook injects the full substrate advisory (assumption gate + model routing + blast radius + memory + verify) when it matters, silent otherwise. Load-only — never builds/writes `.forge/` from a hook, fail-safe, never blocks.
- **Cross-tool auto-use.** Added a `substrate` section to `source/rules.json` so `forge init` emits the "run substrate before risky work" rule into every tool's config (AGENTS.md, .cursor/rules, …).
- **Docs rewritten** — `docs/cognitive-substrate/README.md` is a professional, example-rich guide (real command output, auto-use setup, extension points); README/SKILL aligned.
- **README restructured** to a professional standard — clear value prop, an install matrix, quickstart, a "how it works" three-layer table, an auto-use section, a full command list, honest limits, and a docs index.
- **Install story fixed.** The recommended paths are now the **plugin** (Claude Code / Codex) and a token-free CLI install, `npm install -g github:CodeWithJuber/forgekit` — no `curl | bash`, no clone. `bash install.sh` is documented as the symlink/dev path and the GitHub Packages route as CI-only. Updated across README, ONBOARDING, `docs/cognitive-substrate/README.md`, and the landing page.
- **New `docs/GUIDE.md`** — the complete guide: every command with a worked example and its real output, the everyday workflow, auto-use inside an agent, recipes, and how to extend each layer (rules, tools, guards, crew, routing signals, emitters, rebrand).
- **Landing page** — install snippet uses the token-free CLI command; version string corrected to 0.3.1.

### Fixed

Expand Down
22 changes: 16 additions & 6 deletions ONBOARDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,23 @@

## 1. Install (once)

Pick one — no `curl | bash`, no clone required for either:

```bash
bash install.sh # symlink global/ → ~/.forge + ~/.claude, put `forge` on PATH
# then merge the printed hooks/statusline block into ~/.claude/settings.json
# — or skip that and install the plugin, which auto-wires the guards:
# /plugin marketplace add <this-repo> → /plugin install forgekit
# A) Claude Code / Codex — the plugin (recommended; guards auto-wire, nothing to merge)
/plugin marketplace add CodeWithJuber/forgekit
/plugin install forgekit

# B) Any tool — the CLI (no token, no clone)
npm install -g github:CodeWithJuber/forgekit

forge doctor # everything green?
```

Hacking on Forge itself? Clone and `npm link`, or `bash install.sh` to symlink the
tree into `~/.claude` (idempotent, reversible, prints the hook block to merge). See
[README → Install](README.md#install) for the full matrix.

## 2. Configure a repo (once per repo)

```bash
Expand Down Expand Up @@ -120,5 +129,6 @@ file memory, not weight-level learning.
- **Add a guard** → `global/guards/<name>.sh` (source `_guardlib.sh` for fields + the lock), then wire it in `global/settings.template.json` and `hooks/hooks.json`.
- **Rebrand** → edit `brand.json` (+ `package.json` bin, `.claude-plugin/plugin.json` name).

Full architecture, the pain-point evidence, and the cross-tool matrix live in
[ARCHITECTURE.md](ARCHITECTURE.md).
Every command with worked examples and the full extension guide live in
[docs/GUIDE.md](docs/GUIDE.md); the architecture, pain-point evidence, and cross-tool
matrix live in [ARCHITECTURE.md](ARCHITECTURE.md).
Loading
Loading