forgetrail 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTINUATION_PROMPT.md +42 -0
- package/INITIAL_PROMPT.md +214 -0
- package/LICENSE +201 -0
- package/README.md +198 -0
- package/TRACKING_SCHEMA.md +162 -0
- package/TRY_FORGETRAIL.md +78 -0
- package/WORKFLOW.md +921 -0
- package/content/AGENT_INTEGRATION_claude.md +38 -0
- package/content/AGENT_INTEGRATION_cursor.md +53 -0
- package/content/AGENT_INTEGRATION_generic.md +50 -0
- package/content/AGENT_INTEGRATION_grok.md +82 -0
- package/content/DEV_AUTOMATION_SCRIPTS.md +103 -0
- package/content/FORGETRAIL_LITE.md +1202 -0
- package/content/FORGETRAIL_LITE_UPDATES.md +13 -0
- package/content/FORGETRAIL_PROGRESS.md +26 -0
- package/content/GENESIS_SPEC_PROMPT.md +70 -0
- package/content/GENESIS_STUB.md +18 -0
- package/content/GREENFIELD_INTAKE.md +76 -0
- package/content/KICKOFF_WITHOUT_MCP.md +16 -0
- package/content/LITE_WORKFLOW_TRACKING.json +42 -0
- package/content/NEW_PROJECT_BOOTSTRAP.md +180 -0
- package/content/ONE_CLICK_DEV_SETUP.md +142 -0
- package/content/PLAN_MODE_PATTERNS.md +43 -0
- package/content/POCKETBASE_SCHEMA_SCRIPT.md +52 -0
- package/content/POST_BOOTSTRAP_USER_MESSAGE.md +51 -0
- package/content/SCAFFOLD_INSTALL.json +110 -0
- package/content/SESSION_RESUME_MCP.md +35 -0
- package/content/SYSTEM_HEALTH_CHECKS.md +131 -0
- package/content/USER_REPLY_FORMAT.md +41 -0
- package/content/cursor-rules/forgetrail-lessons-gate.mdc +30 -0
- package/content/cursor-rules/forgetrail-lessons-mcp.mdc +24 -0
- package/content/cursor-rules/forgetrail-no-trailer.mdc +49 -0
- package/content/cursor-rules/forgetrail-phase-status.mdc +61 -0
- package/content/cursor-rules/forgetrail-updates-log.mdc +30 -0
- package/content/cursor-rules/spec-completion.mdc +33 -0
- package/content/cursor-rules/specs-and-todo.mdc +26 -0
- package/content/cursor-rules/url-host-matching.mdc +31 -0
- package/content/cursor-rules/us-english.mdc +9 -0
- package/content/cursor-rules/user-facing-content.mdc +31 -0
- package/content/examples/GENESIS_SAMPLE_mars-habitat-roster.md +154 -0
- package/content/forgetrail-workspace-README.md +43 -0
- package/content/scripts/forgetrail-dev-launcher.mjs +208 -0
- package/content/scripts/forgetrail-env.mjs +51 -0
- package/content/scripts/setup-ollama.mjs +207 -0
- package/content/scripts/setup-pocketbase.mjs +133 -0
- package/content/scripts/test-ollama.mjs +71 -0
- package/content/scripts/test-pocketbase.mjs +110 -0
- package/content/skills/forgetrail/SKILL.md +92 -0
- package/docs/AUTOMATED_TESTING.md +269 -0
- package/docs/BLACK_HAT_REPORT.md +143 -0
- package/docs/BRAND_AND_PRODUCT.md +381 -0
- package/docs/BUGS.md +62 -0
- package/docs/BUSINESS_PLAN.md +256 -0
- package/docs/CODE_QUALITY.md +170 -0
- package/docs/CONTEXT_PROMPT.md +357 -0
- package/docs/DEPLOYMENT.md +181 -0
- package/docs/DESIGN_SYSTEM.md +414 -0
- package/docs/DEV_ESTIMATE.md +127 -0
- package/docs/FORGETRAIL_RENAME.md +193 -0
- package/docs/IDEAS.md +19 -0
- package/docs/MARKETING_GROWTH.md +301 -0
- package/docs/NAMING_EXPLORATION.md +406 -0
- package/docs/NPM.md +98 -0
- package/docs/PHASE_1_BRIEF.md +161 -0
- package/docs/README.md +75 -0
- package/docs/SPEC_FEATURE_TEMPLATE.md +155 -0
- package/docs/SPEC_UI_CHROME_NAV_TEMPLATE.md +48 -0
- package/docs/TECHNICAL_REFERENCE.md +836 -0
- package/docs/TEST_PLAN.md +467 -0
- package/docs/TODO.md +125 -0
- package/package.json +68 -0
- package/prompts/black-hat-audit.md +235 -0
- package/prompts/brand-copy-edit-pass.md +55 -0
- package/prompts/cialdini-marketing-audit.md +141 -0
- package/prompts/competitor-deep-dive.md +201 -0
- package/prompts/docs-alignment-audit.md +108 -0
- package/prompts/engineering-skill-library.md +75 -0
- package/prompts/landing-page-rewrite.md +63 -0
- package/prompts/microcopy-centralization.md +128 -0
- package/prompts/panel-usability-audit.md +197 -0
- package/prompts/personal-beta-outreach.md +195 -0
- package/prompts/pre-launch-audit.md +148 -0
- package/prompts/product-feedback-to-spec.md +76 -0
- package/prompts/propagate-to-forgetrail.md +315 -0
- package/prompts/user-facing-content-sync-audit.md +200 -0
- package/prompts/ux-cohesion-audit.md +165 -0
- package/scripts/ensure-lease.mjs +23 -0
- package/scripts/forgetrail-cli.mjs +85 -0
- package/scripts/install-forgetrail-lite.mjs +11 -0
- package/scripts/install-forgetrail.mjs +11 -0
- package/scripts/install-lib.mjs +115 -0
- package/scripts/install.mjs +163 -0
- package/scripts/link-global.mjs +100 -0
- package/scripts/mcp-lib.mjs +177 -0
- package/scripts/mcp-status.mjs +155 -0
- package/scripts/publish-gate.mjs +110 -0
- package/scripts/rename-to-forgetrail.mjs +273 -0
- package/workflow_tracking.json +124 -0
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
> **App projects only.** Paste this file into a coding-agent chat to **resume an app** that already uses ForgeTrail.
|
|
2
|
+
> If you are working in the **ForgeTrail methodology repo** itself, stop and read `RESUME.md` (and `TODO.md`). Do not follow the steps below here.
|
|
3
|
+
|
|
4
|
+
## Instructions
|
|
5
|
+
|
|
6
|
+
I'm continuing work on [APP NAME]. You are following ForgeTrail, a structured phase-based development workflow. Your job is to track progress and pause at phase transitions for my approval before advancing.
|
|
7
|
+
|
|
8
|
+
### MCP-first (no `_forgetrail/` in this repo)
|
|
9
|
+
|
|
10
|
+
**Before doing anything else:**
|
|
11
|
+
|
|
12
|
+
1. Call ForgeTrail MCP **`getResumeSessionInstructions`** and follow it.
|
|
13
|
+
2. Read **`.forgetrail/workflow_tracking.json`**. If phase is **1-architecture**, read **`docs/PHASE_1_BRIEF.md`**. Otherwise read **`CONTEXT_PROMPT.md`** (if Phase 2+ but CONTEXT is missing and the brief exists, **merge the brief into CONTEXT** first per the CONTEXT_PROMPT template).
|
|
14
|
+
3. Use **`getPhaseGuidance`** for the current phase, **`getTrackingSchema`** when updating tracking, and other ForgeTrail MCP tools as needed.
|
|
15
|
+
|
|
16
|
+
### Local `_forgetrail/` folder
|
|
17
|
+
|
|
18
|
+
> **Path note:** ForgeTrail files live in `_forgetrail/` by default. If the folder is elsewhere (e.g., a sibling `forgetrail/` directory), adjust paths accordingly.
|
|
19
|
+
|
|
20
|
+
**Before doing anything else:**
|
|
21
|
+
|
|
22
|
+
1. Read **`.forgetrail/workflow_tracking.json`** to see where we left off.
|
|
23
|
+
2. Read `_forgetrail/WORKFLOW.md` for the full phase map, playbooks, and patterns.
|
|
24
|
+
3. Read `_forgetrail/TRACKING_SCHEMA.md` to understand how to update the tracking file.
|
|
25
|
+
4. Read `CONTEXT_PROMPT.md` for the current architecture and project state — or **`docs/PHASE_1_BRIEF.md`** if still in Phase 1; if Phase 2+ and CONTEXT is empty but the brief exists, merge brief → CONTEXT first.
|
|
26
|
+
|
|
27
|
+
**Rules for this session:**
|
|
28
|
+
|
|
29
|
+
- When you believe a phase's exit criteria are met, tell me explicitly: "I think we've completed [Phase X]. The exit criteria are met because [reasons]. Ready to move to [Phase Y]?" Wait for my confirmation.
|
|
30
|
+
- After completing work, update **`.forgetrail/workflow_tracking.json`** following the structure in `_forgetrail/TRACKING_SCHEMA.md`: move satisfied exit criteria, add decisions to the `decisions` array (with rationale), log issues to the `gotchas` array, and add session notes.
|
|
31
|
+
- Keep `CONTEXT_PROMPT.md` updated as the source of truth for project architecture.
|
|
32
|
+
- If something isn't working after 5 turns, propose a fundamentally different approach rather than continuing to patch.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Session Context
|
|
37
|
+
|
|
38
|
+
**Last session we completed:** _______________
|
|
39
|
+
|
|
40
|
+
**Today I want to focus on:** _______________
|
|
41
|
+
|
|
42
|
+
**Any new context or changes since last session:** _______________
|
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
> **App projects only.** Paste this file into a coding-agent chat to **start an app** that uses ForgeTrail.
|
|
2
|
+
> If you are working in the **ForgeTrail methodology repo** itself, stop and read `RESUME.md` (and `TODO.md`). Do not follow the steps below here.
|
|
3
|
+
|
|
4
|
+
## Instructions
|
|
5
|
+
|
|
6
|
+
You are helping me build a full-stack web application. I use ForgeTrail, a structured phase-based development workflow refined across multiple projects. Your job is to follow this workflow, track progress, and pause at phase transitions for my approval before advancing.
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
### MCP-first (recommended — no `_forgetrail/` copy in this repo)
|
|
11
|
+
|
|
12
|
+
If **ForgeTrail is connected as an MCP server**, do **not** require a local `_forgetrail/` folder. Methodology, templates, and audits stay in the MCP server (open-source ForgeTrail install); persist only **`.forgetrail/workflow_tracking.json`** and optional Cursor rules in this repo.
|
|
13
|
+
|
|
14
|
+
**Before doing anything else:**
|
|
15
|
+
|
|
16
|
+
0. If **`docs/GENESIS.md`** exists, call **`ingestPlanArtifact`** with its contents and review the draft brief before scaffolding. If the user only has an idea, offer **`getGenesisSpecPrompt`** (they save as `docs/GENESIS.md`) or point them at **TRY_FORGETRAIL.md** when MCP is not the entry path.
|
|
17
|
+
1. Call the ForgeTrail MCP tool **`getNewProjectKickoff`** (set **`includeCursorRule`** to **false** if not using Cursor). Write **`.forgetrail/workflow_tracking.json`** and the Cursor rule when included; keep the **first reply to the user** short per the bundle’s post-bootstrap section (no MCP tool list or raw JSON dump). **Alternatively:** call **`getNewProjectBootstrap`**, **`getInitialWorkflowTracking`**, **`getPostBootstrapUserMessage`**, and **`getForgeTrailCursorPhaseRule`** separately.
|
|
18
|
+
2. In Phase 1, call **`getGreenfieldIntakePrompt`** alongside **`getChecklist`** (`before-session-1`) so exports (PDF / DOCX / PPTX, etc.), tenancy (e.g. consultants × clients), hybrid vs full spec, compliance tier, and hero flow are captured early in **`PHASE_1_BRIEF.md`** and **`decisions[]`** (skip questions already answered in Genesis).
|
|
19
|
+
3. Use **`getProgressiveDocSchedule`**, **`getPhaseGuidance`**, **`getChecklist`**, **`getTemplate`** (include **`PHASE_1_BRIEF`** in Phase 1; use `mode: "shell"` or `full` as needed), **`getTrackingSchema`**, **`runAudit`**, **`searchLessons`**, and **`getAntiPatterns`** as that bootstrap describes.
|
|
20
|
+
4. We're starting with Phase 1 (Architecture + Planning).
|
|
21
|
+
|
|
22
|
+
**Replies to me:** When presenting several options or a default order of work, follow ForgeTrail **`USER_REPLY_FORMAT.md`** (or MCP **`getUserReplyFormat`**): **numbered** lists for pipelines, **bullets** for parallel items, **letters** for pick-one—don’t bury multiple paths in one long sentence.
|
|
23
|
+
|
|
24
|
+
**Phase 2 scaffolding (when you reach it):** If the stack includes **scripted PocketBase setup**, call **`getScaffoldInstallParams`** and align **`scripts/scaffold-defaults.json`** with the returned JSON — then have the user run **`pnpm install && pnpm run setup:pocketbase`** (or **`pnpm run bootstrap`**) **in the terminal** instead of generating many small files in the IDE. Put the **PocketBase HTTP port and public URL in `.env` / `.env.example`** (e.g. `PUBLIC_POCKETBASE_URL=http://127.0.0.1:8096`); the user may have **other PocketBase processes** (other projects) already on the default **8090**, so a fixed port in env keeps the `serve` script, the SvelteKit client, and schema scripts in sync. Prefer a **`pocketbase:schema`** (or similar) script that applies collections using **`POCKETBASE_ADMIN_EMAIL` / `POCKETBASE_ADMIN_PASSWORD`** from `.env` (see ForgeTrail **`POCKETBASE_SCHEMA_SCRIPT.md`** via the scaffold JSON **`schemaAutomation`** block) instead of manual Admin UI for each collection. For **repeatable dev setup** (env check, codegen, seed, E2E browsers, git hooks), follow ForgeTrail **`DEV_AUTOMATION_SCRIPTS.md`** and the **`devAutomation`** block in the same **`getScaffoldInstallParams`** output.
|
|
25
|
+
|
|
26
|
+
**Optional — JSON seed/fixture data from any LLM:** The user can generate structured JSON in **another** LLM chat (or the same one), save it under e.g. `data/` or `fixtures/`, and ask you to validate and import. Use the copy-paste prompt in **`content/FORGETRAIL_LITE.md` §4.3** (template-in-repo: `_forgetrail/content/FORGETRAIL_LITE.md`); **validate** all such JSON at the boundary before writing to a DB.
|
|
27
|
+
|
|
28
|
+
**Optional — web search (live data):** If the app needs **up-to-date web search**, the user can sign up for **[Tavily](https://tavily.com/)** and/or the **[Brave Search API](https://api-dashboard.search.brave.com/)** (free or entry-level credits — see vendor pricing), add the key to **`.env`**, and ask you to wire **server-side** calls only. **`FORGETRAIL_LITE.md` §4.4** has the full note; log provider choice in **`decisions[]`**.
|
|
29
|
+
|
|
30
|
+
**Phase 1 — project archetype:** classify the project as **`product`** (default — full 7-phase lifecycle), **`internal-tool`** (Phase 6 optional; Phase 7 drops payments/business-plan/marketing criteria), or **`one-shot`** (gift / event / demo — phases 5–7 collapse into one polish-and-ship gate). Infer from my description and confirm rather than interrogate. Record in **`PHASE_1_BRIEF.md`**, **`decisions[]`**, and **`project.archetype`** in the tracking file; **prune** the non-applicable exit criteria from the tracking template and log the pruning as a decision. See **WORKFLOW.md §1d**. When the project **ends**, run the **wrap protocol** (WORKFLOW.md §1e): harvest `gotchas[]` + `decisions[]` for generalizable lessons, propagate them, set `project.status` to `"wrapped"`.
|
|
31
|
+
|
|
32
|
+
**Phase 1 — state persistence (web apps):** before locking PocketBase + auth, ask me *"Does any state need to outlive this browser — accounts, cross-device sync, shared data — or is per-user state fine in `localStorage`?"* If **local-only**: drop PocketBase + auth, target `adapter-static`, no deploy-time secrets. If **persistent**: full Default-A stack. Record the answer in **`PHASE_1_BRIEF.md` §4 (`State persistence:`)** and **`decisions[]`**. See **`FORGETRAIL_LITE.md` §7** (A-local vs A-persistent).
|
|
33
|
+
|
|
34
|
+
**Phase 1 — content-generation pattern (only if content is LLM-produced):** if any v1 content is produced by an LLM (rather than hand-authored or from a conventional non-LLM API), pick **one** of three patterns **before scaffolding** — it drives deploy model, cost, and secret management:
|
|
35
|
+
|
|
36
|
+
- **Runtime LLM API** — server route calls the provider per request; rate limits + streaming UX; requires server runtime. **Cloud** (OpenAI, Anthropic, …): API key in `.env`. **Local Ollama:** `OLLAMA_BASE_URL` + `OLLAMA_MODEL` — Phase 2 adds **`setup-ollama`** / **`test-ollama`** (see **`SYSTEM_HEALTH_CHECKS.md`**, **`FORGETRAIL_LITE.md` §4.8**); default Granite 4.1 / Gemma 3, not thinking models unless I explicitly need them.
|
|
37
|
+
- **Build-time LLM generation** — `pnpm run seed` calls the provider once, writes JSON into `data/`, commits it; zero runtime LLM cost; pairs with `adapter-static`. Seed may use cloud APIs or the same Ollama env.
|
|
38
|
+
- **BYO-LLM paste** — prompt in the repo; I run it in any LLM chat (including local Ollama) and paste JSON into `data/seed.json`; Zod validates at app start; zero project-level API keys.
|
|
39
|
+
|
|
40
|
+
Record pattern, provider (e.g. `ollama/ibm/granite4.1:8b`), env var names, paths, and validator in **`PHASE_1_BRIEF.md`** (content-generation section) and **`decisions[]`**. See **`FORGETRAIL_LITE.md` §7.1** for OpenAI, Ollama, seed, and BYO skeletons.
|
|
41
|
+
|
|
42
|
+
**External listing/article URLs (if the hero flow imports from pasted URLs):** follow **`FORGETRAIL_LITE.md` §7.2** — layered fetch and parse, **don’t blame users** for correct URLs when selectors rot, optional **single** structured **verbatim** recover from stripped page text (env-gated). Expand into **`docs/TECHNICAL_REFERENCE.md`** using the ForgeTrail template subsection on deterministic extractors vs markup drift.
|
|
43
|
+
|
|
44
|
+
**Git commits:** use `git commit -F <file>` or plain `-m`; no unrequested attribution trailers (`Made-with:`, `Co-Authored-By:`, etc.). **Git 2.32.0+** (2021) supports `--trailer` natively — not a compatibility problem on current Git. **Pre-2.32 only:** if commit fails with `unknown option 'trailer'`, use `bash -c "git commit -F path/to/msg.txt"` or upgrade Git. See **`FORGETRAIL_LITE.md` §8.9**.
|
|
45
|
+
|
|
46
|
+
Skip the **“copy-paste paths”** section below unless we are using a **local** ForgeTrail folder.
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
### Local `_forgetrail/` folder (template-in-repo mode)
|
|
51
|
+
|
|
52
|
+
> **Path note:** ForgeTrail files live in `_forgetrail/` by default. If you placed the folder elsewhere (e.g., a sibling `forgetrail/` directory), adjust paths accordingly.
|
|
53
|
+
|
|
54
|
+
**Before doing anything else:**
|
|
55
|
+
|
|
56
|
+
1. Read `_forgetrail/WORKFLOW.md` to understand the full phase map, playbooks, and patterns.
|
|
57
|
+
2. Read `_forgetrail/TRACKING_SCHEMA.md` to understand the tracking file structure before updating it.
|
|
58
|
+
3. Read **`.forgetrail/workflow_tracking.json`** to see current project state.
|
|
59
|
+
4. If using **Cursor**, copy **`_forgetrail/content/cursor-rules/forgetrail-phase-status.mdc`** to **`.cursor/rules/forgetrail-phase-status.mdc`** (create folders if needed) so agents surface phase / next actions from `.forgetrail/workflow_tracking.json`.
|
|
60
|
+
5. We're starting with Phase 1 (Architecture + Planning).
|
|
61
|
+
|
|
62
|
+
**Rules for every session:**
|
|
63
|
+
|
|
64
|
+
- At the start of each session, read `.forgetrail/workflow_tracking.json` and `CONTEXT_PROMPT.md` (if it exists).
|
|
65
|
+
- When you believe a phase's exit criteria are met, tell me explicitly: "I think we've completed [Phase X]. The exit criteria are met because [reasons]. Ready to move to [Phase Y]?" Wait for my confirmation.
|
|
66
|
+
- After completing work, update `.forgetrail/workflow_tracking.json` following the structure in `TRACKING_SCHEMA.md`: move satisfied exit criteria, add decisions to the `decisions` array (with rationale), log issues to the `gotchas` array, and add session notes.
|
|
67
|
+
- During Phase 1, create and lock **`docs/PHASE_1_BRIEF.md`**; mirror major decisions in **`decisions[]`**.
|
|
68
|
+
- When we create `CONTEXT_PROMPT.md` (Phase 2), **merge `PHASE_1_BRIEF.md` into it** first (see template), then keep it updated as the source of truth.
|
|
69
|
+
- If something isn't working after 5 turns, propose a fundamentally different approach rather than continuing to patch.
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## About This Project
|
|
74
|
+
|
|
75
|
+
### What I'm Building
|
|
76
|
+
|
|
77
|
+
**App name:** **\*\***\_\_\_**\*\***
|
|
78
|
+
|
|
79
|
+
**One-sentence description:** **\*\***\_\_\_**\*\***
|
|
80
|
+
|
|
81
|
+
**The problem it solves:** **\*\***\_\_\_**\*\***
|
|
82
|
+
|
|
83
|
+
**Who it's for:** **\*\***\_\_\_**\*\***
|
|
84
|
+
|
|
85
|
+
**The single most important workflow it must support (the "hero flow"):**
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
### What Exists Already
|
|
90
|
+
|
|
91
|
+
_Delete any that don't apply._
|
|
92
|
+
|
|
93
|
+
- **Existing data/content that needs importing:** **\*\***\_\_\_**\*\***
|
|
94
|
+
- **Existing templates or assets:** **\*\***\_\_\_**\*\***
|
|
95
|
+
- **Existing systems this replaces or integrates with:** **\*\***\_\_\_**\*\***
|
|
96
|
+
- **Nothing. Greenfield project.**
|
|
97
|
+
|
|
98
|
+
### Tech Stack
|
|
99
|
+
|
|
100
|
+
_These are my defaults. Use them unless the project specifically demands something else, and if so, explain why._
|
|
101
|
+
|
|
102
|
+
**Framework:** SvelteKit (Svelte 5)
|
|
103
|
+
|
|
104
|
+
**Language:** TypeScript (strict, no implicit any)
|
|
105
|
+
|
|
106
|
+
**Package manager:** pnpm
|
|
107
|
+
|
|
108
|
+
**Styling:** Tailwind CSS
|
|
109
|
+
|
|
110
|
+
**Icons:** Iconify (@iconify/svelte) with Lucide icon set. No emoji in UI.
|
|
111
|
+
|
|
112
|
+
**Database/Authentication/File Storage:** PocketBase
|
|
113
|
+
|
|
114
|
+
**AI/LLM integration:** Claude API via @anthropic-ai/sdk _(or note deviation)_
|
|
115
|
+
|
|
116
|
+
**Deployment:** DigitalOcean + GitHub Actions + Caddy reverse proxy
|
|
117
|
+
|
|
118
|
+
**Deviations from defaults (if any):**
|
|
119
|
+
|
|
120
|
+
---
|
|
121
|
+
|
|
122
|
+
**Additional dependencies or constraints:**
|
|
123
|
+
|
|
124
|
+
---
|
|
125
|
+
|
|
126
|
+
### Code Conventions
|
|
127
|
+
|
|
128
|
+
_These apply to every project. Claude should follow these without being reminded._
|
|
129
|
+
|
|
130
|
+
- Create a `config.ts` to centralize all hardcoded values (app name, file conventions, brand colors, etc.). One edit, one place.
|
|
131
|
+
- Consolidate shared constants (status color maps, enums) into type files with both Tailwind classes and hex values. Import everywhere, duplicate nowhere.
|
|
132
|
+
- Custom SVG favicon, never emoji.
|
|
133
|
+
- API error responses must include actual error details (paths, messages, context), not just status codes or counts.
|
|
134
|
+
- Server modules in `src/lib/server/`, API routes in `src/routes/api/`, components in `src/lib/components/`, types in `src/lib/types/`.
|
|
135
|
+
|
|
136
|
+
### Aesthetic Direction
|
|
137
|
+
|
|
138
|
+
_Defaults below. Override per-project as needed._
|
|
139
|
+
|
|
140
|
+
- Dark theme by default, with light mode toggle
|
|
141
|
+
- Clean, functional UI. No component library; build custom with Tailwind.
|
|
142
|
+
- Empty states should have personality, not just "No items found."
|
|
143
|
+
|
|
144
|
+
**Additional aesthetic notes for this project:**
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
### V1 Scope Boundaries
|
|
149
|
+
|
|
150
|
+
**Must have for v1:**
|
|
151
|
+
|
|
152
|
+
- ***
|
|
153
|
+
- ***
|
|
154
|
+
- ***
|
|
155
|
+
|
|
156
|
+
**Explicitly NOT in v1:**
|
|
157
|
+
|
|
158
|
+
- ***
|
|
159
|
+
- ***
|
|
160
|
+
|
|
161
|
+
**Constraints:**
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
|
|
167
|
+
## First Session: What Should Happen
|
|
168
|
+
|
|
169
|
+
Phase 1 (Architecture + Planning):
|
|
170
|
+
|
|
171
|
+
- Summarize your understanding of the project and make suggestions before building anything.
|
|
172
|
+
- Propose: folder structure, data model, tech choices, migration path for existing data (if any).
|
|
173
|
+
- Identify the hardest integration points.
|
|
174
|
+
- Recommend what to skip for v1.
|
|
175
|
+
- Wait for my confirmation on every architectural decision.
|
|
176
|
+
- Create **`docs/PHASE_1_BRIEF.md`** from the ForgeTrail template (`_forgetrail/docs/` or MCP **`getTemplate("PHASE_1_BRIEF")`**). Fill and **lock** it before we exit Phase 1.
|
|
177
|
+
- Record major commitments in **`.forgetrail/workflow_tracking.json`** → **`decisions[]`** (and phase notes) so the next session does not depend on chat history.
|
|
178
|
+
|
|
179
|
+
Phase 2 (Scaffolding + Core Build):
|
|
180
|
+
|
|
181
|
+
- Only after I've confirmed the architecture and the brief is locked.
|
|
182
|
+
- Read **`PHASE_1_BRIEF.md`** and **`.forgetrail/workflow_tracking.json`** first.
|
|
183
|
+
- Build the **entire app skeleton in one pass**: project init, dependencies, services, routes, components — **do not defer the runnable spine or hero flow**.
|
|
184
|
+
- Include an import script if there's existing data.
|
|
185
|
+
- Wire up the hero flow end to end.
|
|
186
|
+
- Create `.env.example`, `.gitignore`.
|
|
187
|
+
- **Documentation (progressive — see WORKFLOW.md §1a or ForgeTrail MCP `getProgressiveDocSchedule`):** In Phase 2, create **only** these four from ForgeTrail templates — **either** copy from `_forgetrail/docs/` **or** use MCP **`getTemplate`** (`CONTEXT_PROMPT`, `README`, `TODO`, `IDEAS`):
|
|
188
|
+
- `CONTEXT_PROMPT.md` — **merge content from `PHASE_1_BRIEF.md`** into the appropriate sections using the “Handoff from Phase 1” table in the template, then add patterns as needed.
|
|
189
|
+
- `README.md` (setup instructions)
|
|
190
|
+
- `TODO.md` (initial backlog; seed from brief §11)
|
|
191
|
+
- `.forgetrail/IDEAS.md` (parking lot — capture ideas here instead of cluttering the backlog)
|
|
192
|
+
- **Do not** create the rest of the ForgeTrail doc library in Phase 2 (e.g. `BRAND_AND_PRODUCT`, `CODE_QUALITY`, `DEPLOYMENT`) unless I explicitly need one to finish the spine. Add other templates **in later phases** when that work starts (`TECHNICAL_REFERENCE`, `TEST_PLAN`, `DESIGN_SYSTEM` in Phase 4+ as warranted; brand/strategy docs in Phase 6; hardening docs in Phase 7). Phase 6 may add an optional internal **`FEATURE_CATALOG.md`** and periodic **`user-facing-content-sync-audit`** when the product map is large.
|
|
193
|
+
- Reusable audit prompts: `_forgetrail/prompts/` **or** ForgeTrail MCP **`runAudit`** (security, pre-launch, docs alignment, user-facing content sync, brand copy, landing page, Cialdini, competitor, propagate-to-forgetrail, engineering-skill-library).
|
|
194
|
+
|
|
195
|
+
Then pause and ask if I want to continue to Phase 3 (Bug Fixing + Environment Stabilization).
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
|
|
199
|
+
## Phase Transition Reference
|
|
200
|
+
|
|
201
|
+
Quick reference for when you're deciding whether to approve a phase transition:
|
|
202
|
+
|
|
203
|
+
| From | To | You should feel... |
|
|
204
|
+
| ----------------- | ----------------- | -------------------------------------------------------------------------- |
|
|
205
|
+
| Architecture | Scaffolding | Confident in tech choices, data model, and folder structure |
|
|
206
|
+
| Scaffolding | Stabilization | App runs, shows real data, hero flow works roughly |
|
|
207
|
+
| Stabilization | Feature Iteration | Core workflow completes without infrastructure errors |
|
|
208
|
+
| Feature Iteration | Strategic Review | Core features are functionally complete, TODO has 20+ items |
|
|
209
|
+
| Feature Iteration | Refactoring | A file exceeds ~500 lines, or you're editing the same pattern in 3+ places |
|
|
210
|
+
| Refactoring | Feature Iteration | Build passes, no stale references, shared utilities extracted |
|
|
211
|
+
| Strategic Review | Feature Iteration | TODO is reorganized by priority, you know what to build next |
|
|
212
|
+
| Any phase | Hardening | Features are stable, you're thinking about other people using it |
|
|
213
|
+
|
|
214
|
+
**Note:** Phases 4 (Feature Iteration) and 5 (Refactoring) commonly alternate. A typical path: 4 -> 5 -> 4 -> 6 -> 4 -> 7. This is normal, not a sign of problems.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works, within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works, or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Catalyst Forge, LLC
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
# ForgeTrail
|
|
2
|
+
|
|
3
|
+
[](LICENSE)
|
|
4
|
+
[](https://www.npmjs.com/package/forgetrail)
|
|
5
|
+
[](https://www.npmjs.com/package/forgetrail-mcp)
|
|
6
|
+
|
|
7
|
+
**Forge the path. Keep the trail.**
|
|
8
|
+
|
|
9
|
+
A persistent development system for building software with AI agents.
|
|
10
|
+
|
|
11
|
+
**ForgeTrail** gives solo developers (and small teams) a 7-phase playbook so agents plan before they build, keep the trail of decisions across sessions, and leave structured knowledge that improves the next project.
|
|
12
|
+
|
|
13
|
+
**Who it is for:** builders using Cursor, Claude Code, Codex, or similar agents who want structure without a heavyweight process.
|
|
14
|
+
|
|
15
|
+
**Why it works:** phases with exit criteria, a live `.forgetrail/workflow_tracking.json`, and templates pre-loaded with production lessons. Each project leaves a trail of decisions, gotchas, and breadcrumbs that future work can follow.
|
|
16
|
+
|
|
17
|
+
**Try it now (no MCP):** [TRY_FORGETRAIL.md](TRY_FORGETRAIL.md): write a `docs/GENESIS.md` in any AI chat, drop in ForgeTrail Lite, paste one kickoff line into your coding agent.
|
|
18
|
+
|
|
19
|
+
Site: [forgetrail.dev](https://forgetrail.dev). Open source under [Apache License 2.0](LICENSE). Distilled from [Exec Foundry](https://execfoundry.com) and refined across about a dozen further projects. Built by [Catalyst Forge](https://catalystforge.com).
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Quickstart (ranked)
|
|
24
|
+
|
|
25
|
+
### 1. Try (no MCP): start here
|
|
26
|
+
|
|
27
|
+
Follow **[TRY_FORGETRAIL.md](TRY_FORGETRAIL.md)** (~15 minutes of setup, plus time to iterate your spec):
|
|
28
|
+
|
|
29
|
+
1. Paste the [Genesis prompt](content/GENESIS_SPEC_PROMPT.md) into ChatGPT, Claude, Grok, or a local Ollama UI.
|
|
30
|
+
2. Save the result as `docs/GENESIS.md` in a **new empty project folder**.
|
|
31
|
+
3. Add [ForgeTrail Lite](content/FORGETRAIL_LITE.md) as `.forgetrail/FORGETRAIL_LITE.md`. If you have Node 20+: `npx forgetrail install --lite --with-genesis-stub`.
|
|
32
|
+
4. Paste the kickoff line from TRY_FORGETRAIL.md into your coding agent. Approve the Phase 1 brief before any scaffold.
|
|
33
|
+
|
|
34
|
+
Optional shape reference (fiction): [Mars habitat duty roster](content/examples/GENESIS_SAMPLE_mars-habitat-roster.md).
|
|
35
|
+
|
|
36
|
+
Stuck? Use the [Try ForgeTrail checklist](https://github.com/Catalyst-Forge-LLC/forgetrail/issues/new?template=try-forgetrail-checklist.md) issue template.
|
|
37
|
+
|
|
38
|
+
### 2. MCP (Cursor / Claude power users)
|
|
39
|
+
|
|
40
|
+
Installer and MCP bins are on npm. This is a channel, not a library: do not add `forgetrail` to an app’s `dependencies`.
|
|
41
|
+
|
|
42
|
+
```json
|
|
43
|
+
{
|
|
44
|
+
"mcpServers": {
|
|
45
|
+
"forgetrail": {
|
|
46
|
+
"command": "npx",
|
|
47
|
+
"args": ["-y", "forgetrail-mcp"],
|
|
48
|
+
"env": {
|
|
49
|
+
"FORGETRAIL_ROOT": "/absolute/path/to/forgetrail-or-node_modules/forgetrail"
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
If `forgetrail` is installed in the same tree as the MCP package, you can omit `FORGETRAIL_ROOT`. From a clone instead: `pnpm run mcp:build`. Details: [mcp-server/README.md](mcp-server/README.md).
|
|
57
|
+
|
|
58
|
+
First chat: *"Call `getNewProjectKickoff` and set up the project."* Resume later with *"Call `getResumeSessionInstructions`."*
|
|
59
|
+
|
|
60
|
+
### 3. Full / vendored methodology
|
|
61
|
+
|
|
62
|
+
Need the whole template tree on disk (offline, no MCP):
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
npx forgetrail install --lite --with-genesis-stub
|
|
66
|
+
npx forgetrail install
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
From a clone: `pnpm run link:global`, then the same `forgetrail install` commands. Or copy this repo into the app as `_forgetrail/` and use [INITIAL_PROMPT.md](INITIAL_PROMPT.md).
|
|
70
|
+
|
|
71
|
+
**Graduation:** Try (copy Lite) → `npx forgetrail install --lite` → `npx -y forgetrail-mcp` → full `_forgetrail/` only when you need vendored templates. Details in [TRY_FORGETRAIL.md](TRY_FORGETRAIL.md).
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## The 7 phases (short)
|
|
76
|
+
|
|
77
|
+
| Phase | Name | What happens |
|
|
78
|
+
| ----- | ---- | ------------ |
|
|
79
|
+
| 1 | **Plan** | Lock architecture in `PHASE_1_BRIEF.md` before code |
|
|
80
|
+
| 2 | **Build** | Full runnable spine in one pass |
|
|
81
|
+
| 3 | **Stabilize** | Env, paths, auth: make the foundation solid |
|
|
82
|
+
| 4 | **Iterate** | Feature by feature with real data |
|
|
83
|
+
| 5 | **Refine** | Systematic cleanup before complexity owns you |
|
|
84
|
+
| 6 | **Align** | Cut what does not serve the product vision |
|
|
85
|
+
| 7 | **Harden** | Security, performance, production docs |
|
|
86
|
+
|
|
87
|
+
Phases 4 and 5 often alternate. Full playbooks: [WORKFLOW.md](WORKFLOW.md). Docs arrive progressively (brief first; no empty boilerplate day one).
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## Why ForgeTrail
|
|
92
|
+
|
|
93
|
+
Most AI chats forget. ForgeTrail keeps **phase state**, **decisions**, and **gotchas** in the repo, and leaves a trail of lessons the next build can follow via [prompts/propagate-to-forgetrail.md](prompts/propagate-to-forgetrail.md) ([update-log.md](update-log.md)).
|
|
94
|
+
|
|
95
|
+
| Framework | Core idea | Where ForgeTrail differs |
|
|
96
|
+
|-----------|-----------|------------------------|
|
|
97
|
+
| **GitHub Spec Kit** | Gated specify → plan → tasks | Templates arrive **pre-loaded with production lessons** and keep absorbing new ones |
|
|
98
|
+
| **BMAD-Method** | Many agent personas | One developer + one agent; invests in **lifecycle memory**, not persona breadth |
|
|
99
|
+
| **OpenSpec** | Change deltas in an existing repo | Complementary: OpenSpec for changes; ForgeTrail for the **whole product lifecycle** |
|
|
100
|
+
| **Per-project retros** | Lessons in one repo's instruction file | ForgeTrail propagation is **cross-project** |
|
|
101
|
+
|
|
102
|
+
ForgeTrail earns its weight when you build **repeatedly**. For a single gated change, Spec Kit or OpenSpec may be enough.
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## How to use it (deeper)
|
|
107
|
+
|
|
108
|
+
### MCP details
|
|
109
|
+
|
|
110
|
+
The MCP server exposes methodology to Cursor, Claude Desktop, Claude Code, Windsurf, and other MCP clients without copying ForgeTrail into the app repo.
|
|
111
|
+
|
|
112
|
+
1. Enable the server ([mcp-server/README.md](mcp-server/README.md)).
|
|
113
|
+
2. Call `getNewProjectKickoff` (or use Genesis + `ingestPlanArtifact` if you already have `docs/GENESIS.md`).
|
|
114
|
+
3. In Phase 1, use `getGreenfieldIntakePrompt` with `getChecklist(before-session-1)` for exports, tenancy, compliance, and hero flow.
|
|
115
|
+
4. Your app repo keeps **your code**, **your docs**, and **`.forgetrail/workflow_tracking.json`**.
|
|
116
|
+
|
|
117
|
+
### Template-in-repo
|
|
118
|
+
|
|
119
|
+
1. Copy this folder as `_forgetrail/` (or keep it as a sibling and adjust paths in `INITIAL_PROMPT.md`).
|
|
120
|
+
2. Paste `INITIAL_PROMPT.md` into the first agent chat; fill bracketed placeholders.
|
|
121
|
+
3. Resume later with `CONTINUATION_PROMPT.md`.
|
|
122
|
+
|
|
123
|
+
### Optional patterns (when your brief needs them)
|
|
124
|
+
|
|
125
|
+
- **Seed / fixture JSON from any LLM:** [FORGETRAIL_LITE.md](content/FORGETRAIL_LITE.md) §4.3; also WORKFLOW.md Phase 2.
|
|
126
|
+
- **Live web search (Tavily, Brave, …):** [FORGETRAIL_LITE.md](content/FORGETRAIL_LITE.md) §4.4.
|
|
127
|
+
- **LLM-backed content (runtime / build-time / BYO-LLM):** [FORGETRAIL_LITE.md](content/FORGETRAIL_LITE.md) §7.1; local Ollama: §4.8 and [SYSTEM_HEALTH_CHECKS.md](content/SYSTEM_HEALTH_CHECKS.md).
|
|
128
|
+
- **URL import / markup drift:** Lite §7.2; [docs/TECHNICAL_REFERENCE.md](docs/TECHNICAL_REFERENCE.md).
|
|
129
|
+
- **Web app state: local vs accounts:** Lite §7 (A-local vs A-persistent).
|
|
130
|
+
- **Local PocketBase:** port in `.env`; version at install ([ONE_CLICK_DEV_SETUP.md](content/ONE_CLICK_DEV_SETUP.md)).
|
|
131
|
+
- **gstack:** ForgeTrail owns lifecycle; gstack owns sprint skills. WORKFLOW.md §1b.
|
|
132
|
+
- **Propagate lessons back:** [prompts/propagate-to-forgetrail.md](prompts/propagate-to-forgetrail.md); wrap protocol in WORKFLOW.md §1e.
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## What your project looks like
|
|
137
|
+
|
|
138
|
+
After Phase 2, a typical app repo:
|
|
139
|
+
|
|
140
|
+
```
|
|
141
|
+
my-app/
|
|
142
|
+
.forgetrail/
|
|
143
|
+
workflow_tracking.json ← Live progress (AI-updated)
|
|
144
|
+
FORGETRAIL_LITE.md ← If you used the Try / Lite path
|
|
145
|
+
IDEAS.md
|
|
146
|
+
CONTEXT_PROMPT.md
|
|
147
|
+
docs/
|
|
148
|
+
GENESIS.md ← Optional pre-Phase-1 "what, not how" spec
|
|
149
|
+
PHASE_1_BRIEF.md
|
|
150
|
+
README.md
|
|
151
|
+
TODO.md
|
|
152
|
+
src/
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
Later phases add docs only when needed (`TECHNICAL_REFERENCE`, `DESIGN_SYSTEM`, `BRAND_AND_PRODUCT`, hardening docs, …).
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
## What's in the box
|
|
160
|
+
|
|
161
|
+
```
|
|
162
|
+
forgetrail/ ← clone folder; product name is ForgeTrail
|
|
163
|
+
RESUME.md ← Resume *this* methodology repo (not an app)
|
|
164
|
+
TRY_FORGETRAIL.md ← Human prove-it path (start here)
|
|
165
|
+
WORKFLOW.md ← 7-phase lifecycle
|
|
166
|
+
INITIAL_PROMPT.md ← App starter prompt (do not use on this repo)
|
|
167
|
+
CONTINUATION_PROMPT.md ← App resume prompt (do not use on this repo)
|
|
168
|
+
site/ ← forgetrail.dev (FilePress + Wrangler)
|
|
169
|
+
TRACKING_SCHEMA.md
|
|
170
|
+
update-log.md
|
|
171
|
+
content/
|
|
172
|
+
GENESIS_SPEC_PROMPT.md ← Paste into any LLM chat
|
|
173
|
+
FORGETRAIL_LITE.md ← Portable single-file protocol
|
|
174
|
+
examples/ ← Sample Genesis (Mars roster, fiction)
|
|
175
|
+
docs/ ← Phase templates (brief, SPEC_FEATURE_TEMPLATE, audits, …)
|
|
176
|
+
prompts/ ← Audits, marketing, propagate-to-forgetrail, …
|
|
177
|
+
mcp-server/ ← MCP server (see mcp-server/README.md)
|
|
178
|
+
specs/ ← ForgeTrail meta-specs (including NUX)
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
Doc templates use `[BRACKETED]` placeholders and callouts (💡 lesson, 📝 example, 🔧 guidance). MCP can serve **shell** or **full** mode: [mcp-server/TEMPLATE_STRIPPING.md](mcp-server/TEMPLATE_STRIPPING.md). Methodology is **stack-agnostic**; embedded lessons lean SvelteKit + PocketBase + common LLM providers (including local Ollama).
|
|
182
|
+
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
## Prerequisites
|
|
186
|
+
|
|
187
|
+
- **Try path:** any LLM chat + any file-reading coding agent. No Node/MCP required to start.
|
|
188
|
+
- **MCP:** Node.js to run the server; Cursor, Claude Desktop, Claude Code, Windsurf, or other MCP clients.
|
|
189
|
+
- **Lite / full greenfield (when the agent scaffolds):** Git, Node.js 20+, npm, pnpm (Lite §4.1). Phase 2 adds stack-specific checks (PocketBase, Ollama, Playwright, …) per [FORGETRAIL_LITE.md](content/FORGETRAIL_LITE.md) §4.1.2.
|
|
190
|
+
- **gstack (optional):** [gstack](https://github.com/garrytan/gstack) for sprint skills inside ForgeTrail phases.
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
|
|
194
|
+
## License and support
|
|
195
|
+
|
|
196
|
+
**Apache License 2.0.** See [LICENSE](LICENSE). Contribute via [CONTRIBUTING.md](CONTRIBUTING.md). Security: [SECURITY.md](SECURITY.md).
|
|
197
|
+
|
|
198
|
+
**Support:** community best-effort via GitHub issues (including the [Try checklist](https://github.com/Catalyst-Forge-LLC/forgetrail/issues/new?template=try-forgetrail-checklist.md)). No SLA or paid support bundled with the license.
|