fdeops 3.5.0 → 3.5.2

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 +64 -165
  2. package/bin/check.js +0 -6
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,8 +1,15 @@
1
- # fdeops - The Operating System for Forward Deployed Engineers
1
+ # fdeops
2
2
 
3
- > **One command. Six domains. Your second brain for client engagements.**
3
+ [![npm version](https://img.shields.io/npm/v/fdeops)](https://www.npmjs.com/package/fdeops)
4
+ [![CI](https://github.com/suboss87/fdeops/actions/workflows/validate.yml/badge.svg)](https://github.com/suboss87/fdeops/actions)
5
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
6
+ [![Node](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org)
4
7
 
5
- You type **`@fde`**, describe your situation, and the system routes to the right method - from first stakeholder meeting to final handoff. Every skill writes its output to your private engagement memory (`.fde/`), so tomorrow starts where today ended. No re-pasting context. No maintaining notes. No picking from a catalog.
8
+ You embed at a client site. You bridge strategy and code. You ship on their systems, not yours.
9
+
10
+ Every morning you open your AI coding agent, and it has no idea what happened yesterday. You re-paste the same context. You explain the stakeholders again. You remind it about the scope change from Tuesday. Meanwhile, the real problem - the one the brief didn't mention - sits undiscovered because nobody asked the right questions on day one.
11
+
12
+ **fdeops fixes this.** It gives your AI agent a complete engagement methodology and a private memory that writes itself. You type `@fde`, describe your situation, and the right method runs - from first stakeholder meeting to final handoff. Tomorrow's session starts exactly where today ended.
6
13
 
7
14
  ```mermaid
8
15
  flowchart LR
@@ -24,23 +31,24 @@ flowchart LR
24
31
 
25
32
  Works with **Claude Code** · **Cursor** · **Copilot** · **Devin** · **Gemini CLI** · any agent that reads SKILL.md
26
33
 
27
- <p align="center"><strong>The CLI (zero tokens, zero network)</strong></p>
34
+ <p align="center"><strong>The CLI</strong></p>
28
35
  <p align="center"><img src="media/terminal-demo.svg" alt="fde CLI - status, scan, dashboard" width="720"/></p>
29
36
 
30
- <p align="center"><strong>The Fieldbook Dashboard (one offline HTML file)</strong></p>
37
+ <p align="center"><strong>The Fieldbook Dashboard</strong></p>
31
38
  <p align="center"><img src="media/fieldbook-dashboard.png" alt="FDE Fieldbook - portfolio view" width="720"/></p>
32
39
 
33
40
  ---
34
41
 
35
- ## Who does what
36
-
37
- | Role | Who | What they do |
38
- |------|-----|----------------|
39
- | **You (the FDE)** | **Human** on the engagement | Stakeholder meetings, calls, judgment, sign-off, typing `@fde`, owning what ships |
40
- | **AI coding agent** | **Software** on your laptop (e.g. Claude Code) - **not** a human colleague | Loads the `@fde` skill, runs the phase methods, writes code and `.fde/` artifacts |
41
- | **`@fde`** | **One skill** inside the AI agent | Hears your situation, routes to the right phase, does that phase's work |
42
+ ## Who this is for
42
43
 
43
- **In this repo, "agent" always means the AI coding agent, never a person.**
44
+ | You are... | fdeops helps when... |
45
+ |----------|-------------------|
46
+ | **Consultant or contractor at a client site** | Every session, you re-explain context. fdeops remembers for you. |
47
+ | **Solutions architect bridging strategy and code** | You navigate politics AND architecture. fdeops has methods for both. |
48
+ | **Agency engineer running 3-5 clients** | Client details blur together. One `.fde/` per customer, never cross-contaminated. |
49
+ | **Forward Deployed Engineer** | The role this was built for. 34 skills across the full engagement lifecycle. |
50
+ | **Technical founder doing client work solo** | You ARE the team. The agent becomes your second brain. |
51
+ | **Enterprise programme lead** | Running AI transformations? Built-in methods for model selection, agent safety, governance, and cost management. |
44
52
 
45
53
  ---
46
54
 
@@ -57,6 +65,8 @@ Works with **Claude Code** · **Cursor** · **Copilot** · **Devin** · **Gemini
57
65
 
58
66
  ## Quickstart
59
67
 
68
+ **Requires:** [Node.js](https://nodejs.org) >= 18
69
+
60
70
  ```bash
61
71
  # Option A: Skills CLI (any agent)
62
72
  npx skills add suboss87/fdeops
@@ -82,11 +92,26 @@ Then talk to your agent:
82
92
  @fde I'm on site. First stakeholder meeting tomorrow. Brief says fix the payments API.
83
93
  ```
84
94
 
95
+ The system routes to `land` and starts working:
96
+ ```
97
+ Routing to: land (first engagement, day 1)
98
+
99
+ Before tomorrow's meeting, I need to understand a few things:
100
+
101
+ 1. Who owns the budget for this work? (the brief doesn't say)
102
+ 2. What's NOT in scope? (undefined scope = unlimited scope)
103
+ 3. Is there an internal dev who was passed over for this work?
104
+ 4. What's their AI policy? (do they know I'm an AI agent?)
105
+
106
+ Writing: brief.md, success.md, stakeholders.md, trust-profile.md
107
+ Next: bring answers from the meeting, then we discover the real problem.
108
+ ```
109
+
85
110
  That's it. The system takes over from there.
86
111
 
87
112
  ### Use it in any tool
88
113
 
89
- One brain (`skills/fde/SKILL.md`), a thin pointer per tool. Wire up an engagement workspace for every AI tool you use:
114
+ One skill file powers every tool. Install adapters for your setup:
90
115
 
91
116
  ```bash
92
117
  node bin/install.js adapters ~/fde-engagements/my-client
@@ -101,135 +126,40 @@ node bin/install.js adapters ~/fde-engagements/my-client
101
126
  | Cursor | `.cursor/rules/fde.mdc` |
102
127
  | GitHub Copilot | `.github/copilot-instructions.md` |
103
128
 
104
- Each file just points at `@fde` - so the method, overlays, and memory stay in one place. Details: [`adapters/`](adapters/README.md).
129
+ Each adapter points at the same `@fde` skill, so the methodology and memory stay consistent across tools. Details: [`adapters/`](adapters/README.md).
105
130
 
106
131
  ---
107
132
 
108
133
  ## How it works
109
134
 
110
135
  ```text
111
- YOU (human FDE) AI CODING AGENT (software)
112
- meetings, judgment @fde routes right skill does the work
113
- ─────► .fde/ memory (self-writing)
114
-
115
- └──────────────► client workspace (code, VPN, tickets)
136
+ YOU (human) AI CODING AGENT (software)
137
+ meetings, judgment @fde routes -> right skill -> does the work
138
+ | -----> .fde/ memory (self-writing)
139
+ | |
140
+ +---------------> client workspace (code, VPN, tickets)
116
141
  ```
117
142
 
118
- | Layer | What | Where |
119
- |-------|------|-------|
120
- | **Surface** | One command: `@fde` | You type it |
121
- | **Router** | Hears your situation, picks the skill | `SKILL.md` |
122
- | **Skills** | 34 methods across 6 domains | `references/` |
123
- | **Overlays** | Activate on signal (AI, fintech, healthcare, gov, artifacts) | Layer on top |
124
- | **Memory** | `.fde/` - engagement record, per customer | Your machine |
125
-
126
- ---
127
-
128
- ## The basic workflow
129
-
130
- You only ever type **`@fde`**. The AI coding agent reads `context.md` from your engagement folder, routes to the matching skill, and follows that skill's method:
131
-
132
143
  1. **Describe** - tell the agent what's happening ("new client", "production is down", "need a board update")
133
144
  2. **Route** - the system picks the right skill from 34 options across 6 domains
134
145
  3. **Execute** - the skill's method runs, artifacts are written to `.fde/`, you review at checkpoints
135
146
 
136
147
  ---
137
148
 
138
- ## The 6 domains
139
-
140
- ### 1. Embed & Trust
141
- *First days. Getting access, building credibility, understanding scope.*
142
-
143
- | Skill | What it does |
144
- |-------|-------------|
145
- | **land** | First 48 hours: interrogate the brief, map stakeholders, define success before code |
146
- | **audit** | Taking over mid-project: verify claims, find the load-bearing wall |
147
- | **stakeholder-radar** | Map who decides, who blocks, who's about to escalate |
148
- | **trust-engineering** | The trust ladder from observer to trusted; navigate AI policy |
149
- | **scope-defense** | "Let me place it": scope receipts, the accumulation conversation |
150
-
151
- ### 2. Discover & Diagnose
152
- *Finding the real problem. Testing what the brief claims.*
153
-
154
- | Skill | What it does |
155
- |-------|-------------|
156
- | **discover** | Scan repo + hunt the workaround + **workshop facilitation** + **data estate assessment** |
157
- | **assumption-audit** | Extract untested assumptions, classify by blast radius, kill the riskiest first |
158
- | **use-case-scoring** | Score on value × urgency × alignment × data readiness ÷ complexity |
159
- | **sketch** | Prototype the killer assumption in one day; kill fast, log the learning |
160
-
161
- ### 3. Plan & Align
162
- *Sequencing work and getting sponsor alignment.*
163
-
164
- | Skill | What it does |
165
- |-------|-------------|
166
- | **plan** | Work backwards from success + **estimation** (3-point sizing) + **migration strategy** |
167
- | **business-case** | Cost of doing nothing → investment → return → sensitivity check |
168
- | **options-analysis** | Three genuine options (conservative / pragmatic / ambitious) |
169
- | **initiative-triage** | 20 things are "urgent"; pick 3 for Now, make trade-offs visible |
170
-
171
- ### 4. Build & Guard
172
- *Safe implementation on someone else's codebase.*
173
-
174
- | Skill | What it does |
175
- |-------|-------------|
176
- | **build** | Blast radius + legacy safety + **integration design** + **team amplification** |
177
- | **incremental-build** | Vertical slices, 100–300 lines each, visible progress every 2–3 days |
178
- | **test-on-legacy** | Characterise first, Strangler Fig, spot lying tests |
179
- | **blast-radius** | Trace dependencies, classify impact (CONTAINED → IRREVERSIBLE) |
180
- | **debug** | Systematic: reproduce → isolate → one hypothesis → verify |
181
- | **rescue** | Production fire, trust fire, wrong-brief-mid-build, **or full pivot** |
182
- | **security-audit** | Threat model in 5 minutes, STRIDE pass, secrets scan |
183
- | **observability** | Define "working" before instrumenting; the four metrics |
184
-
185
- ### 5. Ship & Verify
186
- *Getting to production without surprises.*
187
-
188
- | Skill | What it does |
189
- |-------|-------------|
190
- | **ship** | Pre-flight + canary + rollback + **scale-readiness gate** + **progressive adoption** |
191
- | **review** | Scope first (did we build what was agreed), then safety |
192
- | **rollback-drill** | Test the escape route on staging before you need it at 2am |
193
- | **qa-live** | Test from the user's chair, real browser, five perspectives |
194
-
195
- ### 6. Operate & Close
196
- *Running the engagement and ending it well.*
197
-
198
- | Skill | What it does |
199
- |-------|-------------|
200
- | **status** | Sponsor update from the week's actual record |
201
- | **demo-prep** | The one number, live-vs-canned, five hard questions |
202
- | **debrief** | Walk out of any meeting → decisions, signals, actions in memory |
203
- | **exec-narrative** | Pyramid: governing thought, three supports, SCQA frame |
204
- | **dashboard** | Portfolio view across all customers, trust-ordered |
205
- | **multi-customer-ops** | Daily triage, context-switch, cross-contamination prevention |
206
- | **close** | Retrospective, the 2am handoff document, what we learned |
207
- | **handoff-engineering** | Operations runbook, knowledge transfer, confidence scoring |
208
- | **pattern-extract** | If you did it twice, encode it; patterns are compound interest |
209
-
210
- ### Overlays (activate on signal)
211
-
212
- | Overlay | Triggers on | What it adds |
213
- |---------|------------|-------------|
214
- | **ai** | AI, ML, LLM, model, embeddings, RAG, agents | Model selection, RAG architecture, agent safety, governance, drift monitoring, cost management |
215
- | **artifacts** | deck, slides, report, governance, compliance | Executive decks, governance frameworks, ADRs, compliance packs, value reports |
216
- | **fintech** | payments, PCI, banking, cardholder data | Idempotency, transaction integrity, fraud signals, silent-failure prevention |
217
- | **healthcare** | PHI, HIPAA, patient data | De-identification, minimum-necessary, audit trails |
218
- | **gov** | FedRAMP, ATO, CUI, classified | Authority boundaries, CUI marking, continuous monitoring |
149
+ ## The 6 domains — 34 skills + 5 overlays
219
150
 
220
- ---
151
+ | Domain | Skills | What it covers |
152
+ |--------|--------|---------------|
153
+ | **Embed & Trust** | land, audit, stakeholder-radar, trust-engineering, scope-defense | First days: access, credibility, scope |
154
+ | **Discover & Diagnose** | discover, assumption-audit, use-case-scoring, sketch | Finding the real problem behind the brief |
155
+ | **Plan & Align** | plan, business-case, options-analysis, initiative-triage | Sequencing work, getting sponsor alignment |
156
+ | **Build & Guard** | build, incremental-build, test-on-legacy, blast-radius, debug, rescue, security-audit, observability | Safe implementation on their codebase |
157
+ | **Ship & Verify** | ship, review, rollback-drill, qa-live | Getting to production without surprises |
158
+ | **Operate & Close** | status, demo-prep, debrief, exec-narrative, dashboard, multi-customer-ops, close, handoff-engineering, pattern-extract | Running and ending the engagement well |
221
159
 
222
- ## What makes fdeops different
160
+ **Overlays** activate automatically when your engagement involves AI projects, executive reporting, fintech, healthcare, or government compliance.
223
161
 
224
- | Other skill repos | fdeops |
225
- |---|---|
226
- | No client memory - re-paste every session | `.fde/` writes itself; next session loads automatically |
227
- | No engagement politics - pure engineering | Skills for stakeholder radar, trust, scope defense, exec narratives |
228
- | No multi-customer support | One folder per client, portfolio dashboard, hard isolation |
229
- | Flat list of skills - find it yourself | Type `@fde`, describe the situation, it routes |
230
- | Generic engineering or startup advice | FDE-specific: brownfield safety, earned access, sponsor alignment, workshop facilitation |
231
- | No document generation | **Artifacts overlay:** governance frameworks, exec decks, compliance packs, ADRs from memory |
232
- | No AI project guidance | **AI overlay:** model selection, RAG, agents, governance, drift, cost at scale |
162
+ Full skill details: [docs/skills-reference.md](docs/skills-reference.md)
233
163
 
234
164
  ---
235
165
 
@@ -250,51 +180,22 @@ Your **fieldbook** - one per client, private to you, plain markdown:
250
180
  | `risks.md` | Live risk register | all phases |
251
181
  | `delivery.md` | What shipped, business value, rollback, pulse, adoption metrics | build / ship |
252
182
 
253
- Every claim carries evidence: `(ops lead, Day 5)` · `(churn: 47/90d)` · `(stated, unverified)`.
183
+ Every claim is tagged with its source and date so you can defend it in front of skeptical stakeholders.
254
184
 
255
185
  ---
256
186
 
257
- ## The CLI (works without AI)
187
+ ## The CLI
188
+
189
+ These commands run locally on your machine. No AI needed, no API costs, works offline.
258
190
 
259
191
  ```bash
260
- fde scan # day-1 recon: hotspots × tests, "temporary" code, AI calls, secrets
192
+ fde scan # day-1 recon: hotspots, test gaps, "temporary" code, AI components, secrets
261
193
  fde resume # initialize or resume an engagement
262
194
  fde log # write decisions, risks, delivery, contacts
263
195
  fde receipts # search memory with dates
264
196
  fde capture # session-end snapshot
265
197
  fde status # portfolio triage across all customers
266
- fde dashboard # render every engagement into one offline fieldbook.html (0 tokens)
267
- ```
268
-
269
- ---
270
-
271
- ## Who this is for
272
-
273
- | You are... | fdeops helps when... |
274
- |----------|-------------------|
275
- | **New to embed work** | You get a method per phase, not just encouragement |
276
- | **Senior operator, solo on site** | The agent is your second brain: memory + grunt work |
277
- | **Multi-client consultant** | One `.fde/` per customer, never cross-contaminated |
278
- | **Running AI transformations** | AI overlay: model selection → RAG → agents → scale → governance |
279
- | **Enterprise programme lead** | Estimation, migration strategy, scale-readiness, governance artifacts |
280
-
281
- **Works with:** Claude Code, Cursor, Copilot, Windsurf, Cline, Devin, Gemini CLI - any agent that reads SKILL.md.
282
-
283
- ---
284
-
285
- ## What's inside
286
-
287
- ```
288
- bin/fde.js the CLI - deterministic core, works without AI:
289
- fde scan · resume · log · receipts · capture · status · dashboard
290
- skills/fde/
291
- SKILL.md the router: voice, memory contract, 6-domain routing
292
- references/
293
- 34 skill files one method per file
294
- 5 overlays ai.md, artifacts.md, fintech.md, healthcare.md, gov.md
295
- hooks/ session-start, session-stop, pre-compact
296
- templates/.fde/ the 10 core memory files an init creates
297
- docs/ install guides, schema, methodology
198
+ fde dashboard # render every engagement into one offline dashboard
298
199
  ```
299
200
 
300
201
  ---
@@ -308,8 +209,6 @@ docs/ install guides, schema, methodology
308
209
  - **Map before moving** - unknown terrain gets characterisation tests
309
210
  - **Thin slices** - ship learning, not theatre
310
211
  - **One customer, one folder** - context never bleeds
311
- - **AI degrades silently** - monitor outputs, not just uptime
312
- - **Scale readiness is organizational** - not just technical
313
212
 
314
213
  ---
315
214
 
@@ -323,6 +222,6 @@ cd fdeops && git pull && node bin/install.js
323
222
 
324
223
  ## Contributing
325
224
 
326
- Maintained by **Subash Natarajan**. Feedback via [Issues](https://github.com/suboss87/fdeops/issues) - see [CONTRIBUTING.md](CONTRIBUTING.md).
225
+ Maintained by **[Subash Natarajan](https://www.linkedin.com/in/subashn/)**. Feedback via [Issues](https://github.com/suboss87/fdeops/issues) - see [CONTRIBUTING.md](CONTRIBUTING.md).
327
226
 
328
- [ATTRIBUTION.md](ATTRIBUTION.md) · [SECURITY.md](SECURITY.md) · [Repo layout](docs/REPO_LAYOUT.md) · MIT
227
+ [FDE Methodology](FDE-METHODOLOGY.md) · [ATTRIBUTION.md](ATTRIBUTION.md) · [SECURITY.md](SECURITY.md) · [PRIVACY.md](PRIVACY.md) · [Repo layout](docs/REPO_LAYOUT.md) · [Skills reference](docs/skills-reference.md) · MIT
package/bin/check.js CHANGED
@@ -108,11 +108,8 @@ else ok('README no demo gif')
108
108
  for (const section of [
109
109
  'How it works',
110
110
  'Quickstart',
111
- 'The basic workflow',
112
- "What's inside",
113
111
  'Engagement memory',
114
112
  'Who this is for',
115
- 'Who does what',
116
113
  'Without fdeops vs with fdeops',
117
114
  'Principles',
118
115
  ]) {
@@ -121,9 +118,6 @@ for (const section of [
121
118
  if (!readme.includes('AI coding agent')) {
122
119
  fail('README must say AI coding agent (not ambiguous "agent")')
123
120
  }
124
- if (!/agent.*always means the AI|“agent” always means/i.test(readme)) {
125
- fail('README must define that agent means AI, not human')
126
- }
127
121
  ok('README clarity sections')
128
122
 
129
123
  if (readme.includes('your-client-repo')) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fdeops",
3
- "version": "3.5.0",
3
+ "version": "3.5.2",
4
4
  "description": "Field kit for engineers embedded in client work - a real CLI (recon, memory, portfolio), one @fde skill with field judgment on top, and hooks that make it automatic. Claude Code plugin and any agent that loads skills.",
5
5
  "bin": {
6
6
  "fdeops": "bin/install.js",