create-team-foundry 1.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.
Files changed (3) hide show
  1. package/README.md +91 -0
  2. package/dist/index.js +2932 -0
  3. package/package.json +40 -0
package/README.md ADDED
@@ -0,0 +1,91 @@
1
+ # team-foundry
2
+
3
+ **Give your AI coding tool the context it needs to be a real product partner.**
4
+
5
+ `npx create-team-foundry` scaffolds a `team-foundry/` directory of structured files — outcomes, customers, decisions, quality bar, strategy — in a format that Claude Code, Gemini CLI, and other AI tools read natively as context.
6
+
7
+ ```
8
+ npx create-team-foundry
9
+ ```
10
+
11
+ That's it. Answer 4 questions. Files appear in your repo.
12
+
13
+ **Run this in your shared product/engineering repo** — the one the whole team commits to. That's how everyone's AI tool picks up the same context automatically. Running it in a personal or feature branch repo works for solo use but misses the point for teams.
14
+
15
+ ---
16
+
17
+ ## What it does
18
+
19
+ Most teams use AI tools for code. The AI gives better answers when it knows what the product is for, who the customers are, and what quality means to this team.
20
+
21
+ team-foundry puts that context in your shared repo — not in a wiki, not in Notion, not in someone's head. Every team member's AI tool reads the same files every session, automatically.
22
+
23
+ It also installs a coach: a set of behaviors that notice when your files go stale, when your roadmap outpaces your assumptions, or when your strategy has drifted from your execution. The coach flags gaps inline while you work. You confirm; it writes.
24
+
25
+ ## What gets created
26
+
27
+ **Solo profile (1–3 people):** 7 files. Identity, north star, outcomes, customers, stack, coach.
28
+
29
+ **Full profile (4–15 people):** 15 files. Everything above plus strategy, roadmap, assumptions, risks, trio, working agreement, AI practices, quality bar, decisions log, design principles, metrics, glossary, stakeholders.
30
+
31
+ Every file has YAML frontmatter (`purpose`, `read_when`, `last_updated`) so the AI knows when to load it and why.
32
+
33
+ ## The honest note
34
+
35
+ team-foundry enables the work of building a shared understanding of your product. It doesn't replace it. If your team isn't willing to have the hard conversations about outcomes, customers, and quality — no tool fixes that. What team-foundry does is make those conversations easier to start, and easier to keep current.
36
+
37
+ ## Strategy in Git
38
+
39
+ Putting strategy and product context in a repo might feel wrong. A few things worth knowing:
40
+
41
+ - The `.gitignore` template excludes `team-foundry/private/` by default — put sensitive material there
42
+ - During setup you choose repo visibility (public / internal / private) and the coach adjusts its language accordingly
43
+ - Nothing in the generated files requires sensitive data — personas use first names, metrics use your definitions, decisions record rationale not revenue
44
+
45
+ If your repo is public and you're concerned, use the solo profile and keep customers.md to job roles rather than names.
46
+
47
+ ## The coach
48
+
49
+ The coach lives in `.team-foundry/coach.md` and is loaded on demand to preserve token budget. It runs in three modes:
50
+
51
+ - **Inline** — silent by default. If the AI notices a clear gap in a team-foundry file while answering a normal question, it surfaces it in one sentence and moves on. It does not interrupt coding sessions.
52
+ - **Explicit** — triggered by "let's do a team-foundry review," runs a full audit across all files
53
+ - **Scheduled** — proactive weekly check-in, surfaces top 3 findings
54
+
55
+ The coach never writes without your confirmation.
56
+
57
+ ### Triggering the coach
58
+
59
+ Say any of these to your AI tool:
60
+
61
+ | What to say | What happens |
62
+ |---|---|
63
+ | `"let's do a team-foundry review"` | Full audit — all files checked, findings listed |
64
+ | `"coach mode"` | Same as above |
65
+ | `"review our outcomes"` | Targeted review of one file |
66
+ | `"what's missing from team-foundry?"` | Lists gaps across all files |
67
+ | `"run the weekly team-foundry review"` | Weekly check-in, top 3 issues |
68
+
69
+ ### Turning off inline nudges
70
+
71
+ If you find the inline nudges too frequent, add this to your `CLAUDE.md` (or `GEMINI.md`):
72
+
73
+ ```
74
+ ## team-foundry coach
75
+ inline-nudges: off
76
+ ```
77
+
78
+ The coach will then only run when you explicitly ask for it.
79
+
80
+ ## Requirements
81
+
82
+ - Node 18+
83
+ - Claude Code, Gemini CLI, or any AI tool that reads files from your repo as context
84
+
85
+ ## Contributing
86
+
87
+ See [CONTRIBUTING.md](CONTRIBUTING.md).
88
+
89
+ ## License
90
+
91
+ MIT