create-team-foundry 2.1.3 → 3.0.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/README.md +81 -23
- package/dist/index.js +952 -41
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# team-foundry
|
|
2
2
|
|
|
3
|
-
**Make your AI
|
|
3
|
+
**Make your AI's judgment calls match your product reality.**
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Not just the facts — the context that tells your AI which facts matter, which claims are validated, and which sources to trust when signals conflict.
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
8
|
npx create-team-foundry
|
|
@@ -13,7 +13,7 @@ If your repo already has a README and commit history, setup takes about 1 minute
|
|
|
13
13
|
|
|
14
14
|
→ **[See what it looks like when populated](example/)** — a fully filled-in team-foundry for Clearline, a fictional 8-person B2B SaaS team. Open `example/` in Claude Code or Cursor and ask anything.
|
|
15
15
|
|
|
16
|
-
**[team-foundry.com](https://team-foundry.com)** ·
|
|
16
|
+
**[team-foundry.com](https://team-foundry.com)** · We're early — [a star helps other teams find this](https://github.com/tomershahar/team-foundry).
|
|
17
17
|
|
|
18
18
|
---
|
|
19
19
|
|
|
@@ -29,20 +29,12 @@ That context used to live in someone's head, a Notion page nobody reads, or a wi
|
|
|
29
29
|
|
|
30
30
|
---
|
|
31
31
|
|
|
32
|
-
```bash
|
|
33
|
-
npx create-team-foundry
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
**Try it in 2 minutes.** Answer a few questions. Files appear. Open your AI tool. Done.
|
|
37
|
-
|
|
38
|
-
---
|
|
39
|
-
|
|
40
32
|
## Set up once. Everyone gets the same context.
|
|
41
33
|
|
|
42
34
|
**No cloud. No sync service. No extra accounts.** team-foundry uses your existing repo as the shared space.
|
|
43
35
|
|
|
44
36
|
**One person sets it up**
|
|
45
|
-
Run `npx create-team-foundry` in your shared repo. The CLI scaffolds a `team-foundry/` folder
|
|
37
|
+
Run `npx create-team-foundry` in your shared repo. The CLI scaffolds a `team-foundry/` folder and generates the right tool file (`CLAUDE.md`, `GEMINI.md`, or `.cursor/rules/`). Commit with your normal git flow and you're done.
|
|
46
38
|
|
|
47
39
|
**Everyone else pulls**
|
|
48
40
|
Teammates `git pull`. They now have the same team-foundry files locally. Their Claude Code, Cursor, or Gemini CLI reads from the same files yours does. No installs, no logins, no setup.
|
|
@@ -75,20 +67,32 @@ When someone updates a file — or the coach drafts an update they confirm — i
|
|
|
75
67
|
|
|
76
68
|
*Your repo is the shared space. Git is the sync. team-foundry adds the structure and the coach.*
|
|
77
69
|
|
|
70
|
+
<details>
|
|
71
|
+
<summary>How it fits together</summary>
|
|
72
|
+
|
|
73
|
+
| Layer | What it is | team-foundry component |
|
|
74
|
+
|---|---|---|
|
|
75
|
+
| **Context** | What your team knows | `team-foundry/` files — outcomes, customers, decisions, metrics, … |
|
|
76
|
+
| **Behavior** | How the AI acts on it | `CLAUDE.md` / `GEMINI.md` / `.cursor/rules/` + `hierarchy.md` + `instructions/` |
|
|
77
|
+
| **Actions** | What you can trigger | Coach commands, `status`, `migrate` |
|
|
78
|
+
| **Connections** | Where it runs | Git, Claude Code, Cursor, Gemini CLI, Codex / generic agents |
|
|
79
|
+
|
|
80
|
+
</details>
|
|
81
|
+
|
|
78
82
|
---
|
|
79
83
|
|
|
80
84
|
## What gets created
|
|
81
85
|
|
|
82
|
-
**Solo profile (1–3 people):**
|
|
83
|
-
**Full profile (4–15 people):**
|
|
86
|
+
**Solo profile (1–3 people):** 8 files, ~1 minute with repo scan / ~15 minutes fresh.
|
|
87
|
+
**Full profile (4–15 people):** 24 files, ~1 minute with repo scan / ~25 minutes fresh.
|
|
84
88
|
|
|
85
89
|
| Profile | Files | Includes |
|
|
86
90
|
|---|---|---|
|
|
87
|
-
| Solo |
|
|
88
|
-
| Full |
|
|
89
|
-
| Full (federated) |
|
|
91
|
+
| Solo | 8 | Root instruction file, AGENTS.md, getting started guide, coach playbook, north star, outcomes, customers, stack |
|
|
92
|
+
| Full | 24 | Everything above + strategy, roadmap, assumptions, risks, trio, working agreement, AI practices, quality bar, decisions log, design principles, metrics, glossary, stakeholders, hierarchy, hooks, rules |
|
|
93
|
+
| Full (federated) | 30 | Everything above + per-folder routing files for multi-instance setups |
|
|
90
94
|
|
|
91
|
-
Every file has YAML frontmatter (`purpose`, `read_when`, `last_updated`, `owner`) so the AI knows when to load it and why.
|
|
95
|
+
Every file has YAML frontmatter (`purpose`, `read_when`, `last_updated`, `owner`) so the AI knows when to load it and why. Data-heavy files (outcomes, customers, metrics, assumptions, roadmap) also include `source:` and `last_validated:` so the AI knows whether to trust the data.
|
|
92
96
|
|
|
93
97
|
## Supported tools
|
|
94
98
|
|
|
@@ -120,6 +124,8 @@ After setup, the coach watches your files for drift while you work. It runs in t
|
|
|
120
124
|
| **Decision amnesia** | Q1 ADR rejects microservices. Q3 discussion reopens it with no reference to what changed. |
|
|
121
125
|
| **Reality drift** | 8 PRs shipped since `outcomes.md` was last updated. Coach cites the commit messages. |
|
|
122
126
|
| **Build-trap signal** | "Add collaborative editing" moves to Now with no linked assumption and no validation. |
|
|
127
|
+
| **Unsourced claim** | A number or percentage in a data file has no `source:` value or inline attribution. |
|
|
128
|
+
| **Confidence collapse** | A hypothesis in `## Hypothesized` is referenced as fact in strategy or roadmap decisions. |
|
|
123
129
|
|
|
124
130
|
Every finding cites the specific file, the specific content, and the evidence. Not "this looks stale."
|
|
125
131
|
|
|
@@ -140,24 +146,76 @@ npx create-team-foundry status
|
|
|
140
146
|
|
|
141
147
|
Health table across all your files: last updated, days since update, PRs shipped since then, owner, health classification (ok / stale / empty / missing). Link integrity checks flag outcomes with no linked assumption, Now items with no validated bet, and metrics referenced but not defined.
|
|
142
148
|
|
|
143
|
-
|
|
149
|
+
## Migrate from v2
|
|
150
|
+
|
|
151
|
+
If you already have a v2 team-foundry, upgrade to v3 with:
|
|
144
152
|
|
|
145
153
|
```bash
|
|
146
|
-
npx create-team-foundry
|
|
154
|
+
npx create-team-foundry migrate --to v3
|
|
147
155
|
```
|
|
148
156
|
|
|
149
|
-
|
|
157
|
+
This adds the three new v3 files (`hierarchy.md`, `instructions/hooks.md`, `instructions/rules.md`) and appends `source:` / `last_validated:` to the frontmatter of your five data-heavy files. **Existing files are never overwritten.** Your content is preserved exactly — the migration is additive only.
|
|
158
|
+
|
|
159
|
+
Existing v2 repos continue to work without migrating. v3 is the new default for new repos.
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## Getting buy-in
|
|
164
|
+
|
|
165
|
+
| Objection | Response |
|
|
166
|
+
|---|---|
|
|
167
|
+
| "I don't have time to learn a new tool" | There's nothing to learn. Run one command. The files appear. Your AI tool reads them automatically — no new workflow, no new app. |
|
|
168
|
+
| "We already document things" | Documentation lives in Notion or Confluence and your AI tool has never seen it. team-foundry puts it in your repo, in plain markdown, where every AI tool reads it every session. |
|
|
169
|
+
| "I'm not technical enough" | The CLI asks plain-English questions. The files it creates are markdown. The coach speaks in sentences. No code required. |
|
|
170
|
+
| "AI output isn't good enough yet" | That's exactly what context fixes. team-foundry gives the AI your product reality so its answers are specific to your team, not generic. |
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
## What's new in v3
|
|
175
|
+
|
|
176
|
+
- **Sourced facts** — every claim in a data-heavy file has a `source:` and `last_validated:` field. The AI knows when to trust a number and when to ask where it came from.
|
|
177
|
+
- **Validated vs hypothesized** — outcomes, customers, and roadmap items are explicitly split into what's backed by evidence and what's a bet. The coach flags when a hypothesis gets treated as a fact.
|
|
178
|
+
- **Instruction architecture** — full profile gets `hierarchy.md` (which source wins when context conflicts), `instructions/hooks.md` (enforced pre-action behaviors), and `instructions/rules.md` (always-loaded coaching rules). The root file stays minimal; depth loads on demand.
|
|
179
|
+
- **Pre-built skills** (Claude Code) — six slash commands that run directly in your Claude Code session: orient to context, check status, audit files, capture learnings, draft decisions, and synthesize a feature brief. Your knowledge stays in your files — skills are just pointers, not copies.
|
|
180
|
+
|
|
181
|
+
## Advanced: Skills (Claude Code)
|
|
182
|
+
|
|
183
|
+
Six slash commands ship with every Claude Code setup. They read your team-foundry files and act on them — no extra configuration needed.
|
|
184
|
+
|
|
185
|
+
| Skill | What it does |
|
|
186
|
+
|---|---|
|
|
187
|
+
| `/team-foundry-intro` | Orient to the team — reads all context files, produces a summary |
|
|
188
|
+
| `/team-foundry-status` | Status read — what's on track, at risk, or blocked this cycle |
|
|
189
|
+
| `/team-foundry-review` | Full audit — all files checked, findings by severity |
|
|
190
|
+
| `/team-foundry-capture` | Capture what was learned in this session into the right file |
|
|
191
|
+
| `/team-foundry-decision` | Draft an ADR from the current conversation |
|
|
192
|
+
| `/team-foundry-feature` | Synthesize everything team-foundry knows about a specific feature |
|
|
193
|
+
|
|
194
|
+
**Pointers, not copies.** Skills don't duplicate your team context — they point Claude Code at the right team-foundry files and tell it what to do with them. The knowledge lives in your files. The skills just know how to read it.
|
|
195
|
+
|
|
196
|
+
## Advanced: The flywheel
|
|
197
|
+
|
|
198
|
+
The longer you use team-foundry, the more useful it gets:
|
|
199
|
+
|
|
200
|
+
1. **Set up** — scaffold files, run the interview, fill in what you know
|
|
201
|
+
2. **Work** — AI reads context, gives better answers, flags gaps inline
|
|
202
|
+
3. **Learn** — when something was decided or validated, the coach offers to capture it (`/team-foundry-capture`)
|
|
203
|
+
4. **Update** — confirm the draft, it commits to git, everyone pulls
|
|
204
|
+
5. **Review** — next session, AI reads the updated files → answers get better
|
|
205
|
+
|
|
206
|
+
Each cycle tightens the loop. The coach makes step 3→4 nearly automatic.
|
|
150
207
|
|
|
151
208
|
---
|
|
152
209
|
|
|
153
210
|
## What's next
|
|
154
211
|
|
|
155
|
-
**
|
|
212
|
+
**v3.x (planned)**
|
|
156
213
|
- `--json` output for `status` — pipe findings into CI or dashboards
|
|
157
214
|
- `--strict` mode — fail CI when critical drift is detected
|
|
215
|
+
- `--with-hooks` flag — generate real Claude Code hook scripts wired to `.claude/settings.json`
|
|
158
216
|
- MCP server — expose team-foundry context as a tool for agents that don't read files natively
|
|
159
217
|
|
|
160
|
-
**
|
|
218
|
+
**Exploring**
|
|
161
219
|
- Cross-repo federation — one team-foundry for a platform team read by multiple product repos
|
|
162
220
|
- Status webhooks — post weekly drift report to Slack without leaving the terminal
|
|
163
221
|
- Team onboarding flow — guided interview for new team members joining an existing team-foundry
|