@x12i/xops-docs 0.1.3 → 0.1.4
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/dist/generated/bundle.d.ts +54 -0
- package/dist/generated/bundle.js +63 -9
- package/package.json +8 -3
|
@@ -105,6 +105,12 @@ export declare const useCases: {
|
|
|
105
105
|
readonly chapters: readonly ["the-mental-model", "one-contract-three-interfaces", "what-xops-owns", "hard-product-rules", "which-book-next"];
|
|
106
106
|
}];
|
|
107
107
|
readonly alsoSee: readonly ["00-platform-overview"];
|
|
108
|
+
readonly prerequisites: readonly [];
|
|
109
|
+
readonly successCriteria: readonly [];
|
|
110
|
+
readonly nextUseCases: readonly [];
|
|
111
|
+
readonly scenarioIds: readonly [];
|
|
112
|
+
readonly guideIds: readonly [];
|
|
113
|
+
readonly troubleshooting: readonly [];
|
|
108
114
|
}, {
|
|
109
115
|
readonly id: "install-and-doctor";
|
|
110
116
|
readonly title: "Install xops and run doctor";
|
|
@@ -117,6 +123,12 @@ export declare const useCases: {
|
|
|
117
123
|
readonly chapters: readonly ["install-the-cli", "confirm-on-path", "run-doctor", "workspace-install-once"];
|
|
118
124
|
}];
|
|
119
125
|
readonly alsoSee: readonly ["01-install-and-daily", "04-ops-and-tools"];
|
|
126
|
+
readonly prerequisites: readonly [];
|
|
127
|
+
readonly successCriteria: readonly [];
|
|
128
|
+
readonly nextUseCases: readonly [];
|
|
129
|
+
readonly scenarioIds: readonly [];
|
|
130
|
+
readonly guideIds: readonly [];
|
|
131
|
+
readonly troubleshooting: readonly [];
|
|
120
132
|
}, {
|
|
121
133
|
readonly id: "run-a-safe-release";
|
|
122
134
|
readonly title: "Run a safe release";
|
|
@@ -129,6 +141,12 @@ export declare const useCases: {
|
|
|
129
141
|
readonly chapters: readonly ["discovery-and-order", "safety-gates", "publish-and-push", "undo-and-recovery"];
|
|
130
142
|
}];
|
|
131
143
|
readonly alsoSee: readonly ["02-release-and-publish", "05-agents-and-safety"];
|
|
144
|
+
readonly prerequisites: readonly [];
|
|
145
|
+
readonly successCriteria: readonly [];
|
|
146
|
+
readonly nextUseCases: readonly [];
|
|
147
|
+
readonly scenarioIds: readonly [];
|
|
148
|
+
readonly guideIds: readonly [];
|
|
149
|
+
readonly troubleshooting: readonly [];
|
|
132
150
|
}, {
|
|
133
151
|
readonly id: "wire-sdk-or-mcp";
|
|
134
152
|
readonly title: "Wire the SDK or MCP";
|
|
@@ -141,6 +159,12 @@ export declare const useCases: {
|
|
|
141
159
|
readonly chapters: readonly ["ask-and-passthrough", "typed-sdk-results", "mcp-tools-and-resources", "plan-first-approvals"];
|
|
142
160
|
}];
|
|
143
161
|
readonly alsoSee: readonly ["03-cli-sdk-mcp", "05-agents-and-safety"];
|
|
162
|
+
readonly prerequisites: readonly [];
|
|
163
|
+
readonly successCriteria: readonly [];
|
|
164
|
+
readonly nextUseCases: readonly [];
|
|
165
|
+
readonly scenarioIds: readonly [];
|
|
166
|
+
readonly guideIds: readonly [];
|
|
167
|
+
readonly troubleshooting: readonly [];
|
|
144
168
|
}, {
|
|
145
169
|
readonly id: "operate-the-tool-catalog";
|
|
146
170
|
readonly title: "Operate the tool catalog";
|
|
@@ -153,6 +177,12 @@ export declare const useCases: {
|
|
|
153
177
|
readonly chapters: readonly ["ops-status", "recommendations", "seamless-tools", "playbooks"];
|
|
154
178
|
}];
|
|
155
179
|
readonly alsoSee: readonly ["04-ops-and-tools", "00-platform-overview"];
|
|
180
|
+
readonly prerequisites: readonly [];
|
|
181
|
+
readonly successCriteria: readonly [];
|
|
182
|
+
readonly nextUseCases: readonly [];
|
|
183
|
+
readonly scenarioIds: readonly [];
|
|
184
|
+
readonly guideIds: readonly [];
|
|
185
|
+
readonly troubleshooting: readonly [];
|
|
156
186
|
}, {
|
|
157
187
|
readonly id: "brief-a-coding-agent";
|
|
158
188
|
readonly title: "Brief a coding agent";
|
|
@@ -165,6 +195,12 @@ export declare const useCases: {
|
|
|
165
195
|
readonly chapters: readonly ["ai-packs", "agent-call-shape", "publish-and-secret-safety", "knowledge-sdk"];
|
|
166
196
|
}];
|
|
167
197
|
readonly alsoSee: readonly ["05-agents-and-safety", "03-cli-sdk-mcp"];
|
|
198
|
+
readonly prerequisites: readonly [];
|
|
199
|
+
readonly successCriteria: readonly [];
|
|
200
|
+
readonly nextUseCases: readonly [];
|
|
201
|
+
readonly scenarioIds: readonly [];
|
|
202
|
+
readonly guideIds: readonly [];
|
|
203
|
+
readonly troubleshooting: readonly [];
|
|
168
204
|
}];
|
|
169
205
|
};
|
|
170
206
|
export declare const site: {
|
|
@@ -341,5 +377,23 @@ export declare const manifest: {
|
|
|
341
377
|
readonly chapters: readonly ["ai-packs", "agent-call-shape", "publish-and-secret-safety", "knowledge-sdk"];
|
|
342
378
|
}];
|
|
343
379
|
}];
|
|
380
|
+
readonly indexes: {
|
|
381
|
+
readonly indexMd: "INDEX.md";
|
|
382
|
+
readonly searchJson: "SEARCH.json";
|
|
383
|
+
};
|
|
384
|
+
readonly concepts: readonly [];
|
|
385
|
+
readonly guides: readonly [];
|
|
386
|
+
readonly scenarios: readonly [];
|
|
387
|
+
readonly decisions: readonly [];
|
|
388
|
+
readonly glossary: readonly [];
|
|
389
|
+
readonly visuals: readonly [];
|
|
390
|
+
readonly diagrams: readonly [];
|
|
391
|
+
readonly relationships: readonly [];
|
|
392
|
+
readonly tutorials: readonly [];
|
|
393
|
+
readonly examples: readonly [];
|
|
394
|
+
readonly sampleData: readonly [];
|
|
395
|
+
readonly uiClients: readonly [];
|
|
396
|
+
readonly apis: readonly [];
|
|
397
|
+
readonly packs: readonly [];
|
|
344
398
|
};
|
|
345
399
|
export declare const files: Record<string, string>;
|
package/dist/generated/bundle.js
CHANGED
|
@@ -171,7 +171,13 @@ export const useCases = {
|
|
|
171
171
|
],
|
|
172
172
|
"alsoSee": [
|
|
173
173
|
"00-platform-overview"
|
|
174
|
-
]
|
|
174
|
+
],
|
|
175
|
+
"prerequisites": [],
|
|
176
|
+
"successCriteria": [],
|
|
177
|
+
"nextUseCases": [],
|
|
178
|
+
"scenarioIds": [],
|
|
179
|
+
"guideIds": [],
|
|
180
|
+
"troubleshooting": []
|
|
175
181
|
},
|
|
176
182
|
{
|
|
177
183
|
"id": "install-and-doctor",
|
|
@@ -200,7 +206,13 @@ export const useCases = {
|
|
|
200
206
|
"alsoSee": [
|
|
201
207
|
"01-install-and-daily",
|
|
202
208
|
"04-ops-and-tools"
|
|
203
|
-
]
|
|
209
|
+
],
|
|
210
|
+
"prerequisites": [],
|
|
211
|
+
"successCriteria": [],
|
|
212
|
+
"nextUseCases": [],
|
|
213
|
+
"scenarioIds": [],
|
|
214
|
+
"guideIds": [],
|
|
215
|
+
"troubleshooting": []
|
|
204
216
|
},
|
|
205
217
|
{
|
|
206
218
|
"id": "run-a-safe-release",
|
|
@@ -228,7 +240,13 @@ export const useCases = {
|
|
|
228
240
|
"alsoSee": [
|
|
229
241
|
"02-release-and-publish",
|
|
230
242
|
"05-agents-and-safety"
|
|
231
|
-
]
|
|
243
|
+
],
|
|
244
|
+
"prerequisites": [],
|
|
245
|
+
"successCriteria": [],
|
|
246
|
+
"nextUseCases": [],
|
|
247
|
+
"scenarioIds": [],
|
|
248
|
+
"guideIds": [],
|
|
249
|
+
"troubleshooting": []
|
|
232
250
|
},
|
|
233
251
|
{
|
|
234
252
|
"id": "wire-sdk-or-mcp",
|
|
@@ -257,7 +275,13 @@ export const useCases = {
|
|
|
257
275
|
"alsoSee": [
|
|
258
276
|
"03-cli-sdk-mcp",
|
|
259
277
|
"05-agents-and-safety"
|
|
260
|
-
]
|
|
278
|
+
],
|
|
279
|
+
"prerequisites": [],
|
|
280
|
+
"successCriteria": [],
|
|
281
|
+
"nextUseCases": [],
|
|
282
|
+
"scenarioIds": [],
|
|
283
|
+
"guideIds": [],
|
|
284
|
+
"troubleshooting": []
|
|
261
285
|
},
|
|
262
286
|
{
|
|
263
287
|
"id": "operate-the-tool-catalog",
|
|
@@ -286,7 +310,13 @@ export const useCases = {
|
|
|
286
310
|
"alsoSee": [
|
|
287
311
|
"04-ops-and-tools",
|
|
288
312
|
"00-platform-overview"
|
|
289
|
-
]
|
|
313
|
+
],
|
|
314
|
+
"prerequisites": [],
|
|
315
|
+
"successCriteria": [],
|
|
316
|
+
"nextUseCases": [],
|
|
317
|
+
"scenarioIds": [],
|
|
318
|
+
"guideIds": [],
|
|
319
|
+
"troubleshooting": []
|
|
290
320
|
},
|
|
291
321
|
{
|
|
292
322
|
"id": "brief-a-coding-agent",
|
|
@@ -315,7 +345,13 @@ export const useCases = {
|
|
|
315
345
|
"alsoSee": [
|
|
316
346
|
"05-agents-and-safety",
|
|
317
347
|
"03-cli-sdk-mcp"
|
|
318
|
-
]
|
|
348
|
+
],
|
|
349
|
+
"prerequisites": [],
|
|
350
|
+
"successCriteria": [],
|
|
351
|
+
"nextUseCases": [],
|
|
352
|
+
"scenarioIds": [],
|
|
353
|
+
"guideIds": [],
|
|
354
|
+
"troubleshooting": []
|
|
319
355
|
}
|
|
320
356
|
]
|
|
321
357
|
};
|
|
@@ -575,7 +611,25 @@ export const manifest = {
|
|
|
575
611
|
}
|
|
576
612
|
]
|
|
577
613
|
}
|
|
578
|
-
]
|
|
614
|
+
],
|
|
615
|
+
"indexes": {
|
|
616
|
+
"indexMd": "INDEX.md",
|
|
617
|
+
"searchJson": "SEARCH.json"
|
|
618
|
+
},
|
|
619
|
+
"concepts": [],
|
|
620
|
+
"guides": [],
|
|
621
|
+
"scenarios": [],
|
|
622
|
+
"decisions": [],
|
|
623
|
+
"glossary": [],
|
|
624
|
+
"visuals": [],
|
|
625
|
+
"diagrams": [],
|
|
626
|
+
"relationships": [],
|
|
627
|
+
"tutorials": [],
|
|
628
|
+
"examples": [],
|
|
629
|
+
"sampleData": [],
|
|
630
|
+
"uiClients": [],
|
|
631
|
+
"apis": [],
|
|
632
|
+
"packs": []
|
|
579
633
|
};
|
|
580
634
|
export const files = {
|
|
581
635
|
"downloads/books/00-platform-overview/builders.chapters.json": "[\n {\n \"slug\": \"preamble\",\n \"title\": \"Introduction\",\n \"level\": 2,\n \"order\": 0\n },\n {\n \"slug\": \"the-mental-model\",\n \"title\": \"The mental model\",\n \"level\": 2,\n \"order\": 1\n },\n {\n \"slug\": \"one-contract-three-interfaces\",\n \"title\": \"One contract, three interfaces\",\n \"level\": 2,\n \"order\": 2\n },\n {\n \"slug\": \"what-operators-own-day-to-day\",\n \"title\": \"What operators own day to day\",\n \"level\": 2,\n \"order\": 3\n },\n {\n \"slug\": \"hard-product-rules\",\n \"title\": \"Hard product rules\",\n \"level\": 2,\n \"order\": 4\n },\n {\n \"slug\": \"which-book-next\",\n \"title\": \"Which book next\",\n \"level\": 2,\n \"order\": 5\n }\n]",
|
|
@@ -599,7 +653,7 @@ export const files = {
|
|
|
599
653
|
"downloads/use-cases/run-a-safe-release.md": "# Run a safe release\n\n> **Use case id:** `run-a-safe-release`\n> **Goal:** Plan, approve, publish, and undo a monorepo or single-package release.\n> **Audiences:** developers\n> **Tags:** release, publish\n\n## Reading path\n\n1. **Release and Publish** (developers) → chapters: `discovery-and-order`, `safety-gates`, `publish-and-push`, `undo-and-recovery`\n\n## From: Release and Publish — Discovery and order\n\nxops discovers packages in the repo (single package, packages root, or workspaces), builds a dependency-aware publish order, and plans the release before mutating anything.\n\n```bash\nxops release --dry-run\nxops map\n```\n\nAgents and CI should prefer structured / JSON outputs and dry-run plans over scraping terminal prose.\n\n---\n\n## From: Release and Publish — Safety gates\n\nBefore publish, xops applies safety checks that include (among others):\n\n- gitignore rules for `.env*` (and related patterns)\n- pack validation so secrets and junk do not ship in the tarball\n- registry / version consistency expectations for the planned packages\n\nIf a gate fails, fix the reported issue — do not bypass with force flags unless you explicitly understand the risk.\n\n---\n\n## From: Release and Publish — Publish and push\n\nTypical human path:\n\n```bash\nxops release\n# or more explicit publish/push flows from the CLI once the plan is approved\n```\n\nTypical agent path: call the SDK / MCP release tools with an explicit approval profile. Risky operations return `approval-required` instead of blocking forever or publishing silently.\n\n---\n\n## From: Release and Publish — Undo and recovery\n\nWhen a release step needs reversal, use the product undo path rather than ad-hoc git surgery:\n\n```bash\nxops undo\n```\n\nFor install/tree corruption, prefer root reinstall hygiene (`node_modules` + lock policy) and `xops validate` / `xops validate --build` after recovery. `xops clean` clears xops state — it is not a full `node_modules` wipe unless documented otherwise.\n\n## Also see\n\n- **Release and Publish** (`02-release-and-publish`) — Discovery, dependency order, safety, publish, push, and undo for humans and agents.\n- **Agents and Safety** (`05-agents-and-safety`) — AI context packs, safety gates, and how agents should call xops without scraping terminals.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
600
654
|
"downloads/use-cases/wire-sdk-or-mcp.md": "# Wire the SDK or MCP\n\n> **Use case id:** `wire-sdk-or-mcp`\n> **Goal:** Call the same operating layer from TypeScript or an MCP host with plan-first approvals.\n> **Audiences:** developers\n> **Tags:** sdk, mcp, agents\n\n## Reading path\n\n1. **CLI, SDK, and MCP** (developers) → chapters: `ask-and-passthrough`, `typed-sdk-results`, `mcp-tools-and-resources`, `plan-first-approvals`\n\n## From: CLI, SDK, and MCP — Ask and passthrough\n\n`xops ask` resolves plain-English requests to automation, npm/pnpm, or git. Native project package-manager and git subcommands also pass through (for example `xops run build`, `xops status`).\n\n```bash\nxops ask \"show parallel branches\"\nxops ask \"is this package publishable?\"\n```\n\nPrefer ask when the caller does not know the exact verb; prefer explicit commands when the verb is known.\n\n---\n\n## From: CLI, SDK, and MCP — Typed SDK results\n\n```ts\nimport {\n detectRepository,\n runCheck,\n runAskPlan,\n runValidate,\n runRelease,\n runAiPack,\n listPlaybooks,\n planPlaybook,\n runPlaybook,\n} from \"@x12i/xops\";\n```\n\nSDK functions return structured results with issues, tool runs, recommendations, reports, repository context, duration, and stable status values. Agents should consume JSON — not scrape CLI text.\n\n---\n\n## From: CLI, SDK, and MCP — MCP tools and resources\n\n```bash\nxops mcp --stdio\nxops mcp start --stdio\nxops agent mcp --stdio\nxops agent mcp --http --port 7331 --profile readonly\nxops mcp --list-tools\nxops mcp --list-resources\n```\n\nTools cover `xops.repo.*`, `xops.pkg.*`, `xops.deps.*`, `xops.security.*`, `xops.release.*`, `xops.ai.*`, `xops.net.*`, `xops.system.*`, `xops.node.*`, `xops.tools.*`, `xops.reports.*`, `xops.playbooks.*`, and `xops.plan.*`.\n\nResources include `xops://repo/context`, `xops://tools/catalog`, `xops://playbooks/catalog`, `xops://reports/latest`, and related URIs.\n\nMCP does **not** expose unrestricted shell as its primary interface.\n\n---\n\n## From: CLI, SDK, and MCP — Plan-first approvals\n\nRisky MCP operations (mutations, publish/release, tool installation, network exposure scans) return structured `approval-required` or `authorization-required` unless the caller supplies explicit approval inputs and a profile that allows the action.\n\nSystem-native tools such as Nmap or Trivy are not silently installed; MCP returns missing-tool / setup guidance the same way the CLI agent mode does.\n\n## Also see\n\n- **CLI, SDK, and MCP** (`03-cli-sdk-mcp`) — Ask, typed SDK results, MCP tools/resources, and plan-first approvals for agents.\n- **Agents and Safety** (`05-agents-and-safety`) — AI context packs, safety gates, and how agents should call xops without scraping terminals.\n\n---\n\n_Generated use-case pack for agents and humans. See `agent-manifest.json` for discovery._\n",
|
|
601
655
|
"catalog.json": "{\"roles\":[{\"id\":\"developers\",\"label\":\"Developers\",\"tagline\":\"Run xops every day\",\"description\":\"Humans and coding agents who install, release, ask, and operate Node.js repositories through xops.\"},{\"id\":\"builders\",\"label\":\"Operators\",\"tagline\":\"Set up PATH, CI, and the operating contract\",\"description\":\"People who bootstrap the CLI, wire CI/agent hosts, and keep doctor/ops status green.\"}],\"families\":[{\"id\":\"xops\",\"name\":\"xops\",\"tagline\":\"The operating layer for Node.js repositories.\",\"description\":\"Detects repo state, routes work to native owners, plans risky actions, executes approved workflows, and reports what happened — via CLI, SDK, and MCP.\",\"color\":\"#1a2f45\"}],\"books\":[{\"id\":\"00-platform-overview\",\"familyId\":\"xops\",\"audiences\":[\"developers\",\"builders\"],\"status\":\"available\",\"kicker\":\"CASE FILE · XOPS-00\",\"title\":\"Platform Overview\",\"subtitle\":\"Mental model and surfaces\",\"blurb\":\"What xops is, the operating contract, three interfaces, and which book to open next.\",\"tags\":[\"platform\",\"start-here\"],\"color\":\"#1a2f45\",\"dir\":\"00-platform-overview\"},{\"id\":\"01-install-and-daily\",\"familyId\":\"xops\",\"audiences\":[\"developers\"],\"status\":\"available\",\"kicker\":\"CASE FILE · XOPS-01\",\"title\":\"Install and Daily CLI\",\"subtitle\":\"Get xops on PATH and use it every day\",\"blurb\":\"Global install, doctor, workspace install-once, and the daily command surface.\",\"tags\":[\"install\",\"cli\",\"workspaces\"],\"color\":\"#b14a2c\",\"dir\":\"01-install-and-daily\"},{\"id\":\"02-release-and-publish\",\"familyId\":\"xops\",\"audiences\":[\"developers\"],\"status\":\"available\",\"kicker\":\"CASE FILE · XOPS-02\",\"title\":\"Release and Publish\",\"subtitle\":\"The original wedge\",\"blurb\":\"Discovery, dependency order, safety, publish, push, and undo for humans and agents.\",\"tags\":[\"release\",\"publish\",\"safety\"],\"color\":\"#1f6e5c\",\"dir\":\"02-release-and-publish\"},{\"id\":\"03-cli-sdk-mcp\",\"familyId\":\"xops\",\"audiences\":[\"developers\"],\"status\":\"available\",\"kicker\":\"CASE FILE · XOPS-03\",\"title\":\"CLI, SDK, and MCP\",\"subtitle\":\"One contract, three interfaces\",\"blurb\":\"Ask, typed SDK results, MCP tools/resources, and plan-first approvals for agents.\",\"tags\":[\"sdk\",\"mcp\",\"ask\",\"agents\"],\"color\":\"#a5710f\",\"dir\":\"03-cli-sdk-mcp\"},{\"id\":\"04-ops-and-tools\",\"familyId\":\"xops\",\"audiences\":[\"builders\"],\"status\":\"available\",\"kicker\":\"CASE FILE · XOPS-04\",\"title\":\"Ops and Tools\",\"subtitle\":\"Catalog, recommendations, playbooks\",\"blurb\":\"ops status, recommendations, seamless tools, and operational playbooks.\",\"tags\":[\"ops\",\"tools\",\"playbooks\"],\"color\":\"#2c5f7a\",\"dir\":\"04-ops-and-tools\",\"buildersPrimary\":true},{\"id\":\"05-agents-and-safety\",\"familyId\":\"xops\",\"audiences\":[\"developers\"],\"status\":\"available\",\"kicker\":\"CASE FILE · XOPS-05\",\"title\":\"Agents and Safety\",\"subtitle\":\"Agent packs, gitignore, publish safety\",\"blurb\":\"AI context packs, safety gates, and how agents should call xops without scraping terminals.\",\"tags\":[\"agents\",\"safety\",\"ai-pack\"],\"color\":\"#4a3f6b\",\"dir\":\"05-agents-and-safety\"}]}",
|
|
602
|
-
"use-cases.json": "{\"useCases\":[{\"id\":\"orient-xops\",\"title\":\"Orient on xops\",\"goal\":\"Understand the operating layer, three interfaces, and which book to open next.\",\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"platform\",\"start-here\"],\"path\":[{\"bookId\":\"00-platform-overview\",\"audience\":\"developers\",\"chapters\":[\"the-mental-model\",\"one-contract-three-interfaces\",\"what-xops-owns\",\"hard-product-rules\",\"which-book-next\"]}],\"alsoSee\":[\"00-platform-overview\"]},{\"id\":\"install-and-doctor\",\"title\":\"Install xops and run doctor\",\"goal\":\"Get @x12i/xops on PATH, confirm shims, and clear doctor checks.\",\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"install\",\"doctor\"],\"path\":[{\"bookId\":\"01-install-and-daily\",\"audience\":\"developers\",\"chapters\":[\"install-the-cli\",\"confirm-on-path\",\"run-doctor\",\"workspace-install-once\"]}],\"alsoSee\":[\"01-install-and-daily\",\"04-ops-and-tools\"]},{\"id\":\"run-a-safe-release\",\"title\":\"Run a safe release\",\"goal\":\"Plan, approve, publish, and undo a monorepo or single-package release.\",\"audiences\":[\"developers\"],\"tags\":[\"release\",\"publish\"],\"path\":[{\"bookId\":\"02-release-and-publish\",\"audience\":\"developers\",\"chapters\":[\"discovery-and-order\",\"safety-gates\",\"publish-and-push\",\"undo-and-recovery\"]}],\"alsoSee\":[\"02-release-and-publish\",\"05-agents-and-safety\"]},{\"id\":\"wire-sdk-or-mcp\",\"title\":\"Wire the SDK or MCP\",\"goal\":\"Call the same operating layer from TypeScript or an MCP host with plan-first approvals.\",\"audiences\":[\"developers\"],\"tags\":[\"sdk\",\"mcp\",\"agents\"],\"path\":[{\"bookId\":\"03-cli-sdk-mcp\",\"audience\":\"developers\",\"chapters\":[\"ask-and-passthrough\",\"typed-sdk-results\",\"mcp-tools-and-resources\",\"plan-first-approvals\"]}],\"alsoSee\":[\"03-cli-sdk-mcp\",\"05-agents-and-safety\"]},{\"id\":\"operate-the-tool-catalog\",\"title\":\"Operate the tool catalog\",\"goal\":\"Read ops status, apply recommendations, and run playbooks without inventing a second ops stack.\",\"audiences\":[\"builders\"],\"tags\":[\"ops\",\"tools\",\"playbooks\"],\"path\":[{\"bookId\":\"04-ops-and-tools\",\"audience\":\"builders\",\"chapters\":[\"ops-status\",\"recommendations\",\"seamless-tools\",\"playbooks\"]}],\"alsoSee\":[\"04-ops-and-tools\",\"00-platform-overview\"]},{\"id\":\"brief-a-coding-agent\",\"title\":\"Brief a coding agent\",\"goal\":\"Generate AI context packs and teach an agent to use xops safely.\",\"audiences\":[\"developers\"],\"tags\":[\"agents\",\"ai-pack\",\"safety\"],\"path\":[{\"bookId\":\"05-agents-and-safety\",\"audience\":\"developers\",\"chapters\":[\"ai-packs\",\"agent-call-shape\",\"publish-and-secret-safety\",\"knowledge-sdk\"]}],\"alsoSee\":[\"05-agents-and-safety\",\"03-cli-sdk-mcp\"]}]}",
|
|
656
|
+
"use-cases.json": "{\"useCases\":[{\"id\":\"orient-xops\",\"title\":\"Orient on xops\",\"goal\":\"Understand the operating layer, three interfaces, and which book to open next.\",\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"platform\",\"start-here\"],\"path\":[{\"bookId\":\"00-platform-overview\",\"audience\":\"developers\",\"chapters\":[\"the-mental-model\",\"one-contract-three-interfaces\",\"what-xops-owns\",\"hard-product-rules\",\"which-book-next\"]}],\"alsoSee\":[\"00-platform-overview\"],\"prerequisites\":[],\"successCriteria\":[],\"nextUseCases\":[],\"scenarioIds\":[],\"guideIds\":[],\"troubleshooting\":[]},{\"id\":\"install-and-doctor\",\"title\":\"Install xops and run doctor\",\"goal\":\"Get @x12i/xops on PATH, confirm shims, and clear doctor checks.\",\"audiences\":[\"developers\",\"builders\"],\"tags\":[\"install\",\"doctor\"],\"path\":[{\"bookId\":\"01-install-and-daily\",\"audience\":\"developers\",\"chapters\":[\"install-the-cli\",\"confirm-on-path\",\"run-doctor\",\"workspace-install-once\"]}],\"alsoSee\":[\"01-install-and-daily\",\"04-ops-and-tools\"],\"prerequisites\":[],\"successCriteria\":[],\"nextUseCases\":[],\"scenarioIds\":[],\"guideIds\":[],\"troubleshooting\":[]},{\"id\":\"run-a-safe-release\",\"title\":\"Run a safe release\",\"goal\":\"Plan, approve, publish, and undo a monorepo or single-package release.\",\"audiences\":[\"developers\"],\"tags\":[\"release\",\"publish\"],\"path\":[{\"bookId\":\"02-release-and-publish\",\"audience\":\"developers\",\"chapters\":[\"discovery-and-order\",\"safety-gates\",\"publish-and-push\",\"undo-and-recovery\"]}],\"alsoSee\":[\"02-release-and-publish\",\"05-agents-and-safety\"],\"prerequisites\":[],\"successCriteria\":[],\"nextUseCases\":[],\"scenarioIds\":[],\"guideIds\":[],\"troubleshooting\":[]},{\"id\":\"wire-sdk-or-mcp\",\"title\":\"Wire the SDK or MCP\",\"goal\":\"Call the same operating layer from TypeScript or an MCP host with plan-first approvals.\",\"audiences\":[\"developers\"],\"tags\":[\"sdk\",\"mcp\",\"agents\"],\"path\":[{\"bookId\":\"03-cli-sdk-mcp\",\"audience\":\"developers\",\"chapters\":[\"ask-and-passthrough\",\"typed-sdk-results\",\"mcp-tools-and-resources\",\"plan-first-approvals\"]}],\"alsoSee\":[\"03-cli-sdk-mcp\",\"05-agents-and-safety\"],\"prerequisites\":[],\"successCriteria\":[],\"nextUseCases\":[],\"scenarioIds\":[],\"guideIds\":[],\"troubleshooting\":[]},{\"id\":\"operate-the-tool-catalog\",\"title\":\"Operate the tool catalog\",\"goal\":\"Read ops status, apply recommendations, and run playbooks without inventing a second ops stack.\",\"audiences\":[\"builders\"],\"tags\":[\"ops\",\"tools\",\"playbooks\"],\"path\":[{\"bookId\":\"04-ops-and-tools\",\"audience\":\"builders\",\"chapters\":[\"ops-status\",\"recommendations\",\"seamless-tools\",\"playbooks\"]}],\"alsoSee\":[\"04-ops-and-tools\",\"00-platform-overview\"],\"prerequisites\":[],\"successCriteria\":[],\"nextUseCases\":[],\"scenarioIds\":[],\"guideIds\":[],\"troubleshooting\":[]},{\"id\":\"brief-a-coding-agent\",\"title\":\"Brief a coding agent\",\"goal\":\"Generate AI context packs and teach an agent to use xops safely.\",\"audiences\":[\"developers\"],\"tags\":[\"agents\",\"ai-pack\",\"safety\"],\"path\":[{\"bookId\":\"05-agents-and-safety\",\"audience\":\"developers\",\"chapters\":[\"ai-packs\",\"agent-call-shape\",\"publish-and-secret-safety\",\"knowledge-sdk\"]}],\"alsoSee\":[\"05-agents-and-safety\",\"03-cli-sdk-mcp\"],\"prerequisites\":[],\"successCriteria\":[],\"nextUseCases\":[],\"scenarioIds\":[],\"guideIds\":[],\"troubleshooting\":[]}]}",
|
|
603
657
|
"site.json": "{\"product\":\"xops\",\"brand\":\"xops · docs\",\"brandAccent\":\"docs\",\"siteUrl\":\"https://docs.xops.x12i.com\",\"knowledgePackage\":\"@x12i/xops-docs\",\"footer\":\"XOPS FIELD GUIDES · OPERATING LAYER\",\"accent\":\"oklch(42% 0.09 250)\",\"accentAlt\":\"oklch(52% 0.11 35)\",\"productUrl\":\"https://github.com/x12i/npm\",\"nav\":[{\"label\":\"Getting started\",\"href\":\"/getting-started\"},{\"label\":\"Use cases\",\"href\":\"/use-cases\"},{\"label\":\"Catalog\",\"href\":\"/catalog\"}],\"footerLinks\":[{\"label\":\"Docs home\",\"href\":\"/docs\"},{\"label\":\"Getting started\",\"href\":\"/getting-started\"},{\"label\":\"Use cases\",\"href\":\"/use-cases\"},{\"label\":\"Catalog\",\"href\":\"/catalog\"},{\"label\":\"Agents/SDK\",\"href\":\"/agents\"}]}",
|
|
604
|
-
"agent-manifest.json": "{\"version\":1,\"product\":\"xops\",\"site\":\"https://docs.xops.x12i.com\",\"knowledgePackage\":\"@x12i/xops-docs\",\"roles\":[\"developers\",\"builders\"],\"books\":[{\"id\":\"00-platform-overview\",\"audiences\":[\"developers\",\"builders\"],\"md\":{\"developers\":\"downloads/books/00-platform-overview/developers.md\",\"builders\":\"downloads/books/00-platform-overview/builders.md\"},\"pdf\":{\"developers\":null,\"builders\":null},\"chapters\":{\"developers\":\"downloads/books/00-platform-overview/developers.chapters.json\",\"builders\":\"downloads/books/00-platform-overview/builders.chapters.json\"}},{\"id\":\"01-install-and-daily\",\"audiences\":[\"developers\"],\"md\":{\"developers\":\"downloads/books/01-install-and-daily/developers.md\"},\"pdf\":{\"developers\":null},\"chapters\":{\"developers\":\"downloads/books/01-install-and-daily/developers.chapters.json\"}},{\"id\":\"02-release-and-publish\",\"audiences\":[\"developers\"],\"md\":{\"developers\":\"downloads/books/02-release-and-publish/developers.md\"},\"pdf\":{\"developers\":null},\"chapters\":{\"developers\":\"downloads/books/02-release-and-publish/developers.chapters.json\"}},{\"id\":\"03-cli-sdk-mcp\",\"audiences\":[\"developers\"],\"md\":{\"developers\":\"downloads/books/03-cli-sdk-mcp/developers.md\"},\"pdf\":{\"developers\":null},\"chapters\":{\"developers\":\"downloads/books/03-cli-sdk-mcp/developers.chapters.json\"}},{\"id\":\"04-ops-and-tools\",\"audiences\":[\"builders\"],\"md\":{\"builders\":\"downloads/books/04-ops-and-tools/builders.md\"},\"pdf\":{\"builders\":null},\"chapters\":{\"builders\":\"downloads/books/04-ops-and-tools/builders.chapters.json\"}},{\"id\":\"05-agents-and-safety\",\"audiences\":[\"developers\"],\"md\":{\"developers\":\"downloads/books/05-agents-and-safety/developers.md\"},\"pdf\":{\"developers\":null},\"chapters\":{\"developers\":\"downloads/books/05-agents-and-safety/developers.chapters.json\"}}],\"useCases\":[{\"id\":\"orient-xops\",\"title\":\"Orient on xops\",\"md\":\"downloads/use-cases/orient-xops.md\",\"path\":[{\"bookId\":\"00-platform-overview\",\"audience\":\"developers\",\"chapters\":[\"the-mental-model\",\"one-contract-three-interfaces\",\"what-xops-owns\",\"hard-product-rules\",\"which-book-next\"]}]},{\"id\":\"install-and-doctor\",\"title\":\"Install xops and run doctor\",\"md\":\"downloads/use-cases/install-and-doctor.md\",\"path\":[{\"bookId\":\"01-install-and-daily\",\"audience\":\"developers\",\"chapters\":[\"install-the-cli\",\"confirm-on-path\",\"run-doctor\",\"workspace-install-once\"]}]},{\"id\":\"run-a-safe-release\",\"title\":\"Run a safe release\",\"md\":\"downloads/use-cases/run-a-safe-release.md\",\"path\":[{\"bookId\":\"02-release-and-publish\",\"audience\":\"developers\",\"chapters\":[\"discovery-and-order\",\"safety-gates\",\"publish-and-push\",\"undo-and-recovery\"]}]},{\"id\":\"wire-sdk-or-mcp\",\"title\":\"Wire the SDK or MCP\",\"md\":\"downloads/use-cases/wire-sdk-or-mcp.md\",\"path\":[{\"bookId\":\"03-cli-sdk-mcp\",\"audience\":\"developers\",\"chapters\":[\"ask-and-passthrough\",\"typed-sdk-results\",\"mcp-tools-and-resources\",\"plan-first-approvals\"]}]},{\"id\":\"operate-the-tool-catalog\",\"title\":\"Operate the tool catalog\",\"md\":\"downloads/use-cases/operate-the-tool-catalog.md\",\"path\":[{\"bookId\":\"04-ops-and-tools\",\"audience\":\"builders\",\"chapters\":[\"ops-status\",\"recommendations\",\"seamless-tools\",\"playbooks\"]}]},{\"id\":\"brief-a-coding-agent\",\"title\":\"Brief a coding agent\",\"md\":\"downloads/use-cases/brief-a-coding-agent.md\",\"path\":[{\"bookId\":\"05-agents-and-safety\",\"audience\":\"developers\",\"chapters\":[\"ai-packs\",\"agent-call-shape\",\"publish-and-secret-safety\",\"knowledge-sdk\"]}]}]}"
|
|
658
|
+
"agent-manifest.json": "{\"version\":1,\"product\":\"xops\",\"site\":\"https://docs.xops.x12i.com\",\"knowledgePackage\":\"@x12i/xops-docs\",\"roles\":[\"developers\",\"builders\"],\"books\":[{\"id\":\"00-platform-overview\",\"audiences\":[\"developers\",\"builders\"],\"md\":{\"developers\":\"downloads/books/00-platform-overview/developers.md\",\"builders\":\"downloads/books/00-platform-overview/builders.md\"},\"pdf\":{\"developers\":null,\"builders\":null},\"chapters\":{\"developers\":\"downloads/books/00-platform-overview/developers.chapters.json\",\"builders\":\"downloads/books/00-platform-overview/builders.chapters.json\"}},{\"id\":\"01-install-and-daily\",\"audiences\":[\"developers\"],\"md\":{\"developers\":\"downloads/books/01-install-and-daily/developers.md\"},\"pdf\":{\"developers\":null},\"chapters\":{\"developers\":\"downloads/books/01-install-and-daily/developers.chapters.json\"}},{\"id\":\"02-release-and-publish\",\"audiences\":[\"developers\"],\"md\":{\"developers\":\"downloads/books/02-release-and-publish/developers.md\"},\"pdf\":{\"developers\":null},\"chapters\":{\"developers\":\"downloads/books/02-release-and-publish/developers.chapters.json\"}},{\"id\":\"03-cli-sdk-mcp\",\"audiences\":[\"developers\"],\"md\":{\"developers\":\"downloads/books/03-cli-sdk-mcp/developers.md\"},\"pdf\":{\"developers\":null},\"chapters\":{\"developers\":\"downloads/books/03-cli-sdk-mcp/developers.chapters.json\"}},{\"id\":\"04-ops-and-tools\",\"audiences\":[\"builders\"],\"md\":{\"builders\":\"downloads/books/04-ops-and-tools/builders.md\"},\"pdf\":{\"builders\":null},\"chapters\":{\"builders\":\"downloads/books/04-ops-and-tools/builders.chapters.json\"}},{\"id\":\"05-agents-and-safety\",\"audiences\":[\"developers\"],\"md\":{\"developers\":\"downloads/books/05-agents-and-safety/developers.md\"},\"pdf\":{\"developers\":null},\"chapters\":{\"developers\":\"downloads/books/05-agents-and-safety/developers.chapters.json\"}}],\"useCases\":[{\"id\":\"orient-xops\",\"title\":\"Orient on xops\",\"md\":\"downloads/use-cases/orient-xops.md\",\"path\":[{\"bookId\":\"00-platform-overview\",\"audience\":\"developers\",\"chapters\":[\"the-mental-model\",\"one-contract-three-interfaces\",\"what-xops-owns\",\"hard-product-rules\",\"which-book-next\"]}]},{\"id\":\"install-and-doctor\",\"title\":\"Install xops and run doctor\",\"md\":\"downloads/use-cases/install-and-doctor.md\",\"path\":[{\"bookId\":\"01-install-and-daily\",\"audience\":\"developers\",\"chapters\":[\"install-the-cli\",\"confirm-on-path\",\"run-doctor\",\"workspace-install-once\"]}]},{\"id\":\"run-a-safe-release\",\"title\":\"Run a safe release\",\"md\":\"downloads/use-cases/run-a-safe-release.md\",\"path\":[{\"bookId\":\"02-release-and-publish\",\"audience\":\"developers\",\"chapters\":[\"discovery-and-order\",\"safety-gates\",\"publish-and-push\",\"undo-and-recovery\"]}]},{\"id\":\"wire-sdk-or-mcp\",\"title\":\"Wire the SDK or MCP\",\"md\":\"downloads/use-cases/wire-sdk-or-mcp.md\",\"path\":[{\"bookId\":\"03-cli-sdk-mcp\",\"audience\":\"developers\",\"chapters\":[\"ask-and-passthrough\",\"typed-sdk-results\",\"mcp-tools-and-resources\",\"plan-first-approvals\"]}]},{\"id\":\"operate-the-tool-catalog\",\"title\":\"Operate the tool catalog\",\"md\":\"downloads/use-cases/operate-the-tool-catalog.md\",\"path\":[{\"bookId\":\"04-ops-and-tools\",\"audience\":\"builders\",\"chapters\":[\"ops-status\",\"recommendations\",\"seamless-tools\",\"playbooks\"]}]},{\"id\":\"brief-a-coding-agent\",\"title\":\"Brief a coding agent\",\"md\":\"downloads/use-cases/brief-a-coding-agent.md\",\"path\":[{\"bookId\":\"05-agents-and-safety\",\"audience\":\"developers\",\"chapters\":[\"ai-packs\",\"agent-call-shape\",\"publish-and-secret-safety\",\"knowledge-sdk\"]}]}],\"indexes\":{\"indexMd\":\"INDEX.md\",\"searchJson\":\"SEARCH.json\"},\"concepts\":[],\"guides\":[],\"scenarios\":[],\"decisions\":[],\"glossary\":[],\"visuals\":[],\"diagrams\":[],\"relationships\":[],\"tutorials\":[],\"examples\":[],\"sampleData\":[],\"uiClients\":[],\"apis\":[],\"packs\":[]}"
|
|
605
659
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@x12i/xops-docs",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.4",
|
|
4
4
|
"description": "xops docs knowledge SDK — install as a devDependency only. Catalog, use cases, and markdown packs for humans and agents.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -29,8 +29,13 @@
|
|
|
29
29
|
"node": ">=18.0.0"
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@x12i/docify-core": "^1.
|
|
33
|
-
"@x12i/docify-sdk": "^1.0
|
|
32
|
+
"@x12i/docify-core": "^1.1.1",
|
|
33
|
+
"@x12i/docify-sdk": "^1.1.0"
|
|
34
|
+
},
|
|
35
|
+
"devDependencies": {
|
|
36
|
+
"@types/node": "^20.14.0",
|
|
37
|
+
"typescript": "^5.6.0",
|
|
38
|
+
"vitest": "^2.1.0"
|
|
34
39
|
},
|
|
35
40
|
"publishConfig": {
|
|
36
41
|
"access": "public",
|