@alucify/cli 0.6.5 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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,65 @@
1
+ ---
2
+ order: 5
3
+ title: "Installation"
4
+ description: "Install guides for each Alucify UI."
5
+ ---
6
+
7
+ # Installation
8
+
9
+ Pick the UI you want to install. You can install more than one; they all read from the same `.alucify/` project directory.
10
+
11
+ ## VS Code Extension
12
+
13
+ Search **Alucify** in the VS Code Marketplace, or install via command line:
14
+
15
+ ```bash
16
+ code --install-extension alucify.alucify
17
+ ```
18
+
19
+ Full guide: [VS Code Extension Installation](../vscode/installation.md).
20
+
21
+ ## CLI (+ Web UI)
22
+
23
+ ```bash
24
+ npm install -g @alucify/cli
25
+ ```
26
+
27
+ Verify:
28
+ ```bash
29
+ alucify --version
30
+ ```
31
+
32
+ The CLI bundles the Web UI — once installed, `alucify ui` launches the browser dashboard.
33
+
34
+ Full guide: [CLI Installation](../cli/installation.md).
35
+
36
+ ## Desktop App
37
+
38
+ Download the installer for your OS:
39
+ - macOS: `.dmg`
40
+ - Windows: `.exe`
41
+ - Linux: `.AppImage` or `.deb`
42
+
43
+ Full guide: [Desktop Installation](../desktop/installation.md).
44
+
45
+ ## MCP Server (Claude Code Integration)
46
+
47
+ The MCP server ships with the CLI. After installing the CLI, from any project directory run:
48
+
49
+ ```bash
50
+ alucify enable # full integration (hooks + MCP + CLAUDE.md)
51
+ # or
52
+ alucify mcp-install # MCP server only
53
+ ```
54
+
55
+ Full guide: [MCP Server Setup](../mcp-server/setup.md).
56
+
57
+ ## Prerequisites
58
+
59
+ All UIs require:
60
+ - Either a [Claude Code subscription](../concepts/authentication-modes.md#claude-code-subscription-default) or an [Anthropic API key](../concepts/authentication-modes.md#anthropic-api-key)
61
+ - Supported OS (see [System Requirements](system-requirements.md))
62
+
63
+ ## After Install
64
+
65
+ Once installed, run your [first analysis](first-analysis.md).
@@ -0,0 +1,73 @@
1
+ ---
2
+ order: 2
3
+ title: "Key Concepts"
4
+ description: "Core concepts in Alucify: code analysis, spec analysis, congruency, coverage, implementation status, and versions."
5
+ ---
6
+
7
+ # Key Concepts
8
+
9
+ Understanding these concepts will help you get the most out of Alucify.
10
+
11
+ ## Code Analysis
12
+
13
+ Code analysis scans your codebase and builds a structured model of your project. It identifies:
14
+
15
+ - **Interfaces** — Screens, UI components, API endpoints, and other interaction points
16
+ - **Logic** — Business logic, workflows, services, and handler functions
17
+ - **Schemas** — Data models, database schemas, and data structures
18
+
19
+ This baseline gives Alucify (and your AI coding agents) a structured understanding of what's already built.
20
+
21
+ ## Specs (Specifications)
22
+
23
+ Specs are the documents that describe what your project should do — PRDs, requirements documents, design files, API specifications, and any other project documentation. Alucify can import and analyze these to understand your project's intent.
24
+
25
+ ## Spec Analysis
26
+
27
+ Spec analysis compares your specifications against your codebase. It looks at several dimensions:
28
+
29
+ - **Congruency** — How well do your specs align with your code? Are there contradictions or mismatches between what's specified and what's built?
30
+ - **Coverage** — Are all requirements implemented? Are there specs without corresponding code, or code without corresponding specs?
31
+ - **Completeness** — Do your specs cover all the necessary dimensions? Are there missing requirements or gaps in your documentation?
32
+
33
+ ## AI Readiness
34
+
35
+ AI Readiness is a composite score (0–100%) that summarizes how prepared your project is for AI coding. It factors in congruency, coverage, and completeness. A higher score means an AI coding agent is more likely to produce correct, aligned implementations.
36
+
37
+ ## Implementation Status
38
+
39
+ Each component in your project can have an implementation status:
40
+
41
+ - **Planned** — Specified but not yet started
42
+ - **In Progress** — Currently being implemented
43
+ - **Implemented** — Code has been written
44
+ - **Tested** — Tests exist and pass
45
+ - **Deprecated** — No longer active
46
+
47
+ Alucify tracks these statuses as you analyze commits and make progress.
48
+
49
+ ## Versions
50
+
51
+ Each time you run an analysis, Alucify saves a versioned snapshot (v1, v2, v3, etc.). This lets you track how your project evolves over time. You can compare versions to see what's changed.
52
+
53
+ ## Analysis Modes
54
+
55
+ Alucify offers three analysis depth levels:
56
+
57
+ - **Speed** — Fast, mechanical analysis. Usually 5–10 minutes. No AI costs.
58
+ - **Balanced** — Moderate depth with AI-powered analysis. Usually 15–60 minutes.
59
+ - **Quality** — Comprehensive AI analysis. Usually 45–90 minutes.
60
+
61
+ See [Analysis Modes](../concepts/analysis-modes.md) for more detail.
62
+
63
+ ## AI Coding Risks
64
+
65
+ Risks that Alucify identifies which could cause problems for AI coding agents — things like missing specs, conflicting requirements, high blast radius areas, and untested code paths.
66
+
67
+ ## Blast Radius
68
+
69
+ The percentage of your project that could be affected by a change. A high blast radius means changes in one area ripple across many parts of the system. Understanding blast radius helps you and your AI agents make safer changes.
70
+
71
+ ## Grounding
72
+
73
+ How well a component is anchored in your specifications. A component with strong grounding has clear spec references and well-defined requirements. Components with weak grounding may need better documentation before AI coding.
@@ -0,0 +1,65 @@
1
+ ---
2
+ order: 4
3
+ title: "Supported Project Types & Languages"
4
+ description: "Languages, frameworks, and project structures that Alucify can analyze."
5
+ ---
6
+
7
+ # Supported Project Types & Languages
8
+
9
+ Alucify can analyze projects written in a wide range of languages and frameworks.
10
+
11
+ ## Supported Languages
12
+
13
+ - TypeScript / JavaScript (including JSX/TSX)
14
+ - Python
15
+ - Java
16
+ - Go
17
+ - Rust
18
+ - Ruby
19
+ - C / C++
20
+ - C#
21
+ - Swift
22
+ - Kotlin
23
+
24
+ ## Supported Spec Formats
25
+
26
+ You can import specifications in many formats:
27
+
28
+ ### Documents
29
+ - PDF (.pdf)
30
+ - Markdown (.md)
31
+ - Plain text (.txt)
32
+ - ReStructuredText (.rst)
33
+ - AsciiDoc (.adoc)
34
+
35
+ ### Data Formats
36
+ - JSON (.json)
37
+ - YAML (.yaml, .yml)
38
+ - TOML (.toml)
39
+ - XML (.xml)
40
+ - CSV (.csv)
41
+
42
+ ### Images
43
+ - PNG (.png)
44
+ - JPG / JPEG (.jpg, .jpeg)
45
+ - GIF (.gif)
46
+ - SVG (.svg)
47
+ - WebP (.webp)
48
+
49
+ ### Code Files
50
+ Any of the supported language file types listed above can also be imported as specs — useful for API contracts, interface definitions, or reference implementations.
51
+
52
+ ## Project Structure
53
+
54
+ Alucify works with any project structure. It scans your workspace root and analyzes all source files it finds. There's no required directory layout or configuration file needed to get started.
55
+
56
+ ## Frameworks
57
+
58
+ Alucify recognizes and works well with popular frameworks including (but not limited to):
59
+
60
+ - **Frontend** — React, Next.js, Vue, Angular, Svelte
61
+ - **Backend** — Express, Django, Rails, Spring Boot, FastAPI
62
+ - **Mobile** — React Native, Swift/SwiftUI, Kotlin/Jetpack Compose
63
+ - **Full Stack** — Next.js, Remix, Nuxt
64
+
65
+ The analysis automatically detects your tech stack and displays it in the Code Analysis tab.
@@ -0,0 +1,61 @@
1
+ ---
2
+ order: 3
3
+ title: "System Requirements & Prerequisites"
4
+ description: "What you need to run Alucify: VS Code version, Claude access, and supported platforms."
5
+ ---
6
+
7
+ # System Requirements & Prerequisites
8
+
9
+ ## VS Code Extension
10
+
11
+ - **VS Code** version 1.85.0 or later
12
+ - **Operating System** — macOS, Windows, or Linux (any platform VS Code supports)
13
+ - **Claude Access** — One of:
14
+ - An Anthropic API key (pay-per-use), or
15
+ - A Claude Code / Claude Max subscription
16
+
17
+ ## CLI
18
+
19
+ - **Node.js** version 18 or later
20
+ - **npm** (comes with Node.js)
21
+ - **Claude Access** — Same options as above (API key or Claude Code subscription)
22
+
23
+ ## MCP Server
24
+
25
+ - **Claude Code** installed and configured
26
+ - An existing Alucify analysis (run `analyze-code` first)
27
+
28
+ ## Desktop App
29
+
30
+ - **macOS** with **Apple Silicon** (M1 or later). Intel Macs are not currently supported.
31
+ - **Claude Access** — Same options as the Extension/CLI (API key or Claude Code subscription)
32
+
33
+ ## Claude Access Options
34
+
35
+ Alucify uses Claude to power its AI analysis. You have two options:
36
+
37
+ ### Anthropic API Key
38
+
39
+ Pay per token using your own API key. You'll need to:
40
+
41
+ 1. Create an account at [console.anthropic.com](https://console.anthropic.com)
42
+ 2. Generate an API key
43
+ 3. Enter the key in Alucify's welcome screen or via the CLI
44
+
45
+ Cost varies by analysis mode and project size. Speed mode (catalog) is free — it uses mechanical analysis with no AI calls.
46
+
47
+ ### Claude Code / Claude Max Subscription
48
+
49
+ Use your existing Claude Code or Claude Max subscription. This requires:
50
+
51
+ 1. Claude Code CLI installed on your machine
52
+ 2. An active Claude Code or Claude Max subscription
53
+ 3. The CLI authenticated and ready to use
54
+
55
+ This option uses your subscription's included usage rather than per-token billing.
56
+
57
+ ## Network Requirements
58
+
59
+ - Internet connection required for AI-powered analysis (Balanced and Quality modes)
60
+ - Speed mode works offline (mechanical analysis only)
61
+ - Outdated package detection requires internet access
@@ -0,0 +1 @@
1
+ { "title": "Integrations", "order": 7 }
@@ -0,0 +1,95 @@
1
+ ---
2
+ order: 4
3
+ title: "CI/CD Integration"
4
+ description: "Running Alucify in continuous integration."
5
+ ---
6
+
7
+ # CI/CD Integration
8
+
9
+ Alucify can run in CI to enforce quality gates, produce analysis artifacts, or keep a centralized AppGraph up to date. All commands support `--json` output for parsing in scripts.
10
+
11
+ ## Prerequisites
12
+
13
+ - An API key (`alucify --auth apiKey --api-key $ANTHROPIC_API_KEY`) or the Claude Code CLI installed in the CI image
14
+ - Node.js 18+ (or whatever the current Alucify runtime requires — check [System Requirements](../getting-started/system-requirements.md))
15
+ - Git history available (run `actions/checkout@v4` with `fetch-depth: 0` on GitHub Actions)
16
+
17
+ ## Common Patterns
18
+
19
+ ### Gate PRs on Congruency Drop
20
+
21
+ ```yaml
22
+ - name: Analyze code
23
+ run: alucify analyze-code --mode catalog
24
+ - name: Analyze specs
25
+ run: alucify analyze-specs --mode catalog
26
+ - name: Check scores
27
+ run: |
28
+ score=$(alucify status --json | jq '.congruency')
29
+ if [ "$score" -lt 70 ]; then
30
+ echo "Congruency dropped below 70"
31
+ exit 1
32
+ fi
33
+ ```
34
+
35
+ ### Post Risk Summary to PR
36
+
37
+ ```yaml
38
+ - name: Analyze
39
+ run: alucify analyze-specs --mode catalog
40
+ - name: Summary
41
+ run: alucify status --json > status.json
42
+ - name: Post PR comment
43
+ uses: actions/github-script@v7
44
+ with:
45
+ script: |
46
+ const data = require('./status.json');
47
+ const body = `## Alucify\n- Congruency: ${data.congruency}%\n- Risks: ${data.risks.total}`;
48
+ github.rest.issues.createComment({
49
+ issue_number: context.issue.number,
50
+ owner: context.repo.owner,
51
+ repo: context.repo.repo,
52
+ body,
53
+ });
54
+ ```
55
+
56
+ ### Track Token Spend per Build
57
+
58
+ ```yaml
59
+ - run: alucify analyze-code --mode catalog
60
+ - run: alucify usage --json >> /tmp/usage.jsonl
61
+ - uses: actions/upload-artifact@v4
62
+ with:
63
+ name: alucify-usage
64
+ path: /tmp/usage.jsonl
65
+ ```
66
+
67
+ ## Auth in CI
68
+
69
+ Prefer API key mode in CI. It doesn't require the Claude Code CLI or an interactive session.
70
+
71
+ ```bash
72
+ alucify --auth apiKey --api-key "$ANTHROPIC_API_KEY" analyze-code --mode catalog
73
+ ```
74
+
75
+ Store the API key as a CI secret (`ANTHROPIC_API_KEY`), never commit it.
76
+
77
+ ## Cost Control
78
+
79
+ - **Use catalog mode in CI** — free, fast, deterministic. Heavier modes (Fast, Full) are better run locally or scheduled.
80
+ - **Cache `.alucify/`** between CI runs — preserves version history and enables incremental analysis.
81
+ - **Scheduled deep analyses** — run Full mode nightly rather than per-PR; use CI for quick gates only.
82
+
83
+ ## Exit Codes
84
+
85
+ - `0` — success
86
+ - `1` — runtime error (bad args, missing deps)
87
+
88
+ Quality gates (congruency below X, coverage below Y) aren't exit-code-driven — read them out of `alucify status --json` and fail your CI step yourself, as in the gate example above.
89
+
90
+ ## See Also
91
+
92
+ - [CLI Automation](../cli/automation.md)
93
+ - [`alucify analyze-code`](../cli/commands/analyze-code.md)
94
+ - [`alucify analyze-specs`](../cli/commands/analyze-specs.md)
95
+ - [`alucify status`](../cli/commands/status.md)
@@ -0,0 +1,54 @@
1
+ ---
2
+ order: 3
3
+ title: "Claude Code Session Hooks"
4
+ description: "The Claude Code hooks Alucify uses for context injection and intent capture."
5
+ ---
6
+
7
+ # Claude Code Session Hooks
8
+
9
+ Separate from git hooks (which fire on commits), Alucify also installs hooks into your Claude Code configuration. These fire at session boundaries and key events inside Claude Code.
10
+
11
+ ## What Gets Installed
12
+
13
+ When you run [`alucify enable`](../cli/commands/enable-disable.md), entries are added to `.claude/settings.json` in your project:
14
+
15
+ - **SessionStart** — inject AppGraph context when a new Claude Code session opens
16
+ - **UserPromptSubmit** — enrich certain prompts with relevant AppGraph excerpts
17
+ - **SubagentStart** — share context with spawned subagents
18
+ - **SessionEnd** — stage session transcripts for [intent capture](../concepts/intent-capture.md)
19
+
20
+ All hooks are marker-scoped and idempotent — safe to add to an existing `.claude/settings.json`.
21
+
22
+ ## What Each Hook Does
23
+
24
+ ### SessionStart
25
+ Runs a one-shot command that emits an AppGraph summary into Claude's context. Output includes node counts, current scores, and open high-severity risks. Total payload is typically ~500 tokens.
26
+
27
+ ### UserPromptSubmit
28
+ For certain prompts (those that appear to be planning or implementation-related), runs a pre-filter that fetches relevant AppGraph excerpts and prepends them to the prompt. Keeps Claude grounded without bloating every message.
29
+
30
+ ### SubagentStart
31
+ When Claude Code spawns a subagent for a multi-step task, the subagent inherits the AppGraph context from its parent. This hook ensures the subagent starts with the same grounding.
32
+
33
+ ### SessionEnd
34
+ Stages the session transcript in a pending state. A background polling process reads staged sessions and runs intent capture against them. See [Intent Capture](../concepts/intent-capture.md).
35
+
36
+ ## Turning Off Individual Hooks
37
+
38
+ Edit `.claude/settings.json` and comment out or remove specific hook entries. You can keep some (e.g., SessionStart for context injection) while disabling others (e.g., SessionEnd for intent capture).
39
+
40
+ ## Lightweight Alternative
41
+
42
+ If you only want the MCP tools without session hooks, use [`alucify mcp-install`](../cli/commands/mcp-install.md) instead of `enable`. That skips all Claude Code hooks.
43
+
44
+ ## Debugging
45
+
46
+ If hooks don't appear to be firing, check:
47
+ - `.claude/settings.json` contains the Alucify hook entries (look for `alucify:` markers)
48
+ - Claude Code version supports the hook mechanism (requires recent CLI version)
49
+ - Run `alucify enable` again to repair any missing entries (safe and idempotent)
50
+
51
+ ## See Also
52
+
53
+ - [Claude Code Integration](claude-code.md) — the full integration picture
54
+ - [Intent Capture](../concepts/intent-capture.md) — what SessionEnd feeds
@@ -0,0 +1,123 @@
1
+ ---
2
+ order: 1
3
+ title: "Claude Code Integration"
4
+ description: "What Alucify installs into your Claude Code environment, how the pieces fit together, and what each one does."
5
+ ---
6
+
7
+ # Claude Code Integration
8
+
9
+ When you run `alucify enable` (or toggle the integration in VS Code), Alucify installs four components that give Claude Code structured awareness of your project. Each serves a distinct purpose — together they form a feedback loop that helps Claude plan with real architecture context, implement against actual requirements, and track progress automatically.
10
+
11
+ ## What Gets Installed
12
+
13
+ | Component | File | Purpose |
14
+ |-----------|------|---------|
15
+ | CLAUDE.md instructions | `CLAUDE.md` | Teaches Claude what the appgraph is and when to use it |
16
+ | Hooks | `.claude/settings.json` | Injects context at key moments (planning, task creation, subagent start) |
17
+ | MCP server | `.mcp.json` | Gives Claude tools to query your project's architecture on demand |
18
+ | Git hooks | `.git/hooks/pre-commit` + `post-commit` | Analyzes commits against the appgraph for progress tracking |
19
+
20
+ All installations are marker-based and idempotent — running `enable` multiple times is safe, and `disable` cleanly removes everything while preserving your analysis data.
21
+
22
+ ## CLAUDE.md Instructions
23
+
24
+ **What it is:** A small section (~200 tokens) added to your project's `CLAUDE.md` file, delimited by `<!-- alucify:appgraph:start -->` / `<!-- alucify:appgraph:end -->` markers.
25
+
26
+ **What it does:** Teaches Claude the mental model of your project's appgraph — the node type system (requirements, interfaces, schemas, logic, validations), how they connect via edges, and rules for when to query the architecture. For example: "Before planning features, call `query_context()` to find existing components" and "Call `trace_dependencies()` before cross-cutting changes to check blast radius."
27
+
28
+ **Why it matters:** Without these instructions, Claude has MCP tools available but doesn't know *when* to use them. The instructions bridge that gap — they're always loaded, never go stale (they contain rules, not data), and work regardless of how large your project is.
29
+
30
+ ## Hooks
31
+
32
+ **What they are:** Entries in `.claude/settings.json` that run automatically when Claude Code reaches specific moments in its workflow.
33
+
34
+ **What they do:** Each hook injects a small, targeted piece of context:
35
+
36
+ | Hook | When it fires | What it injects |
37
+ |------|---------------|-----------------|
38
+ | **EnterPlanMode** | When Claude enters formal planning | Unimplemented requirements with validation status, plus a step-by-step exploration workflow |
39
+ | **ExitPlanMode** | When Claude finishes a plan, before presenting it | Validation warnings — missing dependencies, uncovered acceptance criteria, nodes referenced but not addressed |
40
+ | **TodoWrite** | When Claude creates or updates tasks | Per-task context — related appgraph nodes, blast radius, acceptance criteria from validation nodes |
41
+
42
+ **Why they matter:** Hooks deliver the right context at the right time without dumping your entire architecture into every conversation. The planning hooks ensure Claude's plans account for real dependencies and requirements. Task hooks give each implementation step the specific context it needs.
43
+
44
+ **Note:** Not every Claude Code interaction uses all hooks. For simple tasks like bug fixes, only CLAUDE.md rules are active — Claude won't enter plan mode for a one-line fix, and that's the right behavior. The planning and task hooks activate naturally when Claude tackles more complex work.
45
+
46
+ ## MCP Server
47
+
48
+ **What it is:** A lightweight server that starts as a subprocess when Claude Code connects. It reads your `.alucify/` analysis data and exposes it through tools and resources.
49
+
50
+ **What it does:** Gives Claude on-demand access to your project's architecture:
51
+
52
+ | Tool | What it answers |
53
+ |------|-----------------|
54
+ | `query_context` | "What screens exist?" "Find anything related to auth" "What's still planned?" |
55
+ | `get_context` | Full detail on a specific node — UI structure, data model, state machines, connected nodes |
56
+ | `trace_dependencies` | "If I change this file, what else is affected?" — blast radius analysis |
57
+ | `get_remaining_work` | Unimplemented requirements, untested validations, orphaned nodes |
58
+ | `get_implementation_tasks` | Per-requirement task list with gap notes and untested validations — used by `/alucify-plan` |
59
+ | `link_context` | Link a node to its implementation file so progress tracking can find it |
60
+ | `verify_plan` | Mechanically validate a plan's appgraph references before presenting it |
61
+ | `find_similar_context` | "Is there already a concept called X?" — terminology grounding for artifact drafting |
62
+ | `diff_context` | What changed between two analysis versions |
63
+ | `get_analysis` | Congruency, coverage, or quality report summaries |
64
+
65
+ **Why it matters:** The MCP server is the primary data source — it's where the actual architecture knowledge lives. The CLAUDE.md instructions teach Claude *when* to query, the hooks *nudge* Claude with summaries, but the MCP tools *provide the data*. This keeps the design scale-independent: a 50-node project and a 5,000-node project work identically because Claude queries what it needs rather than receiving everything upfront.
66
+
67
+ All tools are read-only except `link_context`, which updates a node's file reference for progress tracking.
68
+
69
+ ## Git Hooks (Pre-Commit + Post-Commit)
70
+
71
+ **What they are:** Two hooks in `.git/hooks/` that work together to analyze every commit.
72
+
73
+ **How they work:**
74
+
75
+ 1. **Pre-commit hook** (synchronous, ≤15s timeout): Runs `alucify analyze-progress --pre-commit` to classify staged files against the appgraph using a single LLM call. On success, the analysis output (updated appgraph, version snapshot) is staged into the same commit — so everything lands in a single atomic commit with zero leftover files.
76
+
77
+ 2. **Post-commit hook** (async fallback): Only runs if the pre-commit analysis timed out or failed. In that case, it runs the full async analysis in the background, and the results are auto-staged into the *next* commit by the pre-commit hook.
78
+
79
+ **Why they matter:** This closes the loop. The other three components help Claude *plan and write* code with architecture awareness. The git hooks track *what was actually built*, so you can see progress against your requirements without manual bookkeeping — and without requiring a second commit.
80
+
81
+ ## How They Work Together
82
+
83
+ Here's the flow across a typical development session:
84
+
85
+ ```
86
+ Session starts
87
+ └─ CLAUDE.md loaded → Claude knows the node types and when to query
88
+
89
+ You ask Claude to plan a feature
90
+ └─ EnterPlanMode hook → "Here's what's unfinished: nr00045 (0/3 tested)..."
91
+ └─ Claude calls MCP tools → query_context, get_context, trace_dependencies
92
+ └─ ExitPlanMode hook → "⚠ ProjectDetail also depends on this schema"
93
+ └─ Claude presents plan with node IDs and dependency warnings
94
+
95
+ You approve, Claude implements
96
+ └─ TodoWrite hook → per-task blast radius + acceptance criteria
97
+ └─ Claude calls link_context → links nodes to implementation files
98
+ └─ Claude edits files
99
+
100
+ You commit
101
+ └─ Git hook captures changed files
102
+ └─ analyze-progress matches commits to nodes → statuses update
103
+ ```
104
+
105
+ For simpler tasks (bug fixes, refactors), Claude skips the planning hooks entirely and works with just the baseline — CLAUDE.md rules and MCP tools available if needed.
106
+
107
+ ## `enable` vs `mcp-install`
108
+
109
+ If you don't need the full integration — for example, you're consuming an appgraph a teammate built and just want Claude to be able to query it — you can install only the MCP server:
110
+
111
+ ```bash
112
+ alucify mcp-install --with-rules
113
+ ```
114
+
115
+ This gives you the MCP server and CLAUDE.md instructions but skips hooks and commit tracking. See [MCP Server Setup](../mcp-server/setup.md) for details.
116
+
117
+ | | `enable` | `mcp-install --with-rules` |
118
+ |---|---|---|
119
+ | MCP server (query tools) | Yes | Yes |
120
+ | CLAUDE.md instructions | Yes | Yes |
121
+ | Hooks (session, planning, tasks) | Yes | No |
122
+ | Git hook (commit tracking) | Yes | No |
123
+ | Best for | Running analysis + developing | Consuming a teammate's analysis |
@@ -0,0 +1,64 @@
1
+ ---
2
+ order: 2
3
+ title: "Git Hooks"
4
+ description: "The pre-commit and post-commit hooks Alucify installs for automatic progress tracking."
5
+ ---
6
+
7
+ # Git Hooks
8
+
9
+ `alucify enable` installs two git hooks that keep your AppGraph's progress tracking in sync with your commits — automatically.
10
+
11
+ ## Pre-Commit Hook
12
+
13
+ **File:** `.git/hooks/pre-commit`
14
+ **Runs:** `alucify analyze-progress --pre-commit` with a ≤15s timeout
15
+
16
+ **What it does:**
17
+ - Classifies staged files synchronously against the AppGraph
18
+ - On success, writes an analysis + version snapshot to `.alucify/` and stages it alongside your commit
19
+ - On timeout or failure, writes nothing — the post-commit hook handles it async instead
20
+
21
+ **It never blocks your commit.** The hook always exits 0 regardless of analysis outcome, so a slow or broken analysis can't stop you from committing. Quality signals (new risks, coverage drops) are informational, surfaced in the UI — not blocking at the git layer.
22
+
23
+ ## Post-Commit Hook
24
+
25
+ **File:** `.git/hooks/post-commit`
26
+ **Runs:** `alucify analyze-progress --commit HEAD` in the background
27
+
28
+ **What it does:**
29
+ - Reads the just-landed commit
30
+ - Updates AppGraph node statuses (planned → in_progress → implemented)
31
+ - Writes gap notes for nodes that are partially implemented
32
+ - Appends to the commit log in `.alucify/progress/`
33
+
34
+ **It runs async.** Your commit completes immediately; the analysis runs in the background and notifies when done (if OS notifications are on).
35
+
36
+ ## What's Analyzed
37
+
38
+ Both hooks only look at files in the AppGraph scope:
39
+ - Source files (based on detected languages)
40
+ - Spec files (if staged at the same time)
41
+
42
+ Files outside the scope (CI configs, asset binaries, docs) are skipped.
43
+
44
+ ## Token Cost
45
+
46
+ Both hooks consume tokens when they invoke LLM-backed classification. Actual cost scales with commit size and which analysis mode your project uses. See [Token Usage](../concepts/token-usage.md) for tracking your spend.
47
+
48
+ ## Skipping Hooks
49
+
50
+ If you need to commit without running the hooks:
51
+
52
+ ```bash
53
+ git commit --no-verify -m "..."
54
+ ```
55
+
56
+ This skips both pre-commit and post-commit. Use sparingly — it bypasses all your project's other hooks too.
57
+
58
+ ## Uninstalling
59
+
60
+ Run `alucify disable` to cleanly remove both hooks. The hook files are marker-scoped, so uninstalling preserves any custom hook code you've added alongside Alucify's.
61
+
62
+ ## Conflict with Existing Hooks
63
+
64
+ If you already have custom pre-commit or post-commit hooks, Alucify prepends its logic with a marker block. Your existing hook content is preserved. See [Claude Code Integration](claude-code.md) for the full marker scheme.
@@ -0,0 +1 @@
1
+ { "title": "MCP Server", "order": 6 }
@@ -0,0 +1,59 @@
1
+ ---
2
+ order: 1
3
+ title: "MCP Server Quick Start"
4
+ description: "Get the Alucify MCP server running with Claude Code in under 5 minutes."
5
+ ---
6
+
7
+ # MCP Server Quick Start
8
+
9
+ The Alucify MCP server gives Claude Code direct access to your project analysis, so it can make informed decisions about architecture, impact, and requirements while coding.
10
+
11
+ ## 1. Analyze Your Project First
12
+
13
+ You need analysis results before the MCP server has anything to serve:
14
+
15
+ ```bash
16
+ alucify analyze-code
17
+ ```
18
+
19
+ Optionally add and analyze specs:
20
+
21
+ ```bash
22
+ alucify add-spec requirements.pdf
23
+ alucify analyze-specs
24
+ ```
25
+
26
+ ## 2. Enable the Integration
27
+
28
+ The easiest way to set up the MCP server:
29
+
30
+ ```bash
31
+ alucify enable
32
+ ```
33
+
34
+ This registers the MCP server in your `.mcp.json` file and installs Claude Code hooks.
35
+
36
+ ## 3. Use Claude Code
37
+
38
+ Start a Claude Code session in your project. Claude Code now has access to tools that query your project analysis:
39
+
40
+ - **Search** your project for components by type, name, or status
41
+ - **Get details** on any specific component
42
+ - **Check impact** before committing changes
43
+ - **Find gaps** in requirement coverage
44
+ - **Compare versions** to see how the project evolved
45
+
46
+ ## Example Interaction
47
+
48
+ In a Claude Code session, you might ask:
49
+
50
+ > "What screens exist in this project?"
51
+ > "What's the blast radius if I modify src/models/user.ts?"
52
+ > "What requirements haven't been implemented yet?"
53
+
54
+ Claude Code will automatically use the MCP tools to answer using your project analysis.
55
+
56
+ ## What's Next?
57
+
58
+ - [Setting Up the MCP Server](setup.md) — Alternative setup options
59
+ - [MCP Tools Reference](tools/query.md) — All tools explained
@@ -0,0 +1 @@
1
+ { "title": "Resources", "order": 4 }