@alucify/cli 0.6.5 → 0.7.1

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 (202) hide show
  1. package/dist/cli.js +1590 -1061
  2. package/dist/docs/help/cli/_meta.json +1 -0
  3. package/dist/docs/help/cli/authentication.md +70 -0
  4. package/dist/docs/help/cli/automation.md +72 -0
  5. package/dist/docs/help/cli/commands/_meta.json +1 -0
  6. package/dist/docs/help/cli/commands/add-spec.md +49 -0
  7. package/dist/docs/help/cli/commands/analyze-code.md +54 -0
  8. package/dist/docs/help/cli/commands/analyze-progress.md +73 -0
  9. package/dist/docs/help/cli/commands/analyze-specs.md +60 -0
  10. package/dist/docs/help/cli/commands/capture-intent.md +56 -0
  11. package/dist/docs/help/cli/commands/check.md +49 -0
  12. package/dist/docs/help/cli/commands/context.md +52 -0
  13. package/dist/docs/help/cli/commands/continue.md +40 -0
  14. package/dist/docs/help/cli/commands/enable-disable.md +53 -0
  15. package/dist/docs/help/cli/commands/help.md +30 -0
  16. package/dist/docs/help/cli/commands/mcp-install.md +54 -0
  17. package/dist/docs/help/cli/commands/plan.md +43 -0
  18. package/dist/docs/help/cli/commands/progress.md +58 -0
  19. package/dist/docs/help/cli/commands/status.md +50 -0
  20. package/dist/docs/help/cli/commands/ui.md +50 -0
  21. package/dist/docs/help/cli/commands/usage.md +65 -0
  22. package/dist/docs/help/cli/commands/version.md +66 -0
  23. package/dist/docs/help/cli/installation.md +70 -0
  24. package/dist/docs/help/cli/quickstart.md +75 -0
  25. package/dist/docs/help/cli/ui/_meta.json +1 -0
  26. package/dist/docs/help/cli/ui/ai-coding-risks-tab.md +46 -0
  27. package/dist/docs/help/cli/ui/appgraph-visualizer-tab.md +54 -0
  28. package/dist/docs/help/cli/ui/artifacts-sidebar.md +53 -0
  29. package/dist/docs/help/cli/ui/chat-panel.md +56 -0
  30. package/dist/docs/help/cli/ui/code-analysis-tab.md +36 -0
  31. package/dist/docs/help/cli/ui/dashboard.md +44 -0
  32. package/dist/docs/help/cli/ui/launching.md +46 -0
  33. package/dist/docs/help/cli/ui/requirements-progress-tab.md +49 -0
  34. package/dist/docs/help/cli/ui/settings-tab.md +52 -0
  35. package/dist/docs/help/cli/ui/tech-debt-tab.md +29 -0
  36. package/dist/docs/help/cli/ui/token-usage-tab.md +46 -0
  37. package/dist/docs/help/concepts/_meta.json +1 -0
  38. package/dist/docs/help/concepts/ai-coding-risks.md +50 -0
  39. package/dist/docs/help/concepts/ai-readiness.md +34 -0
  40. package/dist/docs/help/concepts/analysis-modes.md +66 -0
  41. package/dist/docs/help/concepts/appgraph.md +56 -0
  42. package/dist/docs/help/concepts/artifacts-and-specs.md +46 -0
  43. package/dist/docs/help/concepts/authentication-modes.md +68 -0
  44. package/dist/docs/help/concepts/blast-radius.md +37 -0
  45. package/dist/docs/help/concepts/chat-refinement.md +40 -0
  46. package/dist/docs/help/concepts/congruency-coverage-completeness.md +50 -0
  47. package/dist/docs/help/concepts/implementation-progress.md +44 -0
  48. package/dist/docs/help/concepts/intent-capture.md +46 -0
  49. package/dist/docs/help/concepts/tech-debt-analysis.md +65 -0
  50. package/dist/docs/help/concepts/token-usage.md +70 -0
  51. package/dist/docs/help/concepts/versions-and-snapshots.md +57 -0
  52. package/dist/docs/help/concepts/workflow-overview.md +40 -0
  53. package/dist/docs/help/desktop/_meta.json +1 -0
  54. package/dist/docs/help/desktop/installation.md +56 -0
  55. package/dist/docs/help/desktop/keyboard-shortcuts.md +47 -0
  56. package/dist/docs/help/desktop/menu-bar.md +47 -0
  57. package/dist/docs/help/desktop/notifications.md +44 -0
  58. package/dist/docs/help/desktop/quickstart.md +43 -0
  59. package/dist/docs/help/desktop/switching-workspaces.md +39 -0
  60. package/dist/docs/help/desktop/workspace-picker.md +38 -0
  61. package/dist/docs/help/extension/_meta.json +1 -0
  62. package/dist/docs/help/extension/authentication/_meta.json +1 -0
  63. package/dist/docs/help/extension/authentication/api-key-setup.md +47 -0
  64. package/dist/docs/help/extension/authentication/claude-code-setup.md +43 -0
  65. package/dist/docs/help/extension/authentication/signing-in.md +36 -0
  66. package/dist/docs/help/extension/authentication/switching-auth-modes.md +28 -0
  67. package/dist/docs/help/extension/chat/_meta.json +1 -0
  68. package/dist/docs/help/extension/chat/asking-about-your-project.md +39 -0
  69. package/dist/docs/help/extension/code-analysis/_meta.json +1 -0
  70. package/dist/docs/help/extension/code-analysis/analysis-modes.md +63 -0
  71. package/dist/docs/help/extension/code-analysis/running-code-analysis.md +54 -0
  72. package/dist/docs/help/extension/code-analysis/understanding-ai-coding-risks.md +75 -0
  73. package/dist/docs/help/extension/code-analysis/understanding-tech-debt-analysis.md +90 -0
  74. package/dist/docs/help/extension/code-analysis/understanding-the-code-analysis-tab.md +49 -0
  75. package/dist/docs/help/extension/dev-progress/_meta.json +1 -0
  76. package/dist/docs/help/extension/dev-progress/analyzing-commits.md +56 -0
  77. package/dist/docs/help/extension/dev-progress/understanding-the-dev-progress-tab.md +40 -0
  78. package/dist/docs/help/extension/installation.md +34 -0
  79. package/dist/docs/help/extension/intent-capture/_meta.json +1 -0
  80. package/dist/docs/help/extension/intent-capture/enabling-intent-capture.md +40 -0
  81. package/dist/docs/help/extension/intent-capture/understanding-intent-capture.md +40 -0
  82. package/dist/docs/help/extension/quickstart.md +60 -0
  83. package/dist/docs/help/extension/resetting-analysis.md +46 -0
  84. package/dist/docs/help/extension/settings/_meta.json +1 -0
  85. package/dist/docs/help/extension/settings/notification-preferences.md +38 -0
  86. package/dist/docs/help/extension/settings/telemetry.md +45 -0
  87. package/dist/docs/help/extension/spec-analysis/_meta.json +1 -0
  88. package/dist/docs/help/extension/spec-analysis/adding-specs.md +40 -0
  89. package/dist/docs/help/extension/spec-analysis/analyzing-specs.md +60 -0
  90. package/dist/docs/help/extension/spec-analysis/auditing-specs.md +30 -0
  91. package/dist/docs/help/extension/spec-analysis/filtering-and-browsing-specs.md +43 -0
  92. package/dist/docs/help/extension/spec-analysis/generating-specs.md +47 -0
  93. package/dist/docs/help/extension/spec-analysis/refining-specs.md +53 -0
  94. package/dist/docs/help/extension/spec-analysis/understanding-the-spec-analysis-tab.md +55 -0
  95. package/dist/docs/help/extension/token-usage/_meta.json +1 -0
  96. package/dist/docs/help/extension/token-usage/understanding-token-usage.md +64 -0
  97. package/dist/docs/help/extension/token-usage/viewing-token-usage.md +63 -0
  98. package/dist/docs/help/faq.md +128 -0
  99. package/dist/docs/help/getting-started/_meta.json +1 -0
  100. package/dist/docs/help/getting-started/choosing-a-ui.md +60 -0
  101. package/dist/docs/help/getting-started/first-analysis.md +86 -0
  102. package/dist/docs/help/getting-started/installation.md +65 -0
  103. package/dist/docs/help/getting-started/key-concepts.md +73 -0
  104. package/dist/docs/help/getting-started/supported-project-types.md +65 -0
  105. package/dist/docs/help/getting-started/system-requirements.md +61 -0
  106. package/dist/docs/help/integrations/_meta.json +1 -0
  107. package/dist/docs/help/integrations/ci-cd.md +95 -0
  108. package/dist/docs/help/integrations/claude-code-hooks.md +54 -0
  109. package/dist/docs/help/integrations/claude-code.md +123 -0
  110. package/dist/docs/help/integrations/git-hooks.md +64 -0
  111. package/dist/docs/help/mcp-server/_meta.json +1 -0
  112. package/dist/docs/help/mcp-server/quickstart.md +59 -0
  113. package/dist/docs/help/mcp-server/resources/_meta.json +1 -0
  114. package/dist/docs/help/mcp-server/resources/terminology-resource.md +74 -0
  115. package/dist/docs/help/mcp-server/setup.md +75 -0
  116. package/dist/docs/help/mcp-server/tools/_meta.json +1 -0
  117. package/dist/docs/help/mcp-server/tools/coverage-gaps.md +58 -0
  118. package/dist/docs/help/mcp-server/tools/find-similar-context.md +65 -0
  119. package/dist/docs/help/mcp-server/tools/get-analysis.md +54 -0
  120. package/dist/docs/help/mcp-server/tools/get-details.md +48 -0
  121. package/dist/docs/help/mcp-server/tools/impact-analysis.md +49 -0
  122. package/dist/docs/help/mcp-server/tools/implementation-tasks.md +68 -0
  123. package/dist/docs/help/mcp-server/tools/link-node.md +51 -0
  124. package/dist/docs/help/mcp-server/tools/query.md +53 -0
  125. package/dist/docs/help/mcp-server/tools/tools-reference.md +63 -0
  126. package/dist/docs/help/mcp-server/tools/verify-plan.md +82 -0
  127. package/dist/docs/help/mcp-server/tools/version-diff.md +42 -0
  128. package/dist/docs/help/mcp-server/using-with-claude-code.md +72 -0
  129. package/dist/docs/help/reference/_meta.json +1 -0
  130. package/dist/docs/help/reference/alucify-directory.md +86 -0
  131. package/dist/docs/help/reference/file-types-and-formats.md +76 -0
  132. package/dist/docs/help/reference/glossary.md +60 -0
  133. package/dist/docs/help/reference/how-claude-code-integration-works.md +123 -0
  134. package/dist/docs/help/reference/ui-parity-matrix.md +121 -0
  135. package/dist/docs/help/vscode/_meta.json +1 -0
  136. package/dist/docs/help/vscode/advanced/_meta.json +1 -0
  137. package/dist/docs/help/vscode/advanced/congruency-analysis.md +32 -0
  138. package/dist/docs/help/vscode/advanced/coverage-analysis.md +31 -0
  139. package/dist/docs/help/vscode/advanced/developer-mode.md +34 -0
  140. package/dist/docs/help/vscode/advanced/findings-synthesis.md +27 -0
  141. package/dist/docs/help/vscode/advanced/impact-analysis.md +31 -0
  142. package/dist/docs/help/vscode/advanced/reset-extension.md +39 -0
  143. package/dist/docs/help/vscode/appgraph-visualizer/_meta.json +1 -0
  144. package/dist/docs/help/vscode/appgraph-visualizer/filtering-and-search.md +63 -0
  145. package/dist/docs/help/vscode/appgraph-visualizer/navigating-the-graph.md +34 -0
  146. package/dist/docs/help/vscode/appgraph-visualizer/node-details.md +49 -0
  147. package/dist/docs/help/vscode/appgraph-visualizer/opening-the-visualizer.md +33 -0
  148. package/dist/docs/help/vscode/authentication/_meta.json +1 -0
  149. package/dist/docs/help/vscode/authentication/api-key-setup.md +47 -0
  150. package/dist/docs/help/vscode/authentication/claude-code-setup.md +43 -0
  151. package/dist/docs/help/vscode/authentication/signing-in.md +36 -0
  152. package/dist/docs/help/vscode/authentication/switching-auth-modes.md +28 -0
  153. package/dist/docs/help/vscode/chat/_meta.json +1 -0
  154. package/dist/docs/help/vscode/chat/asking-about-your-project.md +39 -0
  155. package/dist/docs/help/vscode/chat/generating-artifacts-in-chat.md +53 -0
  156. package/dist/docs/help/vscode/chat/refining-specs-in-chat.md +47 -0
  157. package/dist/docs/help/vscode/code-analysis/_meta.json +1 -0
  158. package/dist/docs/help/vscode/code-analysis/ai-coding-risks-panel.md +42 -0
  159. package/dist/docs/help/vscode/code-analysis/project-analysis-panel.md +46 -0
  160. package/dist/docs/help/vscode/code-analysis/running-code-analysis.md +54 -0
  161. package/dist/docs/help/vscode/code-analysis/tech-debt-panel.md +27 -0
  162. package/dist/docs/help/vscode/command-palette.md +83 -0
  163. package/dist/docs/help/vscode/dev-progress/_meta.json +1 -0
  164. package/dist/docs/help/vscode/dev-progress/analyzing-commits.md +56 -0
  165. package/dist/docs/help/vscode/dev-progress/progress-panel-actions.md +56 -0
  166. package/dist/docs/help/vscode/dev-progress/understanding-the-dev-progress-tab.md +40 -0
  167. package/dist/docs/help/vscode/installation.md +34 -0
  168. package/dist/docs/help/vscode/intent-capture/_meta.json +1 -0
  169. package/dist/docs/help/vscode/intent-capture/analyzing-intent.md +49 -0
  170. package/dist/docs/help/vscode/intent-capture/enabling-intent-capture.md +40 -0
  171. package/dist/docs/help/vscode/quickstart.md +60 -0
  172. package/dist/docs/help/vscode/resetting-analysis.md +46 -0
  173. package/dist/docs/help/vscode/settings/_meta.json +1 -0
  174. package/dist/docs/help/vscode/settings/advanced-mode.md +53 -0
  175. package/dist/docs/help/vscode/settings/all-settings.md +66 -0
  176. package/dist/docs/help/vscode/settings/auto-analyze-specs.md +43 -0
  177. package/dist/docs/help/vscode/settings/notification-preferences.md +38 -0
  178. package/dist/docs/help/vscode/settings/telemetry.md +45 -0
  179. package/dist/docs/help/vscode/spec-analysis/_meta.json +1 -0
  180. package/dist/docs/help/vscode/spec-analysis/adding-specs.md +40 -0
  181. package/dist/docs/help/vscode/spec-analysis/analyzing-specs.md +60 -0
  182. package/dist/docs/help/vscode/spec-analysis/auditing-specs.md +30 -0
  183. package/dist/docs/help/vscode/spec-analysis/filtering-and-browsing-specs.md +43 -0
  184. package/dist/docs/help/vscode/spec-analysis/generating-specs.md +47 -0
  185. package/dist/docs/help/vscode/spec-analysis/refining-specs.md +53 -0
  186. package/dist/docs/help/vscode/spec-analysis/specifications-panel.md +46 -0
  187. package/dist/docs/help/vscode/status-bar.md +44 -0
  188. package/dist/docs/help/vscode/token-usage/_meta.json +1 -0
  189. package/dist/docs/help/vscode/token-usage/viewing-token-usage.md +63 -0
  190. package/dist/docs/help/vscode/versions/_meta.json +1 -0
  191. package/dist/docs/help/vscode/versions/comparing-versions.md +47 -0
  192. package/dist/docs/help/vscode/versions/deleting-versions.md +44 -0
  193. package/dist/docs/help/vscode/versions/switching-versions.md +43 -0
  194. package/dist/docs/help/vscode/workflow-controls.md +49 -0
  195. package/dist/docs/help/what-is-alucify.md +56 -0
  196. package/dist/mcp-server-vendored.js +28 -28
  197. package/dist/web/app.css +38 -0
  198. package/dist/web/app.js +671 -0
  199. package/dist/web/favicon.png +0 -0
  200. package/dist/web/favicon.svg +7 -0
  201. package/dist/web/index.html +15 -0
  202. package/package.json +1 -1
@@ -0,0 +1,68 @@
1
+ ---
2
+ order: 12
3
+ title: "Authentication Modes"
4
+ description: "The two ways Alucify authenticates with Claude — API key vs Claude Code subscription."
5
+ ---
6
+
7
+ # Authentication Modes
8
+
9
+ Alucify talks to Claude through one of two modes. You choose which mode to use during onboarding, and you can switch later.
10
+
11
+ ## Claude Code Subscription (default)
12
+
13
+ Alucify uses your existing Claude Code CLI login. No separate API key needed — if you're signed in to Claude Code, you're signed in to Alucify.
14
+
15
+ **Prerequisites:**
16
+ - Claude Code CLI installed (`claude` on your PATH)
17
+ - Active Claude subscription (Pro or Team)
18
+
19
+ **Pros:**
20
+ - No API key to manage
21
+ - Usage counts against your subscription, not a separate API bill
22
+ - Faster onboarding
23
+
24
+ **Cons:**
25
+ - Requires the Claude Code CLI installed locally
26
+ - Usage is capped by subscription limits (5-hour rolling windows)
27
+
28
+ ## Anthropic API Key
29
+
30
+ Alucify calls the Anthropic API directly using your API key. Usage is billed to your Anthropic Console account.
31
+
32
+ **Prerequisites:**
33
+ - API key from [console.anthropic.com](https://console.anthropic.com)
34
+
35
+ **Pros:**
36
+ - No local CLI dependency
37
+ - Usage limits are based on your API tier, not subscription
38
+
39
+ **Cons:**
40
+ - Separate billing to manage
41
+ - You handle the key securely (stored in OS keychain or CLI credentials file)
42
+
43
+ ## Which Mode Should I Use?
44
+
45
+ - **Active Claude Code user on Pro/Team plan** → Claude Code Subscription
46
+ - **Standalone / CI / team deployments** → API Key
47
+ - **Want lowest friction to start** → Claude Code Subscription
48
+ - **Want predictable, isolated billing** → API Key
49
+
50
+ ## Setting Up
51
+
52
+ - CLI: [Authentication](../cli/authentication.md)
53
+ - VS Code: [Signing In](../vscode/authentication/signing-in.md), [API Key Setup](../vscode/authentication/api-key-setup.md), [Claude Code Setup](../vscode/authentication/claude-code-setup.md)
54
+ - Web UI: [Settings Tab](../cli/ui/settings-tab.md)
55
+ - Desktop: same as Web UI (auth UI is embedded)
56
+
57
+ ## Switching Modes
58
+
59
+ You can switch between modes at any time without losing analysis data.
60
+ - VS Code: [Switching Auth Modes](../vscode/authentication/switching-auth-modes.md)
61
+
62
+ ## Where Credentials Are Stored
63
+
64
+ - **API key (VS Code):** OS keychain via VS Code secret storage
65
+ - **API key (CLI):** `~/.alucify/credentials.json` (chmod 600)
66
+ - **Claude Code subscription:** Inherited from Claude Code CLI's own credential store (`~/.claude/`)
67
+
68
+ Alucify never transmits credentials to its own servers — all LLM calls go directly to Anthropic.
@@ -0,0 +1,37 @@
1
+ ---
2
+ order: 14
3
+ title: "Blast Radius"
4
+ description: "What blast radius means and how Alucify computes the impact of changes."
5
+ ---
6
+
7
+ # Blast Radius
8
+
9
+ Blast radius measures the potential impact of changing a piece of code. A small blast radius means a change is well-contained; a large blast radius means changing one thing may ripple through many others.
10
+
11
+ ## Why It Matters
12
+
13
+ AI coding agents (and humans) make safer, faster changes to low-blast-radius code. High-blast-radius areas are where small edits cause unexpected breakage — exactly the kind of thing Alucify wants you to see *before* handing work to an agent.
14
+
15
+ ## How It's Computed
16
+
17
+ Blast radius is a graph computation over the [AppGraph](appgraph.md):
18
+
19
+ 1. Start from a node (e.g., a function, a data model, a UI component)
20
+ 2. Follow outbound edges (`depends_on`, `affects`, `parent_of`)
21
+ 3. Count the transitively-reachable nodes within a hop limit (typically 3 hops)
22
+ 4. Normalize against the total graph size → a percentage
23
+
24
+ So "23% blast radius" means that roughly 23% of the project is reachable from that node within a few dependency hops.
25
+
26
+ ## Project-Level vs Node-Level
27
+
28
+ - **Project-level blast radius** — The average across all change-prone nodes. Shown as a top-level metric on the Spec Analysis tab.
29
+ - **Node-level blast radius** — How much the project would be affected if *this specific node* changed. Shown in node details and in the AppGraph Visualizer.
30
+
31
+ ## As a Risk Signal
32
+
33
+ Any node with a high blast radius (typically > 30%) becomes a **High Blast Radius** risk in the [AI Coding Risks](ai-coding-risks.md) panel. It's a warning, not a problem per se — some high-blast-radius code is inevitable (core utilities, foundational types). But if you didn't expect a node to have high blast radius, that's a structural issue worth investigating.
34
+
35
+ ## Trace Dependencies (MCP)
36
+
37
+ From Claude Code you can ask for the blast radius of a file or set of files via [`trace_dependencies`](../mcp-server/tools/impact-analysis.md). The response includes direct and transitive impacts up to 3 hops.
@@ -0,0 +1,40 @@
1
+ ---
2
+ order: 15
3
+ title: "Chat Refinement"
4
+ description: "How Alucify's chat lets you refine specs, ask about your project, and generate artifacts."
5
+ ---
6
+
7
+ # Chat Refinement
8
+
9
+ Alucify's chat is a multi-turn Claude conversation grounded in your current AppGraph, specs, and analysis. You use it to refine specs, ask questions about your project, and generate new artifacts — all without leaving the product.
10
+
11
+ ## Three Chat Modes
12
+
13
+ ### Ask About Your Project
14
+ Open-ended Q&A grounded in your current AppGraph. Good for exploratory questions: "Which features are least tested?", "What specs contradict the code?", "What's the blast radius of this module?"
15
+
16
+ ### Refine Specs
17
+ Iterative spec improvement focused on specific risks or requirements. You typically open this from the AI Coding Risks panel — Claude sees the risk context and helps you resolve it.
18
+
19
+ ### Generate Artifacts
20
+ AI-assisted spec writing from templates (PRD, architecture, UX, epics/stories, quick spec, custom). Claude drafts the spec using your project context, then you iterate.
21
+
22
+ ## What Makes It Different from Raw Claude
23
+
24
+ Every chat turn includes:
25
+ - The current AppGraph summary
26
+ - Relevant spec excerpts
27
+ - Current risk context (if applicable)
28
+ - Existing artifact content
29
+
30
+ This grounding means Claude doesn't hallucinate about your project — it's working from the real analysis data.
31
+
32
+ ## Where to Find It
33
+
34
+ - VS Code: [Asking About Your Project](../vscode/chat/asking-about-your-project.md), [Refining Specs in Chat](../vscode/chat/refining-specs-in-chat.md), [Generating Artifacts in Chat](../vscode/chat/generating-artifacts-in-chat.md)
35
+ - Web UI: [Chat Panel](../cli/ui/chat-panel.md)
36
+ - Desktop: uses the same chat as the Web UI (embedded)
37
+
38
+ ## Not the Same as Claude Code
39
+
40
+ Alucify's chat is separate from Claude Code. Claude Code is the agent that actually makes edits to your files; Alucify's chat refines specs and answers questions about your project. The two integrate — Alucify's `alucify plan` and `alucify continue` commands launch Claude Code sessions with Alucify context pre-loaded. See [Claude Code Integration](../integrations/claude-code.md).
@@ -0,0 +1,50 @@
1
+ ---
2
+ order: 5
3
+ title: "Congruency, Coverage & Completeness"
4
+ description: "The three dimensions Alucify uses to measure spec-to-code alignment."
5
+ ---
6
+
7
+ # Congruency, Coverage & Completeness
8
+
9
+ Spec analysis measures three independent dimensions plus a composite readiness score.
10
+
11
+ ## Congruency
12
+
13
+ How well your specs **align** with your code. A high congruency score means specs and code tell the same story — few contradictions or mismatches. Low congruency means your specs describe something different from what the code actually does.
14
+
15
+ Congruency is scored 0–100%. You'll see it broken down per spec (in a heatmap) and aggregated across the project.
16
+
17
+ ## Coverage
18
+
19
+ How much of your codebase is **covered** by specifications. High coverage means most components have corresponding requirements or specs. Low coverage means you have code that isn't backed by any spec.
20
+
21
+ Coverage is scored 0–100%, broken down by component type (interfaces, logic, schemas, etc.).
22
+
23
+ ## Completeness
24
+
25
+ How thorough your specs are along multiple dimensions — do requirements have clear acceptance criteria? Are error states described? Are data models complete? Completeness catches thin specs even when congruency and coverage look fine.
26
+
27
+ ## AI Readiness
28
+
29
+ A composite score combining congruency, coverage, completeness, and other factors. This is the overall indicator of how prepared your project is for AI coding agents to work effectively. See [AI Readiness](ai-readiness.md).
30
+
31
+ ## Impact Categories
32
+
33
+ During spec analysis, every component gets classified into one of four impact categories:
34
+
35
+ - **New** — Introduced by specs, doesn't exist in code yet
36
+ - **Modified** — Existing in code, specs would change it
37
+ - **Affected** — Indirectly impacted by spec changes (via dependencies)
38
+ - **Intact** — Unaffected by spec changes
39
+
40
+ ## Relationship to AI Coding Risks
41
+
42
+ Low scores in any of these dimensions produce specific [AI Coding Risks](ai-coding-risks.md):
43
+
44
+ - Low coverage → Missing UX/Data/Logic Spec risks
45
+ - Low congruency → Conflict, Naming, or Requirements Gap risks
46
+ - Low completeness → Missing Acceptance Criteria risks
47
+
48
+ For UI-specific instructions on viewing these metrics, see:
49
+ - VS Code: [Specifications Panel](../vscode/spec-analysis/specifications-panel.md)
50
+ - Web UI: [Requirements Progress Tab](../cli/ui/requirements-progress-tab.md)
@@ -0,0 +1,44 @@
1
+ ---
2
+ order: 9
3
+ title: "Implementation Progress"
4
+ description: "How Alucify tracks what's implemented, what's in progress, and what's still open."
5
+ ---
6
+
7
+ # Implementation Progress
8
+
9
+ Alucify tracks implementation status on every node in your [AppGraph](appgraph.md), giving you a live picture of how much of your spec is actually built.
10
+
11
+ ## Statuses
12
+
13
+ Every requirement and validation node carries one of these statuses:
14
+
15
+ - **Planned** — Specified but no code exists yet
16
+ - **In Progress** — Partial implementation detected, or gaps flagged
17
+ - **Implemented** — Code satisfies the specification
18
+ - **Tested** — A validation (test) exists and maps to this requirement
19
+ - **Deprecated** — Intentionally removed or superseded
20
+
21
+ ## How Status Is Determined
22
+
23
+ Status is assigned in two phases:
24
+
25
+ ### 1. During Spec Analysis
26
+ When specs are integrated into the AppGraph, Alucify does a mechanical pass that matches each spec node to code it might be backed by. Clean matches get `implemented`; clear gaps get `planned`; partial or ambiguous matches get `in_progress` with gap notes.
27
+
28
+ ### 2. As Commits Land
29
+ Each git commit triggers progress analysis (via a post-commit hook if you've run `alucify enable`). Alucify reads the commit, maps changed files to nodes, and updates statuses. A pre-commit hook also runs a fast check so you see status updates before the commit finishes.
30
+
31
+ ## Gap Notes
32
+
33
+ For `in_progress` nodes, Alucify writes a short "what's still missing" note attached to the node. This is the most useful signal when you're about to hand work to Claude Code — the gap note tells the agent exactly where to pick up.
34
+
35
+ ## Progress Reports
36
+
37
+ - CLI: [`alucify progress`](../cli/commands/progress.md) and [`alucify status`](../cli/commands/status.md)
38
+ - VS Code: [Dev Progress Tab](../vscode/dev-progress/understanding-the-dev-progress-tab.md)
39
+ - Web UI: [Requirements Progress Tab](../cli/ui/requirements-progress-tab.md)
40
+ - MCP Server: [`get_implementation_tasks`](../mcp-server/tools/implementation-tasks.md), [`get_remaining_work`](../mcp-server/tools/coverage-gaps.md)
41
+
42
+ ## Planning Against Gaps
43
+
44
+ Use `alucify plan` or `/alucify-plan` in Claude Code to plan work against currently open requirements. The planner reads the current progress state and proposes implementation tasks focused on closing gaps. See [`alucify plan`](../cli/commands/plan.md) and [Using MCP with Claude Code](../mcp-server/using-with-claude-code.md).
@@ -0,0 +1,46 @@
1
+ ---
2
+ order: 10
3
+ title: "Intent Capture"
4
+ description: "What intent capture extracts from your Claude Code sessions and how it appears in your AppGraph."
5
+ ---
6
+
7
+ # Intent Capture
8
+
9
+ Intent capture surfaces requirements, decisions, and design context from your Claude Code sessions and adds them to your AppGraph — so the thinking behind your code doesn't get lost when a session ends.
10
+
11
+ For UI-specific instructions, see:
12
+ - CLI: [`alucify capture-intent`](../cli/commands/capture-intent.md)
13
+ - VS Code: [Enabling Intent Capture](../vscode/intent-capture/enabling-intent-capture.md)
14
+
15
+ ## What Gets Captured
16
+
17
+ When you work in a Claude Code session, you naturally produce context that's valuable for your project: requirements you clarified with Claude, design decisions you made, edge cases you discussed, and features you decided to scope in or out.
18
+
19
+ Intent capture reads your session history and looks for this kind of project-level context — things that would be useful to have in your AppGraph alongside your specs and code analysis.
20
+
21
+ Examples of what gets captured:
22
+ - A requirement you refined or added during a session ("we decided authentication should support SSO")
23
+ - A design decision tied to specific code ("we're using optimistic updates for this component")
24
+ - A scope clarification that affects your specs ("out of scope for v1: batch imports")
25
+
26
+ Sessions that are only execution work — running commands, fixing syntax errors, iterating on output — are skipped.
27
+
28
+ ## How It Appears in the AppGraph
29
+
30
+ Captured intent shows up in two ways:
31
+
32
+ - **New nodes** — If intent introduces a new requirement or feature not already in the AppGraph, a new node is created with an `intent` origin, so you can tell where it came from.
33
+ - **Annotations on existing nodes** — If intent relates to something already in the AppGraph, it's attached to that node as additional context.
34
+
35
+ You can filter by origin in the AppGraph Visualizer to see only intent-captured nodes.
36
+
37
+ ## What It Doesn't Capture
38
+
39
+ Intent capture is selective — it's designed to surface project-level decisions, not a transcript of everything you discussed. It won't add:
40
+ - Code snippets or implementation details (those belong in the code itself)
41
+ - Back-and-forth troubleshooting that didn't produce a decision
42
+ - Context that's already reflected in your specs or AppGraph
43
+
44
+ ## Privacy
45
+
46
+ Intent capture only reads local session files on your machine (`~/.claude/projects/`). Nothing is sent anywhere beyond the same Claude API calls your other Alucify workflows use. Captured intent is stored in `.alucify/extractions/intents/`, which you can commit or gitignore as you see fit.
@@ -0,0 +1,65 @@
1
+ ---
2
+ order: 7
3
+ title: "Tech Debt Analysis"
4
+ description: "What Tech Debt Analysis measures — health score, structural risk, debt trend, and complexity."
5
+ ---
6
+
7
+ # Tech Debt Analysis
8
+
9
+ Tech Debt Analysis is a detailed assessment of your codebase's structural health, helping you identify areas of architectural risk before they cause problems for AI coding agents. It runs as part of code analysis in Balanced or Quality modes.
10
+
11
+ For UI-specific instructions on viewing tech debt, see:
12
+ - VS Code: [Tech Debt Panel](../vscode/code-analysis/tech-debt-panel.md)
13
+ - Web UI: [Tech Debt Tab](../cli/ui/tech-debt-tab.md)
14
+
15
+ ## Architecture Health Score
16
+
17
+ A single score (0–100) with a letter grade summarizes overall health:
18
+
19
+ - **70–100 (Green)** — Healthy architecture with low structural risk
20
+ - **40–69 (Yellow)** — Moderate issues that should be addressed
21
+ - **Below 40 (Red)** — Significant structural problems that need attention
22
+
23
+ ## Banner Metrics
24
+
25
+ ### Change Scope
26
+ The average percentage of your project affected when a single change propagates through dependencies. **Lower is better** — it means changes stay contained rather than rippling across the system.
27
+
28
+ ### Structural Risk
29
+ How fragile your architecture is to cascading failures:
30
+ - **Low** — Less than 20% of components are at risk
31
+ - **Moderate** — 20–40% of components are at risk
32
+ - **High** — More than 40% of components are at risk
33
+
34
+ ### Debt Trend
35
+ Whether structural debt is growing or shrinking over time:
36
+ - **Stable** — Debt isn't compounding
37
+ - **X cycles (Doubling Time)** — Debt is growing; the number indicates how quickly
38
+ - **X cycles (Halving Time)** — Debt is shrinking; the architecture is improving
39
+
40
+ ## Detail Dimensions
41
+
42
+ ### Remediation
43
+ Priority actions to reduce technical debt, ordered by impact. Each action shows what percentage of total debt it addresses, the issue, and the expected outcome. A **Root Cause** alert may highlight high-dependency components that source multiple issues.
44
+
45
+ ### Change Scope
46
+ How far changes propagate through your codebase: average scope percentage, how many components a typical change touches, and a breakdown by change type rated Low / Moderate / High effort.
47
+
48
+ ### Structural Risk
49
+ A snapshot of architectural complexity today:
50
+ - **Fragility Index** — 0–100 score measuring coupling, dependency cycles, and bottlenecks
51
+ - **Health Score Breakdown** — individual scores for each dimension with letter grades and weights
52
+ - **Stress Attribution** — which structural patterns (circular dependencies, single points of failure, cross-feature coupling) contribute most to risk
53
+
54
+ ### Debt Trend (Projection)
55
+ A forward-looking simulation that projects how your architecture responds to sustained change pressure. Shows whether debt compounds or gets absorbed over time, a trajectory graph across simulation cycles, and the most affected components.
56
+
57
+ ### Complexity
58
+ Complexity hotspots by location, with maximum cognitive complexity per component. Scale:
59
+ - **0–5:** Trivial
60
+ - **6–15:** Moderate
61
+ - **16–30:** High (flagged as hotspot)
62
+ - **31+:** Very high (strong refactoring signal)
63
+
64
+ ### Outdated Packages
65
+ Dependencies that are out of date with current and latest versions, plus risk levels. Requires internet access during analysis.
@@ -0,0 +1,70 @@
1
+ ---
2
+ order: 11
3
+ title: "Token Usage"
4
+ description: "What tokens are, how they're categorized, and how to interpret your usage data."
5
+ ---
6
+
7
+ # Token Usage
8
+
9
+ This page explains what tokens are and how Alucify tracks them. For UI-specific instructions, see:
10
+ - CLI: [`alucify usage`](../cli/commands/usage.md)
11
+ - VS Code: [Viewing Token Usage](../vscode/token-usage/viewing-token-usage.md)
12
+ - Web UI: [Token Usage Tab](../cli/ui/token-usage-tab.md)
13
+
14
+
15
+ ## What Are Tokens?
16
+
17
+ Tokens are the unit of measurement for AI model input and output. Roughly, 1 token is about 4 characters of English text. Every interaction with Claude — whether through Alucify workflows or direct Claude Code sessions — consumes tokens.
18
+
19
+ ## Token Types
20
+
21
+ Each API call produces four types of token usage:
22
+
23
+ ### Output Tokens
24
+ Tokens generated by the model in its response (completions, code, analysis). This is typically the largest component of usage.
25
+
26
+ ### Cache Read Tokens
27
+ Input tokens that were served from Claude's prompt cache rather than reprocessed. Cached tokens are significantly cheaper than regular input tokens (90% discount). Alucify uses prompt caching extensively to reduce costs.
28
+
29
+ ### Cache Creation Tokens
30
+ Input tokens that were written to the prompt cache for the first time. These cost slightly more than regular input (25% premium) but enable cache reads on subsequent calls.
31
+
32
+ ### Input Tokens (Non-cached)
33
+ Input tokens that were neither cached nor cache-eligible. This is typically a small number since Alucify enables caching on system prompts and large content blocks.
34
+
35
+ ## Sources
36
+
37
+ Token usage comes from two distinct sources:
38
+
39
+ ### Alucify
40
+ Tokens consumed by Alucify's analysis workflows — code analysis, spec analysis, progress tracking, congruency checks, etc. These are automated agent calls managed by Alucify. Each record includes the specific workflow, phase, and agent that consumed the tokens.
41
+
42
+ ### Claude Code
43
+ Tokens consumed during your direct Claude Code sessions (CLI or IDE). These are your interactive coding sessions where you chat with Claude. Alucify reads the local session logs from `~/.claude/projects/` to track this usage. The two sources never overlap — Alucify's SDK calls use `persistSession: false` and don't appear in Claude Code logs.
44
+
45
+ ## Models
46
+
47
+ Different models have different token costs:
48
+ - **Opus** — Most capable, highest per-token cost
49
+ - **Sonnet** — Balanced capability and cost (Alucify's default for most agents)
50
+ - **Haiku** — Fastest and cheapest (used by Alucify for template-driven extraction)
51
+
52
+ The "By Model" breakdown helps you understand which models are consuming the most tokens.
53
+
54
+ ## Daily Average Comparison
55
+
56
+ The "This Week" and "Today" banner cards show a percentage comparing your current usage to your daily average. This helps you quickly spot whether today is a heavy or light usage day:
57
+
58
+ - **Orange (up arrow)** — Above your daily average by more than 10%
59
+ - **Green (down arrow)** — Below your daily average by more than 10%
60
+ - **"avg"** — Within 10% of your daily average
61
+
62
+ ## Per-User Tracking
63
+
64
+ Every usage record is tagged with the git user email (`git config user.email`) of whoever triggered it. This enables per-user breakdowns in team environments. The token usage JSONL file is shared across the team (if committed), while the session reader state is per-user and gitignored.
65
+
66
+ ## Data Storage
67
+
68
+ Token usage data is stored in `.alucify/token-usage/usage.jsonl` as an append-only log. Each line is a JSON record with all token counts, metadata, and timestamps. This file can be committed to version control for team visibility or gitignored for privacy — your choice.
69
+
70
+ Per-user reader state files (`.alucify/token-usage/state.*.json`) track which Claude Code sessions have been ingested. These are automatically gitignored.
@@ -0,0 +1,57 @@
1
+ ---
2
+ order: 13
3
+ title: "Versions & Snapshots"
4
+ description: "How Alucify versions your analysis and lets you compare or revert between versions."
5
+ ---
6
+
7
+ # Versions & Snapshots
8
+
9
+ Every time Alucify runs a code analysis, spec analysis, or progress analysis, it creates a new versioned snapshot of your AppGraph. Nothing is overwritten — you always have history.
10
+
11
+ ## Version Identifiers
12
+
13
+ Versions are labeled `v1`, `v2`, `v3`, ... in the order they were created. The most recent version is your "current" version; earlier versions stay available for comparison.
14
+
15
+ ## What's in a Version
16
+
17
+ Each version captures:
18
+ - The full AppGraph (nodes + edges)
19
+ - Scores (congruency, coverage, AI readiness, etc.)
20
+ - Risks identified at that point
21
+ - Implementation status per node
22
+ - Analysis mode used
23
+
24
+ Version metadata (timestamp, git commit hash, who ran it) is stored in `.alucify/versions/`.
25
+
26
+ ## Diffing Versions
27
+
28
+ You can compare any two versions to see:
29
+ - Nodes added, removed, or modified
30
+ - Status changes (e.g., `planned` → `implemented`)
31
+ - Score deltas
32
+ - Risks resolved or newly surfaced
33
+
34
+ Commands:
35
+ - CLI: [`alucify version --diff v1..v3`](../cli/commands/version.md)
36
+ - VS Code: [Comparing Versions](../vscode/versions/comparing-versions.md)
37
+ - MCP Server: [`diff_context`](../mcp-server/tools/version-diff.md)
38
+
39
+ ## Switching Versions
40
+
41
+ You can load an older version as your current view if you want to see the project as it was at an earlier point. This doesn't delete newer versions — they remain available.
42
+
43
+ - VS Code: [Switching Versions](../vscode/versions/switching-versions.md)
44
+
45
+ ## Deleting Versions
46
+
47
+ Old versions take disk space but are otherwise harmless. You can delete versions you no longer need; the current version can't be deleted.
48
+
49
+ - VS Code: [Deleting Versions](../vscode/versions/deleting-versions.md)
50
+
51
+ ## Version Control
52
+
53
+ You can commit `.alucify/` to git to share AppGraph history with your team (recommended for most projects), or gitignore it for privacy. See [Alucify Directory Structure](../reference/alucify-directory.md#version-control).
54
+
55
+ ## Progressive Snapshots
56
+
57
+ During a long analysis, Alucify writes an in-progress version snapshot so you can see partial results before the full analysis completes. In-progress versions are filtered out of the default version list but can be viewed in Advanced mode.
@@ -0,0 +1,40 @@
1
+ ---
2
+ order: 1
3
+ title: "Workflow Overview"
4
+ description: "The five-step Alucify workflow that applies across every UI."
5
+ ---
6
+
7
+ # Workflow Overview
8
+
9
+ Alucify's core workflow is the same across every UI — only the way you invoke each step changes.
10
+
11
+ ## The Five Steps
12
+
13
+ ### 1. Analyze Code
14
+ Alucify scans your codebase and builds a baseline [AppGraph](appgraph.md) — a structured model of interfaces, logic, schemas, and dependencies. You choose an [analysis mode](analysis-modes.md) based on how much time and cost you want to spend.
15
+
16
+ ### 2. Add Specs
17
+ You import specification artifacts (PRDs, architecture docs, designs, requirements) into Alucify. See [Artifacts & Specs](artifacts-and-specs.md) for supported formats.
18
+
19
+ ### 3. Analyze Specs
20
+ Alucify compares your specs against your code and produces three alignment scores: [Congruency, Coverage & Completeness](congruency-coverage-completeness.md). It also surfaces [AI Coding Risks](ai-coding-risks.md) — concrete issues that would confuse an AI coding agent.
21
+
22
+ ### 4. Review Risks
23
+ You review the identified risks and resolve them, either by refining specs, updating code, or marking a risk as ignored. [Chat-based refinement](chat-refinement.md) lets you work with Claude on fixes interactively.
24
+
25
+ ### 5. Plan & Track Progress
26
+ Once you're ready to implement, Alucify can plan work against the gaps and track [implementation progress](implementation-progress.md) as commits land.
27
+
28
+ ## Which UI Does What
29
+
30
+ | Step | CLI | VS Code | Web UI | Desktop |
31
+ |---|---|---|---|---|
32
+ | Analyze Code | `alucify analyze-code` | Analyze Code button | Dashboard → Analyze | Dashboard → Analyze |
33
+ | Add Specs | `alucify add-spec` | Specs sidebar → Add | Artifacts sidebar → Upload | Artifacts sidebar → Upload |
34
+ | Analyze Specs | `alucify analyze-specs` | Specs → Analyze | Dashboard → Analyze Specs | Dashboard → Analyze Specs |
35
+ | Review Risks | n/a (review via VS Code or Web) | AI Coding Risks panel | AI Coding Risks tab | AI Coding Risks tab |
36
+ | Plan & Track | `alucify plan`, `alucify progress` | Dev Progress tab | Requirements Progress tab | Requirements Progress tab |
37
+
38
+ ## Incremental Workflow
39
+
40
+ After the first full pass, subsequent analysis runs are incremental — Alucify detects which files changed since the last baseline and only re-analyzes what's affected. See [Versions & Snapshots](versions-and-snapshots.md).
@@ -0,0 +1 @@
1
+ { "title": "Desktop App", "order": 5 }
@@ -0,0 +1,56 @@
1
+ ---
2
+ order: 2
3
+ title: "Installation"
4
+ description: "Download and install the Alucify Desktop app on macOS, Windows, or Linux."
5
+ ---
6
+
7
+ # Installing Alucify Desktop
8
+
9
+ ## Download
10
+
11
+ Get the installer for your platform from the Alucify releases page:
12
+
13
+ - **macOS** — `.dmg` (Apple Silicon) or `.dmg` (Intel)
14
+ - **Windows** — `.exe` installer
15
+ - **Linux** — `.AppImage` or `.deb`
16
+
17
+ ## System Requirements
18
+
19
+ See [System Requirements](../getting-started/system-requirements.md). In short: modern 64-bit OS, 8 GB RAM recommended, ~500 MB disk.
20
+
21
+ ## macOS
22
+
23
+ 1. Download the `.dmg`
24
+ 2. Open it and drag **Alucify** into `Applications`
25
+ 3. The first time you open it, right-click → **Open** (macOS blocks unsigned apps by default; Alucify is signed and notarized but your OS may still warn)
26
+ 4. Grant any permissions the app requests
27
+
28
+ ## Windows
29
+
30
+ 1. Run the `.exe` installer
31
+ 2. Follow the prompts (choose a destination, create a shortcut)
32
+ 3. Launch **Alucify** from the Start menu
33
+
34
+ ## Linux
35
+
36
+ ### AppImage
37
+ 1. Download `Alucify-x.y.z.AppImage`
38
+ 2. `chmod +x Alucify-x.y.z.AppImage`
39
+ 3. Run it directly, or integrate with your desktop environment
40
+
41
+ ### Debian/Ubuntu (.deb)
42
+ ```bash
43
+ sudo dpkg -i alucify_x.y.z_amd64.deb
44
+ ```
45
+
46
+ ## Updates
47
+
48
+ The desktop app checks for updates on launch. When an update is available, you'll see a prompt. Updates download in the background and install on next restart.
49
+
50
+ ## Troubleshooting
51
+
52
+ **"App can't be opened" on macOS:** See the [FAQ](../faq.md) or right-click the app → Open (instead of double-click).
53
+
54
+ **Window doesn't appear:** Check if another Alucify window is already running — the app enforces a single instance per user.
55
+
56
+ **Workspace not loading:** See [Workspace Picker](workspace-picker.md).
@@ -0,0 +1,47 @@
1
+ ---
2
+ order: 7
3
+ title: "Keyboard Shortcuts"
4
+ description: "Platform-native shortcuts for common actions in Alucify Desktop."
5
+ ---
6
+
7
+ # Keyboard Shortcuts
8
+
9
+ Shortcuts follow each OS's conventions. `Cmd` is the macOS modifier; on Windows/Linux, use `Ctrl` instead.
10
+
11
+ ## File
12
+
13
+ | Action | macOS | Windows/Linux |
14
+ |---|---|---|
15
+ | Open Workspace | `Cmd+O` | `Ctrl+O` |
16
+ | Close Window | `Cmd+W` | `Ctrl+W` |
17
+ | Quit | `Cmd+Q` | `Alt+F4` |
18
+
19
+ ## Edit
20
+
21
+ Standard editing shortcuts work in any text field:
22
+
23
+ | Action | macOS | Windows/Linux |
24
+ |---|---|---|
25
+ | Undo | `Cmd+Z` | `Ctrl+Z` |
26
+ | Redo | `Cmd+Shift+Z` | `Ctrl+Y` |
27
+ | Cut / Copy / Paste | `Cmd+X/C/V` | `Ctrl+X/C/V` |
28
+ | Select All | `Cmd+A` | `Ctrl+A` |
29
+
30
+ ## View
31
+
32
+ | Action | macOS | Windows/Linux |
33
+ |---|---|---|
34
+ | Reload | `Cmd+R` | `Ctrl+R` |
35
+ | Developer Tools | `Cmd+Option+I` | `Ctrl+Shift+I` |
36
+ | Zoom In | `Cmd++` | `Ctrl++` |
37
+ | Zoom Out | `Cmd+-` | `Ctrl+-` |
38
+ | Actual Size | `Cmd+0` | `Ctrl+0` |
39
+ | Full Screen | `Ctrl+Cmd+F` | `F11` |
40
+
41
+ ## Web UI Shortcuts
42
+
43
+ Inside the embedded web UI, additional shortcuts may apply (search, chat focus, etc.). These are documented with each feature in [Web UI](../cli/ui/_meta.json).
44
+
45
+ ## Customization
46
+
47
+ Desktop-level shortcuts are not user-customizable in the current version. If that matters to you, let us know via the Help → Send Feedback menu.