@ghostbyte/agent-docs-kit 4.0.2 → 5.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/CHANGELOG.md +32 -0
- package/README.md +43 -37
- package/SECURITY.md +11 -0
- package/content/catalog.json +191 -22
- package/content/documentation/01-system-documentation.md +13 -0
- package/content/documentation/02-project-governance.md +13 -0
- package/content/documentation/03-development-records.md +13 -0
- package/content/documentation/04-testing-evidence.md +13 -0
- package/content/documentation/05-operations-runbooks.md +13 -0
- package/content/documentation/06-future-proposals.md +13 -0
- package/content/documentation/07-archive-governance.md +13 -0
- package/content/documentation/full-reference.md +24 -0
- package/content/engineering/01-query-performance.md +17 -27
- package/content/engineering/02-networking-fundamentals.md +17 -27
- package/content/engineering/03-rate-limiting-algorithms.md +18 -28
- package/content/engineering/04-production-debugging.md +17 -27
- package/content/engineering/05-code-review-practices.md +17 -27
- package/content/engineering/06-data-modeling.md +17 -27
- package/content/engineering/07-cloud-cost-saving.md +17 -27
- package/content/engineering/08-testing-types.md +17 -27
- package/content/engineering/09-message-queues.md +17 -27
- package/content/engineering/10-api-design-compatibility.md +14 -0
- package/content/engineering/11-reliability-slos.md +14 -0
- package/content/engineering/12-observability-telemetry.md +14 -0
- package/content/engineering/13-deployment-change-safety.md +14 -0
- package/content/engineering/14-capacity-concurrency.md +14 -0
- package/content/engineering/full-reference.md +24 -144
- package/content/security/01-design-architecture.md +11 -19
- package/content/security/02-local-development.md +13 -21
- package/content/security/03-database-backend.md +18 -26
- package/content/security/04-api-layer.md +23 -31
- package/content/security/05-frontend-ui.md +16 -24
- package/content/security/06-application-security-testing.md +22 -28
- package/content/security/07-cicd-release-engineering.md +13 -21
- package/content/security/08-cloud-infrastructure.md +17 -25
- package/content/security/09-edge-cdn-dns.md +16 -24
- package/content/security/10-release-rollout.md +13 -21
- package/content/security/11-post-release-monitoring-ir.md +15 -23
- package/content/security/12-ongoing-operations.md +24 -32
- package/content/security/full-reference.md +30 -3163
- package/docs/ARCHITECTURE.md +31 -92
- package/docs/CONTENT_MAINTENANCE.md +5 -1
- package/docs/GITHUB_AND_NPM_SETUP.md +1 -1
- package/docs/RELEASE_PROCESS.md +5 -5
- package/package.json +12 -5
- package/scripts/build-site.mjs +13 -0
- package/scripts/build-skill.mjs +24 -0
- package/scripts/check-links.mjs +56 -0
- package/scripts/check-review-dates.mjs +21 -0
- package/scripts/preview-site.mjs +43 -0
- package/scripts/smoke-package.mjs +58 -0
- package/scripts/validate-content.mjs +85 -0
- package/site/app.js +121 -0
- package/site/index.html +346 -0
- package/site/styles.css +159 -0
- package/skills/manage-project-quality/SKILL.md +18 -2
- package/skills/manage-project-quality/assets/documentation-report.md +3 -3
- package/skills/manage-project-quality/assets/engineering-report.md +3 -3
- package/skills/manage-project-quality/assets/security-report.md +3 -3
- package/skills/manage-project-quality/references/documentation-01-system-documentation.md +13 -0
- package/skills/manage-project-quality/references/documentation-02-project-governance.md +13 -0
- package/skills/manage-project-quality/references/documentation-03-development-records.md +13 -0
- package/skills/manage-project-quality/references/documentation-04-testing-evidence.md +13 -0
- package/skills/manage-project-quality/references/documentation-05-operations-runbooks.md +13 -0
- package/skills/manage-project-quality/references/documentation-06-future-proposals.md +13 -0
- package/skills/manage-project-quality/references/documentation-07-archive-governance.md +13 -0
- package/skills/manage-project-quality/references/documentation-full-reference.md +24 -0
- package/skills/manage-project-quality/references/documentation-governance.md +2 -2
- package/skills/manage-project-quality/references/engineering-01-query-performance.md +17 -27
- package/skills/manage-project-quality/references/engineering-02-networking-fundamentals.md +17 -27
- package/skills/manage-project-quality/references/engineering-03-rate-limiting-algorithms.md +18 -28
- package/skills/manage-project-quality/references/engineering-04-production-debugging.md +17 -27
- package/skills/manage-project-quality/references/engineering-05-code-review-practices.md +17 -27
- package/skills/manage-project-quality/references/engineering-06-data-modeling.md +17 -27
- package/skills/manage-project-quality/references/engineering-07-cloud-cost-saving.md +17 -27
- package/skills/manage-project-quality/references/engineering-08-testing-types.md +17 -27
- package/skills/manage-project-quality/references/engineering-09-message-queues.md +17 -27
- package/skills/manage-project-quality/references/engineering-10-api-design-compatibility.md +14 -0
- package/skills/manage-project-quality/references/engineering-11-reliability-slos.md +14 -0
- package/skills/manage-project-quality/references/engineering-12-observability-telemetry.md +14 -0
- package/skills/manage-project-quality/references/engineering-13-deployment-change-safety.md +14 -0
- package/skills/manage-project-quality/references/engineering-14-capacity-concurrency.md +14 -0
- package/skills/manage-project-quality/references/engineering-full-reference.md +24 -144
- package/skills/manage-project-quality/references/engineering-protocol.md +1 -1
- package/skills/manage-project-quality/references/security-01-design-architecture.md +11 -19
- package/skills/manage-project-quality/references/security-02-local-development.md +13 -21
- package/skills/manage-project-quality/references/security-03-database-backend.md +18 -26
- package/skills/manage-project-quality/references/security-04-api-layer.md +23 -31
- package/skills/manage-project-quality/references/security-05-frontend-ui.md +16 -24
- package/skills/manage-project-quality/references/security-06-application-security-testing.md +22 -28
- package/skills/manage-project-quality/references/security-07-cicd-release-engineering.md +13 -21
- package/skills/manage-project-quality/references/security-08-cloud-infrastructure.md +17 -25
- package/skills/manage-project-quality/references/security-09-edge-cdn-dns.md +16 -24
- package/skills/manage-project-quality/references/security-10-release-rollout.md +13 -21
- package/skills/manage-project-quality/references/security-11-post-release-monitoring-ir.md +15 -23
- package/skills/manage-project-quality/references/security-12-ongoing-operations.md +24 -32
- package/skills/manage-project-quality/references/security-full-reference.md +30 -3163
- package/skills/manage-project-quality/scripts/check-report.mjs +67 -16
- package/src/api/index.mjs +4 -0
- package/src/cli/arguments.mjs +27 -3
- package/src/cli/help.mjs +53 -18
- package/src/cli/main.mjs +66 -9
- package/src/commands/audit.mjs +146 -31
- package/src/commands/doctor.mjs +1 -1
- package/src/commands/guide.mjs +12 -0
- package/src/commands/list.mjs +1 -1
- package/src/commands/setup.mjs +9 -4
- package/src/commands/skill.mjs +1 -0
- package/src/commands/template.mjs +32 -0
- package/src/commands/validate.mjs +36 -4
- package/src/commands/website.mjs +26 -0
- package/src/core/config.mjs +61 -0
- package/src/core/files.mjs +47 -6
- package/templates/adr.md +20 -0
- package/templates/change-record.md +18 -0
- package/templates/incident-review.md +20 -0
- package/templates/runbook.md +18 -0
- package/templates/test-evidence.md +18 -0
- package/tests/cli.test.mjs +226 -0
- package/tests/content.test.mjs +18 -0
package/site/app.js
ADDED
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
const workflowTabs = [...document.querySelectorAll("[data-tab]")];
|
|
2
|
+
const workflowPanels = [...document.querySelectorAll("[data-panel]")];
|
|
3
|
+
|
|
4
|
+
function selectWorkflow(name, focus = false) {
|
|
5
|
+
workflowTabs.forEach((tab) => {
|
|
6
|
+
const selected = tab.dataset.tab === name;
|
|
7
|
+
tab.setAttribute("aria-selected", String(selected));
|
|
8
|
+
tab.tabIndex = selected ? 0 : -1;
|
|
9
|
+
if (selected && focus) tab.focus();
|
|
10
|
+
});
|
|
11
|
+
workflowPanels.forEach((panel) => { panel.hidden = panel.dataset.panel !== name; });
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
workflowTabs.forEach((tab, index) => {
|
|
15
|
+
tab.addEventListener("click", () => selectWorkflow(tab.dataset.tab));
|
|
16
|
+
tab.addEventListener("keydown", (event) => {
|
|
17
|
+
if (!["ArrowLeft", "ArrowRight"].includes(event.key)) return;
|
|
18
|
+
event.preventDefault();
|
|
19
|
+
const offset = event.key === "ArrowRight" ? 1 : -1;
|
|
20
|
+
const next = workflowTabs[(index + offset + workflowTabs.length) % workflowTabs.length];
|
|
21
|
+
selectWorkflow(next.dataset.tab, true);
|
|
22
|
+
});
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
const codeTabs = [...document.querySelectorAll("[data-code-tab]")];
|
|
26
|
+
const codePanels = [...document.querySelectorAll("[data-code-panel]")];
|
|
27
|
+
|
|
28
|
+
function selectCodeTab(name, focus = false) {
|
|
29
|
+
codeTabs.forEach((tab) => {
|
|
30
|
+
const selected = tab.dataset.codeTab === name;
|
|
31
|
+
tab.classList.toggle("is-active", selected);
|
|
32
|
+
tab.setAttribute("aria-selected", String(selected));
|
|
33
|
+
tab.tabIndex = selected ? 0 : -1;
|
|
34
|
+
if (selected && focus) tab.focus();
|
|
35
|
+
});
|
|
36
|
+
codePanels.forEach((panel) => { panel.hidden = panel.dataset.codePanel !== name; });
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
codeTabs.forEach((tab, index) => {
|
|
40
|
+
tab.addEventListener("click", () => selectCodeTab(tab.dataset.codeTab));
|
|
41
|
+
tab.addEventListener("keydown", (event) => {
|
|
42
|
+
if (!["ArrowLeft", "ArrowRight", "Home", "End"].includes(event.key)) return;
|
|
43
|
+
event.preventDefault();
|
|
44
|
+
let nextIndex = event.key === "Home" ? 0 : event.key === "End" ? codeTabs.length - 1 : index + (event.key === "ArrowRight" ? 1 : -1);
|
|
45
|
+
nextIndex = (nextIndex + codeTabs.length) % codeTabs.length;
|
|
46
|
+
selectCodeTab(codeTabs[nextIndex].dataset.codeTab, true);
|
|
47
|
+
});
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
const commandPrefixes = {
|
|
51
|
+
npx: "npx @ghostbyte/agent-docs-kit@latest",
|
|
52
|
+
global: "agent-docs"
|
|
53
|
+
};
|
|
54
|
+
|
|
55
|
+
const commandExamples = {
|
|
56
|
+
setup: ["list documentation", "documentation guide system-documentation", "audit documentation --strict"],
|
|
57
|
+
security: ["list security", "security worksheet api-layer --style learning"],
|
|
58
|
+
engineering: ["list engineering", "engineering worksheet testing-types"],
|
|
59
|
+
skill: ["skill install --target project", "", "# Creates:", "# .agents/skills/manage-project-quality"]
|
|
60
|
+
};
|
|
61
|
+
|
|
62
|
+
const commandModeHelp = {
|
|
63
|
+
npx: "No installation required. npx downloads and runs the published package when you invoke it.",
|
|
64
|
+
global: "Use the shorter agent-docs command after installing the package globally. Check its version periodically for updates."
|
|
65
|
+
};
|
|
66
|
+
|
|
67
|
+
const commandModeButtons = [...document.querySelectorAll("[data-command-mode]")];
|
|
68
|
+
const commandModeHelpElement = document.querySelector("[data-command-mode-help]");
|
|
69
|
+
|
|
70
|
+
function formatCommand(suffix = "", mode = "npx") {
|
|
71
|
+
return `${commandPrefixes[mode]}${suffix ? ` ${suffix}` : ""}`;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
function savedCommandMode() {
|
|
75
|
+
try {
|
|
76
|
+
const saved = window.localStorage.getItem("agent-docs-command-mode");
|
|
77
|
+
return saved === "global" ? "global" : "npx";
|
|
78
|
+
} catch {
|
|
79
|
+
return "npx";
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
function selectCommandMode(mode) {
|
|
84
|
+
commandModeButtons.forEach((button) => {
|
|
85
|
+
button.setAttribute("aria-pressed", String(button.dataset.commandMode === mode));
|
|
86
|
+
});
|
|
87
|
+
|
|
88
|
+
document.querySelectorAll("[data-command]").forEach((element) => {
|
|
89
|
+
element.textContent = formatCommand(element.dataset.command, mode);
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
document.querySelectorAll("[data-command-example]").forEach((element) => {
|
|
93
|
+
const lines = commandExamples[element.dataset.commandExample] ?? [];
|
|
94
|
+
element.textContent = lines.map((line) => line && !line.startsWith("#") ? formatCommand(line, mode) : line).join("\n");
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
document.querySelectorAll("[data-copy-command]").forEach((button) => {
|
|
98
|
+
button.dataset.copy = formatCommand(button.dataset.copyCommand, mode);
|
|
99
|
+
});
|
|
100
|
+
|
|
101
|
+
if (commandModeHelpElement) commandModeHelpElement.textContent = commandModeHelp[mode];
|
|
102
|
+
try { window.localStorage.setItem("agent-docs-command-mode", mode); } catch {}
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
commandModeButtons.forEach((button) => {
|
|
106
|
+
button.addEventListener("click", () => selectCommandMode(button.dataset.commandMode));
|
|
107
|
+
});
|
|
108
|
+
selectCommandMode(savedCommandMode());
|
|
109
|
+
|
|
110
|
+
document.querySelectorAll("[data-copy], [data-copy-command]").forEach((button) => {
|
|
111
|
+
button.addEventListener("click", async () => {
|
|
112
|
+
const previous = button.textContent;
|
|
113
|
+
try {
|
|
114
|
+
await navigator.clipboard.writeText(button.dataset.copy.replaceAll("\\n", "\n"));
|
|
115
|
+
button.textContent = "Copied";
|
|
116
|
+
} catch {
|
|
117
|
+
button.textContent = "Copy failed";
|
|
118
|
+
}
|
|
119
|
+
window.setTimeout(() => { button.textContent = previous; }, 1600);
|
|
120
|
+
});
|
|
121
|
+
});
|
package/site/index.html
ADDED
|
@@ -0,0 +1,346 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
6
|
+
<meta name="description" content="Documentation governance, evidence-based security audits, and engineering-quality reviews in one CLI and one progressive skill.">
|
|
7
|
+
<meta name="referrer" content="strict-origin-when-cross-origin">
|
|
8
|
+
<meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'; style-src 'self'; img-src 'self' data:; connect-src 'none'; object-src 'none'; base-uri 'self'; form-action 'none'">
|
|
9
|
+
<title>Agent Docs & Quality Kit</title>
|
|
10
|
+
<link rel="stylesheet" href="styles.css">
|
|
11
|
+
<script src="app.js" defer></script>
|
|
12
|
+
</head>
|
|
13
|
+
<body>
|
|
14
|
+
<a class="skip-link" href="#main">Skip to content</a>
|
|
15
|
+
|
|
16
|
+
<header class="hero" id="top">
|
|
17
|
+
<nav class="nav shell" aria-label="Primary navigation">
|
|
18
|
+
<a class="brand" href="#top" aria-label="Agent Docs and Quality Kit home">
|
|
19
|
+
<span class="brand-mark" aria-hidden="true">AQ</span>
|
|
20
|
+
<span>Agent Docs & Quality</span>
|
|
21
|
+
</a>
|
|
22
|
+
<div class="nav-links">
|
|
23
|
+
<a href="#workflows">Workflows</a>
|
|
24
|
+
<a href="#how-it-works">How it works</a>
|
|
25
|
+
<a href="#commands">Commands</a>
|
|
26
|
+
<a class="nav-install" href="#quick-start">Install guide</a>
|
|
27
|
+
</div>
|
|
28
|
+
</nav>
|
|
29
|
+
|
|
30
|
+
<div class="hero-layout shell">
|
|
31
|
+
<div class="hero-copy">
|
|
32
|
+
<div class="status-pill"><i aria-hidden="true"></i> Quality infrastructure for human + AI teams</div>
|
|
33
|
+
<h1>One project memory.<br><em>Three quality lenses.</em></h1>
|
|
34
|
+
<p class="hero-lead">Build documentation that stays useful, assess security controls with real evidence, and improve engineering practice—without loading an entire reference library into every session.</p>
|
|
35
|
+
<div class="actions">
|
|
36
|
+
<a class="button primary" href="#quick-start">Start locally <span aria-hidden="true">→</span></a>
|
|
37
|
+
<a class="button secondary" href="#workflows">Explore the workflows</a>
|
|
38
|
+
</div>
|
|
39
|
+
<dl class="hero-facts" aria-label="Toolkit facts">
|
|
40
|
+
<div><dt>3</dt><dd>Focused workflows</dd></div>
|
|
41
|
+
<div><dt>33</dt><dd>Review areas</dd></div>
|
|
42
|
+
<div><dt>0</dt><dd>Install-time actions</dd></div>
|
|
43
|
+
</dl>
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div class="console" aria-label="Example Agent Docs command line session">
|
|
47
|
+
<div class="console-bar"><span></span><span></span><span></span><b>agent-docs — project</b></div>
|
|
48
|
+
<div class="console-body">
|
|
49
|
+
<p><span class="prompt">$</span> <span data-command>npx @ghostbyte/agent-docs-kit@latest</span></p>
|
|
50
|
+
<p class="console-title">Agent Docs & Quality Kit</p>
|
|
51
|
+
<ol>
|
|
52
|
+
<li><i>01</i> Set up documentation</li>
|
|
53
|
+
<li><i>02</i> Audit documentation</li>
|
|
54
|
+
<li class="active"><i>03</i> Start security audit <b>selected</b></li>
|
|
55
|
+
<li><i>04</i> Start engineering review</li>
|
|
56
|
+
<li><i>05</i> Install project skill</li>
|
|
57
|
+
<li><i>06</i> Validate package</li>
|
|
58
|
+
<li><i>07</i> Open documentation website</li>
|
|
59
|
+
</ol>
|
|
60
|
+
<p class="console-result"><span>✓</span> Scope selected: API Layer<br><span>→</span> Report starts as <strong>Unverified</strong></p>
|
|
61
|
+
</div>
|
|
62
|
+
</div>
|
|
63
|
+
</div>
|
|
64
|
+
</header>
|
|
65
|
+
|
|
66
|
+
<main id="main">
|
|
67
|
+
<section class="principle-strip" aria-label="Core principles">
|
|
68
|
+
<div class="shell">
|
|
69
|
+
<p><span>Evidence over assumptions</span></p>
|
|
70
|
+
<p><span>Explicit actions only</span></p>
|
|
71
|
+
<p><span>Context loaded on demand</span></p>
|
|
72
|
+
<p><span>Human-readable outputs</span></p>
|
|
73
|
+
</div>
|
|
74
|
+
</section>
|
|
75
|
+
|
|
76
|
+
<section class="section shell" id="workflows">
|
|
77
|
+
<header class="section-heading split-heading">
|
|
78
|
+
<div><p class="eyebrow">Three jobs, clear boundaries</p><h2>Choose the quality lens that matches the work.</h2></div>
|
|
79
|
+
<p>Documentation, security, and engineering overlap, but they do not mean the same thing. The kit keeps their evidence and consequences separate.</p>
|
|
80
|
+
</header>
|
|
81
|
+
|
|
82
|
+
<div class="workflow-tabs" role="tablist" aria-label="Quality workflows">
|
|
83
|
+
<button id="tab-documentation" role="tab" aria-selected="true" aria-controls="panel-documentation" tabindex="0" data-tab="documentation"><span>01</span> Documentation</button>
|
|
84
|
+
<button id="tab-security" role="tab" aria-selected="false" aria-controls="panel-security" tabindex="-1" data-tab="security"><span>02</span> Security</button>
|
|
85
|
+
<button id="tab-engineering" role="tab" aria-selected="false" aria-controls="panel-engineering" tabindex="-1" data-tab="engineering"><span>03</span> Engineering</button>
|
|
86
|
+
</div>
|
|
87
|
+
|
|
88
|
+
<div class="workflow-panel" id="panel-documentation" role="tabpanel" aria-labelledby="tab-documentation" data-panel="documentation">
|
|
89
|
+
<div class="workflow-intro">
|
|
90
|
+
<p class="workflow-number">01 / Documentation governance</p>
|
|
91
|
+
<h3>Make the repository explain itself.</h3>
|
|
92
|
+
<p>Use seven canonical guidance areas to preserve project scope, architecture, decisions, operational knowledge, test evidence, proposals, and history in a structure people and agents can navigate.</p>
|
|
93
|
+
<a href="docs/PURPOSE.md">Read the purpose and boundaries <span aria-hidden="true">→</span></a>
|
|
94
|
+
</div>
|
|
95
|
+
<div class="workflow-details">
|
|
96
|
+
<article><h4>Use it when</h4><ul><li>Starting or inheriting a project</li><li>Important decisions live only in chat</li><li>Documentation conflicts with the code</li><li>Operations depend on tribal knowledge</li></ul></article>
|
|
97
|
+
<article><h4>What it checks</h4><ul><li>Missing or duplicate sources of truth</li><li>Scope and architecture drift</li><li>Broken navigation and stale records</li><li>Undocumented setup and recovery paths</li></ul></article>
|
|
98
|
+
<article class="result-card"><h4>Document states</h4><div class="status-grid doc-status"><span>Current</span><span>Needs update</span><span>Reference</span><span>Archived</span></div><p>Documentation describes governance. Hooks and CI are what make a policy technically enforceable.</p></article>
|
|
99
|
+
</div>
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<div class="workflow-panel" id="panel-security" role="tabpanel" aria-labelledby="tab-security" data-panel="security" hidden>
|
|
103
|
+
<div class="workflow-intro">
|
|
104
|
+
<p class="workflow-number">02 / Security assurance</p>
|
|
105
|
+
<h3>Turn controls into verifiable evidence.</h3>
|
|
106
|
+
<p>Review security across 12 lifecycle phases, from design and local development through release, monitoring, and ongoing operations. Missing evidence is never treated as a pass.</p>
|
|
107
|
+
<a href="docs/SECURITY_MODEL.md">Review the security model <span aria-hidden="true">→</span></a>
|
|
108
|
+
</div>
|
|
109
|
+
<div class="workflow-details">
|
|
110
|
+
<article><h4>Use it when</h4><ul><li>Designing a sensitive feature</li><li>Preparing an API or cloud deployment</li><li>Running a pre-release security gate</li><li>Reviewing post-release readiness</li></ul></article>
|
|
111
|
+
<article><h4>Safety boundary</h4><ul><li>Passive repository review can start locally</li><li>Active testing needs explicit authorization</li><li>Staging is preferred over production</li><li>Secrets are redacted from reports</li></ul></article>
|
|
112
|
+
<article class="result-card"><h4>Security verdicts</h4><div class="status-grid security-status"><span>Pass</span><span>Fail</span><span>Unverified</span><span>N/A</span></div><p>Critical and High failures block release by default unless an accountable owner records a time-bounded exception.</p></article>
|
|
113
|
+
</div>
|
|
114
|
+
</div>
|
|
115
|
+
|
|
116
|
+
<div class="workflow-panel" id="panel-engineering" role="tabpanel" aria-labelledby="tab-engineering" data-panel="engineering" hidden>
|
|
117
|
+
<div class="workflow-intro">
|
|
118
|
+
<p class="workflow-number">03 / Engineering review</p>
|
|
119
|
+
<h3>Improve the system without importing needless complexity.</h3>
|
|
120
|
+
<p>Assess maintainability, reliability, performance, testing, data modeling, operations, and cost using recommendations grounded in the project’s real scale and constraints.</p>
|
|
121
|
+
<a href="docs/ARCHITECTURE.md">Explore the toolkit architecture <span aria-hidden="true">→</span></a>
|
|
122
|
+
</div>
|
|
123
|
+
<div class="workflow-details">
|
|
124
|
+
<article><h4>Use it when</h4><ul><li>Reviewing a design or pull request</li><li>Investigating slow or fragile behavior</li><li>Planning testing and observability</li><li>Evaluating infrastructure cost</li></ul></article>
|
|
125
|
+
<article><h4>Fourteen topic areas</h4><ul><li>Queries, networking, and rate limits</li><li>Production debugging and code review</li><li>Reliability, observability, and deployment safety</li><li>API compatibility, cost, queues, and capacity</li></ul></article>
|
|
126
|
+
<article class="result-card"><h4>Engineering outcomes</h4><div class="status-grid engineering-status"><span>Applied</span><span>Partial</span><span>Recommended</span><span>Unverified</span><span>N/A</span></div><p>Recommendations are normally advisory. Security vulnerabilities and correctness defects are reported separately.</p></article>
|
|
127
|
+
</div>
|
|
128
|
+
</div>
|
|
129
|
+
</section>
|
|
130
|
+
|
|
131
|
+
<section class="section process-section" id="how-it-works">
|
|
132
|
+
<div class="shell">
|
|
133
|
+
<header class="section-heading"><p class="eyebrow">From request to useful record</p><h2>A review process you can inspect.</h2><p>Every workflow follows the same evidence discipline while producing an outcome appropriate to its purpose.</p></header>
|
|
134
|
+
<ol class="process-list">
|
|
135
|
+
<li><span>01</span><div><h3>Inspect context</h3><p>Read repository instructions, identify the technology and locate the files that can actually answer the question.</p></div></li>
|
|
136
|
+
<li><span>02</span><div><h3>Select scope</h3><p>Choose one workflow, then a specific documentation area, security phase, or engineering topic. Define exclusions before the review grows.</p></div></li>
|
|
137
|
+
<li><span>03</span><div><h3>Collect evidence</h3><p>Use code paths, configuration, tests, command output, or authorized external settings. Separate facts from inference.</p></div></li>
|
|
138
|
+
<li><span>04</span><div><h3>Record the result</h3><p>Write status, impact, remediation, owner, verification step, and limitations into a durable project report.</p></div></li>
|
|
139
|
+
</ol>
|
|
140
|
+
</div>
|
|
141
|
+
</section>
|
|
142
|
+
|
|
143
|
+
<section class="section shell architecture-section">
|
|
144
|
+
<header class="section-heading split-heading">
|
|
145
|
+
<div><p class="eyebrow">Token-aware by design</p><h2>Load the relevant reference, not the whole library.</h2></div>
|
|
146
|
+
<p>The unified skill acts as a router. It opens shared evidence rules plus only the documentation area, security phase, or engineering topic required for the task.</p>
|
|
147
|
+
</header>
|
|
148
|
+
<div class="routing-diagram" aria-label="Progressive skill loading flow">
|
|
149
|
+
<div class="route-node request"><small>Your request</small><strong>“Review my API security”</strong></div>
|
|
150
|
+
<span class="route-arrow" aria-hidden="true">→</span>
|
|
151
|
+
<div class="route-node router"><small>Unified skill</small><strong>Classify + scope</strong><code>manage-project-quality</code></div>
|
|
152
|
+
<span class="route-arrow" aria-hidden="true">→</span>
|
|
153
|
+
<div class="route-stack">
|
|
154
|
+
<div class="route-node selected"><small>Loaded</small><strong>Security protocol</strong></div>
|
|
155
|
+
<div class="route-node selected"><small>Loaded</small><strong>04 · API Layer</strong></div>
|
|
156
|
+
<div class="route-node muted"><small>Not loaded</small><strong>19 unrelated references</strong></div>
|
|
157
|
+
</div>
|
|
158
|
+
<span class="route-arrow" aria-hidden="true">→</span>
|
|
159
|
+
<div class="route-node report"><small>Durable output</small><strong>Evidence-based report</strong><code>docs/04-testing/…</code></div>
|
|
160
|
+
</div>
|
|
161
|
+
</section>
|
|
162
|
+
|
|
163
|
+
<section class="section command-section" id="commands">
|
|
164
|
+
<div class="shell command-layout">
|
|
165
|
+
<div>
|
|
166
|
+
<p class="eyebrow">Interactive or automatable</p>
|
|
167
|
+
<h2>Use the menu once. Use direct commands everywhere else.</h2>
|
|
168
|
+
<p>The no-argument command guides first-time users. Choose how you run the kit and every example on this page will use the right command.</p>
|
|
169
|
+
<div class="command-mode-card" aria-labelledby="command-mode-title">
|
|
170
|
+
<strong id="command-mode-title">How are you running it?</strong>
|
|
171
|
+
<div class="command-mode-switch" role="group" aria-label="Command format">
|
|
172
|
+
<button type="button" aria-pressed="true" data-command-mode="npx"><span>No install</span><small>Use npx</small></button>
|
|
173
|
+
<button type="button" aria-pressed="false" data-command-mode="global"><span>Installed globally</span><small>Use agent-docs</small></button>
|
|
174
|
+
</div>
|
|
175
|
+
<p class="command-mode-help" data-command-mode-help>No installation required. npx downloads and runs the published package when you invoke it.</p>
|
|
176
|
+
</div>
|
|
177
|
+
<div class="command-notes">
|
|
178
|
+
<p><span>✓</span><strong>Safe preview</strong><small>`--dry-run` reports intended writes.</small></p>
|
|
179
|
+
<p><span>✓</span><strong>Existing files protected</strong><small>Scaffolds skip existing files; reports and templates choose a new numbered path.</small></p>
|
|
180
|
+
<p><span>✓</span><strong>No install hook</strong><small>`npm install` does not configure the project.</small></p>
|
|
181
|
+
</div>
|
|
182
|
+
</div>
|
|
183
|
+
<div class="code-window">
|
|
184
|
+
<div class="code-tabs" role="tablist" aria-label="Command examples">
|
|
185
|
+
<button id="code-tab-setup" class="is-active" role="tab" aria-selected="true" aria-controls="code-panel-setup" tabindex="0" data-code-tab="setup">Documentation</button>
|
|
186
|
+
<button id="code-tab-security" role="tab" aria-selected="false" aria-controls="code-panel-security" tabindex="-1" data-code-tab="security">Security</button>
|
|
187
|
+
<button id="code-tab-engineering" role="tab" aria-selected="false" aria-controls="code-panel-engineering" tabindex="-1" data-code-tab="engineering">Engineering</button>
|
|
188
|
+
<button id="code-tab-skill" role="tab" aria-selected="false" aria-controls="code-panel-skill" tabindex="-1" data-code-tab="skill">Skill</button>
|
|
189
|
+
</div>
|
|
190
|
+
<div id="code-panel-setup" class="code-panel" role="tabpanel" aria-labelledby="code-tab-setup" data-code-panel="setup"><pre><code data-command-example="setup">npx @ghostbyte/agent-docs-kit@latest list documentation
|
|
191
|
+
|
|
192
|
+
npx @ghostbyte/agent-docs-kit@latest documentation guide system-documentation
|
|
193
|
+
|
|
194
|
+
npx @ghostbyte/agent-docs-kit@latest audit documentation --strict</code></pre><button class="copy-button" data-copy-command="list documentation">Copy</button></div>
|
|
195
|
+
<div id="code-panel-security" class="code-panel" role="tabpanel" aria-labelledby="code-tab-security" data-code-panel="security" hidden><pre><code data-command-example="security">npx @ghostbyte/agent-docs-kit@latest list security
|
|
196
|
+
|
|
197
|
+
npx @ghostbyte/agent-docs-kit@latest security worksheet api-layer --style learning</code></pre><button class="copy-button" data-copy-command="security worksheet api-layer --style learning">Copy</button></div>
|
|
198
|
+
<div id="code-panel-engineering" class="code-panel" role="tabpanel" aria-labelledby="code-tab-engineering" data-code-panel="engineering" hidden><pre><code data-command-example="engineering">npx @ghostbyte/agent-docs-kit@latest list engineering
|
|
199
|
+
|
|
200
|
+
npx @ghostbyte/agent-docs-kit@latest engineering worksheet testing-types</code></pre><button class="copy-button" data-copy-command="engineering worksheet testing-types">Copy</button></div>
|
|
201
|
+
<div id="code-panel-skill" class="code-panel" role="tabpanel" aria-labelledby="code-tab-skill" data-code-panel="skill" hidden><pre><code data-command-example="skill">npx @ghostbyte/agent-docs-kit@latest skill install --target project
|
|
202
|
+
|
|
203
|
+
# Creates:
|
|
204
|
+
# .agents/skills/manage-project-quality</code></pre><button class="copy-button" data-copy-command="skill install --target project">Copy</button></div>
|
|
205
|
+
</div>
|
|
206
|
+
</div>
|
|
207
|
+
</section>
|
|
208
|
+
|
|
209
|
+
<section class="section quick-start" id="quick-start">
|
|
210
|
+
<div class="shell">
|
|
211
|
+
<header class="section-heading"><p class="eyebrow">Installation guide</p><h2>From a clean terminal to your first safe run.</h2><p>Start with Node.js 22 or newer, then choose between running on demand with npx or installing the shorter global command.</p></header>
|
|
212
|
+
|
|
213
|
+
<div class="prerequisite-check">
|
|
214
|
+
<div><span>Step 01</span><h3>Check Node.js and npm</h3><p>The CLI requires Node.js 22 or newer. npm is included with standard Node.js installations.</p></div>
|
|
215
|
+
<div class="install-code"><code>node --version
|
|
216
|
+
npm --version</code><button class="copy-button light" data-copy="node --version\nnpm --version">Copy</button></div>
|
|
217
|
+
</div>
|
|
218
|
+
|
|
219
|
+
<div class="install-paths">
|
|
220
|
+
<article class="recommended">
|
|
221
|
+
<header><span>Path A · Recommended</span><h3>Run without installing</h3><p>Use the published package directly. Nothing is added to the project or installed globally.</p></header>
|
|
222
|
+
<ol>
|
|
223
|
+
<li><div><strong>Confirm the CLI is available</strong><small>This fetches the current published version and prints its help.</small></div><div class="install-code"><code>npx @ghostbyte/agent-docs-kit@latest --help</code><button class="copy-button light" data-copy="npx @ghostbyte/agent-docs-kit@latest --help">Copy</button></div></li>
|
|
224
|
+
<li><div><strong>Preview the documentation setup</strong><small>The dry run reports intended writes without changing files.</small></div><div class="install-code"><code>npx @ghostbyte/agent-docs-kit@latest setup --dry-run</code><button class="copy-button light" data-copy="npx @ghostbyte/agent-docs-kit@latest setup --dry-run">Copy</button></div></li>
|
|
225
|
+
<li><div><strong>Open the guided menu</strong><small>Choose documentation, security, engineering, skill installation, or validation.</small></div><div class="install-code"><code>npx @ghostbyte/agent-docs-kit@latest</code><button class="copy-button light" data-copy="npx @ghostbyte/agent-docs-kit@latest">Copy</button></div></li>
|
|
226
|
+
</ol>
|
|
227
|
+
</article>
|
|
228
|
+
|
|
229
|
+
<article>
|
|
230
|
+
<header><span>Path B · Repeated use</span><h3>Install the global command</h3><p>Install once on your workstation, then use the shorter <code>agent-docs</code> command in any project.</p></header>
|
|
231
|
+
<ol>
|
|
232
|
+
<li><div><strong>Install the latest version</strong><small>Installation is inert and does not configure the current project.</small></div><div class="install-code"><code>npm install --global @ghostbyte/agent-docs-kit@latest</code><button class="copy-button light" data-copy="npm install --global @ghostbyte/agent-docs-kit@latest">Copy</button></div></li>
|
|
233
|
+
<li><div><strong>Verify the installation</strong><small>The installed version should print without an error.</small></div><div class="install-code"><code>agent-docs --version
|
|
234
|
+
agent-docs --help</code><button class="copy-button light" data-copy="agent-docs --version\nagent-docs --help">Copy</button></div></li>
|
|
235
|
+
<li><div><strong>Run a safe preview</strong><small>After installation, every command can begin with <code>agent-docs</code>.</small></div><div class="install-code"><code>agent-docs setup --dry-run</code><button class="copy-button light" data-copy="agent-docs setup --dry-run">Copy</button></div></li>
|
|
236
|
+
</ol>
|
|
237
|
+
</article>
|
|
238
|
+
</div>
|
|
239
|
+
|
|
240
|
+
<div class="installation-maintenance">
|
|
241
|
+
<div><span>Step 03</span><h3>Check for a newer global version</h3><p>Compare the installed and published versions. Updating is always explicit; the CLI never updates itself.</p></div>
|
|
242
|
+
<div><div class="install-code"><code>agent-docs --version
|
|
243
|
+
npm view @ghostbyte/agent-docs-kit version</code><button class="copy-button light" data-copy="agent-docs --version\nnpm view @ghostbyte/agent-docs-kit version">Compare</button></div><div class="install-code"><code>npm install --global @ghostbyte/agent-docs-kit@latest</code><button class="copy-button light" data-copy="npm install --global @ghostbyte/agent-docs-kit@latest">Update</button></div></div>
|
|
244
|
+
</div>
|
|
245
|
+
|
|
246
|
+
<div class="other-installation">
|
|
247
|
+
<details><summary><span>Team projects</span> Install as a project dependency</summary><div><p>Record the package version in the project lockfile. Run its executable through npx so npm resolves the local binary.</p><div class="install-code"><code>npm install --save-dev @ghostbyte/agent-docs-kit
|
|
248
|
+
npx agent-docs --help</code><button class="copy-button light" data-copy="npm install --save-dev @ghostbyte/agent-docs-kit\nnpx agent-docs --help">Copy</button></div></div></details>
|
|
249
|
+
</div>
|
|
250
|
+
|
|
251
|
+
<aside class="install-troubleshooting"><div><span>Troubleshooting</span><h3>If <code>agent-docs</code> is not recognized</h3></div><p>Close and reopen the terminal after a global installation, then run <code>npm config get prefix</code> and confirm npm’s global executable directory is on your PATH. In Windows PowerShell, use <code>npm.cmd</code> or <code>npx.cmd</code> if script execution blocks the corresponding PowerShell shim.</p></aside>
|
|
252
|
+
</div>
|
|
253
|
+
</section>
|
|
254
|
+
|
|
255
|
+
<section class="section library-section" id="contents">
|
|
256
|
+
<div class="shell">
|
|
257
|
+
<header class="section-heading split-heading"><div><p class="eyebrow">Inside the package</p><h2>A working library, not just a command wrapper.</h2></div><p>The npm archive carries the CLI, canonical quality content, report assets, documentation, and a self-contained Codex skill. The same catalog drives both command-line and agent workflows.</p></header>
|
|
258
|
+
|
|
259
|
+
<div class="package-parts">
|
|
260
|
+
<article><span>CLI</span><h3>Command interface</h3><p>Guided menu, direct commands, safe file operations, project setup, report generation, validation, and diagnostics.</p></article>
|
|
261
|
+
<article><span>CONTENT</span><h3>Canonical library</h3><p>Seven documentation areas, 12 security phases, and 14 engineering topics share one versioned catalog and focused reference model.</p></article>
|
|
262
|
+
<article><span>SKILL</span><h3>Agent workflow</h3><p>A concise router, workflow protocols, evidence rules, progressive references, report assets, and a structural report checker.</p></article>
|
|
263
|
+
<article><span>OUTPUT</span><h3>Project records</h3><p>A maintainable docs hierarchy plus dated security audits, engineering reviews, documentation audits, and supporting evidence.</p></article>
|
|
264
|
+
</div>
|
|
265
|
+
|
|
266
|
+
<div class="catalog-layout">
|
|
267
|
+
<article class="catalog-card documentation-catalog">
|
|
268
|
+
<header><span>Documentation structure</span><strong>7 areas</strong></header>
|
|
269
|
+
<ol><li><b>01</b> System Documentation</li><li><b>02</b> Project Governance</li><li><b>03</b> Development Records</li><li><b>04</b> Testing & Evidence</li><li><b>05</b> Operations & Runbooks</li><li><b>06</b> Future Proposals</li><li><b>07</b> Archive Governance</li></ol>
|
|
270
|
+
</article>
|
|
271
|
+
<article class="catalog-card security-catalog">
|
|
272
|
+
<header><span>Security assurance</span><strong>12 phases</strong></header>
|
|
273
|
+
<ol><li><b>01</b> Design & Architecture</li><li><b>02</b> Local Development</li><li><b>03</b> Database & Backend</li><li><b>04</b> API Layer</li><li><b>05</b> Frontend & UI</li><li><b>06</b> Application Security Testing</li><li><b>07</b> CI/CD & Release Engineering</li><li><b>08</b> Cloud Infrastructure</li><li><b>09</b> Edge, CDN & DNS</li><li><b>10</b> Release & Rollout</li><li><b>11</b> Monitoring & Incident Response</li><li><b>12</b> Ongoing Operations</li></ol>
|
|
274
|
+
</article>
|
|
275
|
+
<article class="catalog-card engineering-catalog">
|
|
276
|
+
<header><span>Engineering review</span><strong>14 topics</strong></header>
|
|
277
|
+
<ol><li><b>01</b> Query Performance</li><li><b>02</b> Networking Fundamentals</li><li><b>03</b> Rate Limiting Algorithms</li><li><b>04</b> Production Debugging</li><li><b>05</b> Code Review Practices</li><li><b>06</b> Data Modeling</li><li><b>07</b> Cloud Cost Saving</li><li><b>08</b> Testing Types</li><li><b>09</b> Message Queues</li><li><b>10</b> API Design & Compatibility</li><li><b>11</b> Reliability, SLOs & Error Budgets</li><li><b>12</b> Observability & Telemetry</li><li><b>13</b> Deployment & Change Safety</li><li><b>14</b> Capacity & Concurrency</li></ol>
|
|
278
|
+
</article>
|
|
279
|
+
</div>
|
|
280
|
+
|
|
281
|
+
<div class="skill-detail">
|
|
282
|
+
<div><p class="eyebrow">What the installed skill does</p><h3><code>$manage-project-quality</code></h3><p>The skill classifies the request, establishes scope and safety boundaries, loads only the required references, inspects repository evidence, applies the correct status model, and produces a durable result.</p></div>
|
|
283
|
+
<ol><li><span>1</span>Route to documentation, security, or engineering</li><li><span>2</span>Select standard or learning interaction style</li><li><span>3</span>Load shared evidence rules plus one relevant reference</li><li><span>4</span>Inspect files without guessing unavailable facts</li><li><span>5</span>Write findings, remediation, verification, and limitations</li></ol>
|
|
284
|
+
</div>
|
|
285
|
+
</div>
|
|
286
|
+
</section>
|
|
287
|
+
|
|
288
|
+
<section class="section shell trust-section">
|
|
289
|
+
<header class="section-heading"><p class="eyebrow">Designed for controlled adoption</p><h2>Useful automation without hidden authority.</h2></header>
|
|
290
|
+
<div class="trust-grid">
|
|
291
|
+
<article><span aria-hidden="true">◇</span><h3>Inert installation</h3><p>No preinstall, install, or postinstall lifecycle script changes your repository.</p></article>
|
|
292
|
+
<article><span aria-hidden="true">◎</span><h3>Evidence-first status</h3><p>Reports begin as Unverified. A generated checklist is not proof that a control passes.</p></article>
|
|
293
|
+
<article><span aria-hidden="true">⌁</span><h3>Bounded security work</h3><p>Active tests require explicit target authorization and should prefer staging over production.</p></article>
|
|
294
|
+
<article><span aria-hidden="true">↺</span><h3>Repeatable records</h3><p>Reports live with the project so findings, decisions, and verification survive the session.</p></article>
|
|
295
|
+
</div>
|
|
296
|
+
</section>
|
|
297
|
+
|
|
298
|
+
<section class="section shell reference-section" id="command-reference">
|
|
299
|
+
<header class="section-heading split-heading">
|
|
300
|
+
<div><p class="eyebrow">Complete CLI reference</p><h2>Know what every command does before you run it.</h2></div>
|
|
301
|
+
<p>Commands marked “writes” create an owned scaffold or record. Scaffolds skip existing files; reports and templates select a collision-safe numbered filename. Read-only commands inspect or print information without changing the target project.</p>
|
|
302
|
+
</header>
|
|
303
|
+
|
|
304
|
+
<div class="command-reference" role="list">
|
|
305
|
+
<article role="listitem"><div class="command-meta"><span class="read-label">Interactive</span><code data-command>npx @ghostbyte/agent-docs-kit@latest</code></div><div><h3>Open the guided menu</h3><p>Choose documentation setup, documentation audit, security audit, engineering review, project-skill installation, or package validation. In a non-interactive shell, it prints help instead of waiting for input.</p></div></article>
|
|
306
|
+
<article role="listitem"><div class="command-meta"><span class="write-label">Writes</span><code data-command="setup">npx @ghostbyte/agent-docs-kit@latest setup</code></div><div><h3>Create the documentation workspace</h3><p>Adds `.agent-docs/config.json` and the initial `docs/` hierarchy for system, project, development, testing, operations, future work, and archives. Use `--dry-run` first; existing files are skipped.</p></div></article>
|
|
307
|
+
<article role="listitem"><div class="command-meta"><span class="read-label">Read-only*</span><code data-command="audit documentation">npx @ghostbyte/agent-docs-kit@latest audit documentation</code></div><div><h3>Check documentation health</h3><p>Checks configured required documents, duplicate headings, placeholders, relative links, anchors, and optional metadata. Add <code>--strict</code> for CI, <code>--format</code> for text, Markdown, or JSON, and <code>--report</code> to persist the result.</p></div></article>
|
|
308
|
+
<article role="listitem"><div class="command-meta"><span class="read-label">Read-only</span><code data-command="list documentation">npx @ghostbyte/agent-docs-kit@latest list documentation</code></div><div><h3>List documentation areas</h3><p>Prints the seven canonical documentation area IDs, slugs, and names from the same catalog used by security and engineering.</p></div></article>
|
|
309
|
+
<article role="listitem"><div class="command-meta"><span class="read-label">Read-only</span><code data-command="documentation guide <area>">npx @ghostbyte/agent-docs-kit@latest documentation guide <area></code></div><div><h3>Read focused documentation guidance</h3><p>Prints one canonical area with stable <code>DOC-*</code> controls and evidence questions without loading the entire documentation library.</p></div></article>
|
|
310
|
+
<article role="listitem"><div class="command-meta"><span class="read-label">Read-only</span><code data-command="list security">npx @ghostbyte/agent-docs-kit@latest list security</code></div><div><h3>List security audit phases</h3><p>Prints the 12 available phase IDs, slugs, and names so you can select a precise review scope without loading every security reference.</p></div></article>
|
|
311
|
+
<article role="listitem"><div class="command-meta"><span class="write-label">Writes</span><code data-command="security worksheet <phase>">npx @ghostbyte/agent-docs-kit@latest security worksheet <phase></code></div><div><h3>Create a scoped security worksheet</h3><p>Creates a dated, configuration-aware report with control IDs, priority, evidence, remediation, owner, and verification. It does not run active scans or claim controls pass. The v4 <code>audit security</code> form remains an alias.</p></div></article>
|
|
312
|
+
<article role="listitem"><div class="command-meta"><span class="read-label">Read-only</span><code data-command="list engineering">npx @ghostbyte/agent-docs-kit@latest list engineering</code></div><div><h3>List engineering topics</h3><p>Prints all 14 review topics and selectors, including reliability, observability, deployment safety, API compatibility, and capacity.</p></div></article>
|
|
313
|
+
<article role="listitem"><div class="command-meta"><span class="write-label">Writes</span><code data-command="engineering worksheet <topic>">npx @ghostbyte/agent-docs-kit@latest engineering worksheet <topic></code></div><div><h3>Create an engineering review worksheet</h3><p>Creates a dated report with practice ID, evidence, impact, recommendation, owner, and verification. Recommendations remain advisory unless evidence establishes a separate defect. The v4 <code>review engineering</code> form remains an alias.</p></div></article>
|
|
314
|
+
<article role="listitem"><div class="command-meta"><span class="read-label">Read-only</span><code data-command="template list">npx @ghostbyte/agent-docs-kit@latest template list</code></div><div><h3>List documentation templates</h3><p>Shows the available ADR, runbook, change record, incident review, and test evidence templates.</p></div></article>
|
|
315
|
+
<article role="listitem"><div class="command-meta"><span class="write-label">Writes</span><code data-command="template create <type> --name <slug>">npx @ghostbyte/agent-docs-kit@latest template create <type> --name <slug></code></div><div><h3>Create a durable project record</h3><p>Creates a dated template below the configured documentation root. Use <code>--name</code> for a descriptive filename; repeated unnamed records receive a safe numeric suffix.</p></div></article>
|
|
316
|
+
<article role="listitem"><div class="command-meta"><span class="write-label">Writes</span><code data-command="skill install --target project">npx @ghostbyte/agent-docs-kit@latest skill install --target project</code></div><div><h3>Install the skill for one repository</h3><p>Copies the complete `manage-project-quality` skill into `.agents/skills/` in the selected project. This is the recommended target when the workflow should travel with the repository.</p></div></article>
|
|
317
|
+
<article role="listitem"><div class="command-meta"><span class="write-label">Writes</span><code data-command="skill install --target codex">npx @ghostbyte/agent-docs-kit@latest skill install --target codex</code></div><div><h3>Install the skill for the current user</h3><p>Copies the skill into the user’s Codex skills directory. This is an explicit global installation and affects future projects that can discover user-level skills.</p></div></article>
|
|
318
|
+
<article role="listitem"><div class="command-meta"><span class="read-label">Read-only</span><code data-command="validate">npx @ghostbyte/agent-docs-kit@latest validate</code></div><div><h3>Validate the distributed library</h3><p>Confirms that all seven documentation areas, 12 security phases, 14 engineering topics, templates, catalog schema, and unified skill metadata are intact.</p></div></article>
|
|
319
|
+
<article role="listitem"><div class="command-meta"><span class="read-label">Read-only</span><code data-command="doctor">npx @ghostbyte/agent-docs-kit@latest doctor</code></div><div><h3>Check local prerequisites</h3><p>Reports whether the supported Node.js version and Git are available. It does not install or update either tool.</p></div></article>
|
|
320
|
+
<article role="listitem"><div class="command-meta"><span class="read-label">Opens browser</span><code data-command="website">npx @ghostbyte/agent-docs-kit@latest website</code></div><div><h3>Open the documentation website</h3><p>Opens <code>https://ghostbyte1014.github.io/Agent_Docs_Kit/</code> in the default browser and prints the URL as a fallback for terminals that cannot launch a browser.</p></div></article>
|
|
321
|
+
<article role="listitem"><div class="command-meta"><span class="read-label">Read-only</span><code><span data-command="--help">npx @ghostbyte/agent-docs-kit@latest --help</span><br><span data-command="--version">npx @ghostbyte/agent-docs-kit@latest --version</span></code></div><div><h3>Inspect the command surface</h3><p>Prints usage and options or the installed package version. These are useful when verifying an npm or npx installation.</p></div></article>
|
|
322
|
+
</div>
|
|
323
|
+
|
|
324
|
+
<div class="options-block">
|
|
325
|
+
<div><p class="eyebrow">Shared options</p><h3>Control scope and output.</h3></div>
|
|
326
|
+
<dl>
|
|
327
|
+
<div><dt><code>--cwd <path></code></dt><dd>Run against another project directory instead of the current directory.</dd></div>
|
|
328
|
+
<div><dt><code>--dry-run</code></dt><dd>Preview owned file writes without creating or replacing anything.</dd></div>
|
|
329
|
+
<div><dt><code>--force</code></dt><dd>Replace files owned by the selected command. Unrelated files remain outside its scope.</dd></div>
|
|
330
|
+
<div><dt><code>--style standard|learning</code></dt><dd>Choose concise findings or add “why this matters” teaching context.</dd></div>
|
|
331
|
+
<div><dt><code>--report</code></dt><dd>Persist a documentation-audit result instead of printing it only.</dd></div>
|
|
332
|
+
<div><dt><code>--strict</code></dt><dd>Return a failing exit code when a documentation audit finds a problem.</dd></div>
|
|
333
|
+
<div><dt><code>--format text|markdown|json</code></dt><dd>Choose terminal or persisted documentation-audit output.</dd></div>
|
|
334
|
+
<div><dt><code>--name <slug></code></dt><dd>Give a template record a lowercase, hyphenated filename suffix.</dd></div>
|
|
335
|
+
<div><dt><code>--phase / --topic</code></dt><dd>Alternative named selectors for security phases and engineering topics.</dd></div>
|
|
336
|
+
</dl>
|
|
337
|
+
</div>
|
|
338
|
+
</section>
|
|
339
|
+
</main>
|
|
340
|
+
|
|
341
|
+
<footer>
|
|
342
|
+
<div class="shell footer-layout"><div><a class="brand" href="#top"><span class="brand-mark" aria-hidden="true">AQ</span><span>Agent Docs & Quality</span></a><p>Documentation governance, security assurance, and engineering review in one project-quality library.</p></div><div><p>Project</p><a href="https://github.com/ghostbyte1014/Agent_Docs_Kit">GitHub repository</a><a href="docs/GITHUB_AND_NPM_SETUP.md">Setup guide</a><a href="docs/ARCHITECTURE.md">Architecture</a></div><div><p>Reference</p><a href="docs/PURPOSE.md">Purpose</a><a href="docs/SECURITY_MODEL.md">Security model</a><a href="docs/RELEASE_PROCESS.md">Release process</a></div></div>
|
|
343
|
+
<div class="shell footer-bottom"><span>Created by ghostbyte1014</span><span>MIT License</span></div>
|
|
344
|
+
</footer>
|
|
345
|
+
</body>
|
|
346
|
+
</html>
|