@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,46 @@
1
+ ---
2
+ order: 9
3
+ title: "Resetting Your Analysis"
4
+ description: "How to reset your analysis data and start fresh, including what gets archived."
5
+ ---
6
+
7
+ # Resetting Your Analysis
8
+
9
+ If you need to start fresh, you can reset all analysis data. This archives your existing data and returns Alucify to its initial state.
10
+
11
+ ## How to Reset
12
+
13
+ 1. Open the Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`)
14
+ 2. Search for **Alucify: Reset Analysis**
15
+ 3. Confirm the reset when prompted
16
+
17
+ You'll see a warning: "Reset all analysis? This will archive your current baseline, spec analysis, progress tracking, and all version history. Your data will be preserved in .alucify/archived/ if you need to recover it."
18
+
19
+ Click **Reset Analysis** to proceed, or cancel to keep your data.
20
+
21
+ ## What Gets Archived
22
+
23
+ All of your analysis data is moved to `.alucify/archived/[timestamp]/`, including:
24
+
25
+ - Code analysis baseline
26
+ - Spec analysis results
27
+ - Version history
28
+ - Progress tracking data
29
+ - Imported artifacts
30
+
31
+ ## What Happens After Reset
32
+
33
+ - All panels refresh to show their empty state
34
+ - The Code Analysis tab shows the **Analyze Code** button again
35
+ - The Specifications panel is empty
36
+ - You'll see a confirmation: "Analysis reset. All previous data archived to .alucify/archived/."
37
+
38
+ ## Recovering Archived Data
39
+
40
+ Your archived data is preserved in `.alucify/archived/` with a timestamp. While there's no built-in restore feature, the files are standard JSON and can be manually copied back if needed.
41
+
42
+ ## When to Reset
43
+
44
+ - You've significantly restructured your project and want a clean baseline
45
+ - You want to re-analyze with different settings from scratch
46
+ - You're switching the project that a workspace is used for
@@ -0,0 +1 @@
1
+ { "title": "Settings", "order": 8 }
@@ -0,0 +1,53 @@
1
+ ---
2
+ order: 4
3
+ title: "Advanced Mode"
4
+ description: "Unlocking hidden advanced commands and panels."
5
+ ---
6
+
7
+ # Advanced Mode
8
+
9
+ Advanced Mode reveals commands and panels that aren't shown by default. These are typically for debugging, advanced workflows, or features still being refined.
10
+
11
+ ## Turning It On
12
+
13
+ 1. Open VS Code Settings (`Cmd+,` / `Ctrl+,`)
14
+ 2. Search for `alucify.advanced`
15
+ 3. Check the box
16
+
17
+ Or edit `settings.json`:
18
+ ```json
19
+ {
20
+ "alucify.advanced": true
21
+ }
22
+ ```
23
+
24
+ Changes take effect immediately — no reload needed.
25
+
26
+ ## What Becomes Available
27
+
28
+ Once enabled, the **Advanced** section appears in the Alucify Activity Bar view. It contains:
29
+
30
+ - [Compare Versions](../versions/comparing-versions.md)
31
+ - [Switch Version](../versions/switching-versions.md)
32
+ - [Delete Version](../versions/deleting-versions.md)
33
+ - [Reset Progress](../dev-progress/progress-panel-actions.md#reset-progress)
34
+ - [Reset Analysis](../resetting-analysis.md)
35
+ - [Reset Extension](../advanced/reset-extension.md)
36
+ - Congruency / Coverage / Impact / Findings analyses (see [Advanced](../advanced/congruency-analysis.md))
37
+
38
+ Additional command palette entries also appear (with **Alucify (Advanced):** prefix).
39
+
40
+ ## Why It's Gated
41
+
42
+ Advanced features are either:
43
+ - **Destructive** (reset commands) — should require intent to discover
44
+ - **Low-usage** (separate per-dimension analyses) — would clutter the default UI
45
+ - **In development** — we want feedback from power users before promoting them
46
+
47
+ ## Turning It Off
48
+
49
+ Uncheck the setting. Hidden items disappear on next palette open or view refresh. Data produced while Advanced Mode was on is not affected.
50
+
51
+ ## Developer Mode (Separate)
52
+
53
+ Advanced Mode is different from [Developer Mode](../advanced/developer-mode.md), which enables internal diagnostics used when debugging the extension itself.
@@ -0,0 +1,66 @@
1
+ ---
2
+ order: 1
3
+ title: "All Settings"
4
+ description: "Comprehensive reference for every Alucify extension setting."
5
+ ---
6
+
7
+ # All Settings
8
+
9
+ All settings are accessible via VS Code Settings (`Cmd+,` / `Ctrl+,`) by searching for `alucify`.
10
+
11
+ ## Authentication
12
+
13
+ | Setting | Default | Description |
14
+ |---|---|---|
15
+ | `alucify.authMode` | `claudeCode` | `"claudeCode"` or `"apiKey"`. See [Authentication Modes](../../concepts/authentication-modes.md). |
16
+
17
+ The API key itself is stored in VS Code's secret storage (OS keychain), not in `settings.json`.
18
+
19
+ ## Notifications
20
+
21
+ | Setting | Default | Description |
22
+ |---|---|---|
23
+ | `alucify.notifications.os` | `true` | Show OS-native notifications when workflows finish. See [Notification Preferences](notification-preferences.md). |
24
+
25
+ ## Analysis
26
+
27
+ | Setting | Default | Description |
28
+ |---|---|---|
29
+ | `alucify.autoAnalyzeSpecs` | `false` | Automatically run spec analysis when a new artifact is added. See [Auto-Analyze Specs](auto-analyze-specs.md). |
30
+ | `alucify.refineSpecs.mode` | `fast` | Analysis mode used during Refine Specs chat (speed/fast/full). |
31
+
32
+ ## Intent Capture
33
+
34
+ | Setting | Default | Description |
35
+ |---|---|---|
36
+ | `alucify.intentCapture.enabled` | `false` | Poll Claude Code sessions and capture intent automatically. See [Enabling Intent Capture](../intent-capture/enabling-intent-capture.md). |
37
+ | `alucify.intentCapture.pollIntervalSeconds` | `300` | How often to check for new sessions (seconds). |
38
+
39
+ ## Developer & Advanced
40
+
41
+ | Setting | Default | Description |
42
+ |---|---|---|
43
+ | `alucify.advanced` | `false` | Reveal hidden advanced commands and panels. See [Advanced Mode](advanced-mode.md). |
44
+ | `alucify.agentsInternalPath` | `""` | Override bundled agents location (developer-only; leave empty unless you're developing Alucify itself). |
45
+
46
+ ## Privacy
47
+
48
+ | Setting | Default | Description |
49
+ |---|---|---|
50
+ | `alucify.telemetry` | `true` | Send anonymous usage telemetry. See [Telemetry](telemetry.md). |
51
+
52
+ ## Where Settings Live
53
+
54
+ - **User settings** — apply to all VS Code workspaces for your user
55
+ - **Workspace settings** — apply only to the current workspace (stored in `.vscode/settings.json`)
56
+ - **Secrets** (API key, Auth0 tokens) — always in OS keychain, never in JSON
57
+
58
+ ## Global State (Not User-Editable)
59
+
60
+ Some state is managed internally and not exposed as settings:
61
+ - `welcomeDismissed` — whether you've dismissed the Welcome view
62
+ - `authModeChosen` — whether you've picked an auth mode during onboarding
63
+ - `mitigatedRisks` — which risks you've marked as resolved or ignored
64
+ - `openPanels` — which detail panels are expanded in the current view
65
+
66
+ You can reset these via [Reset Extension](../advanced/reset-extension.md).
@@ -0,0 +1,43 @@
1
+ ---
2
+ order: 5
3
+ title: "Auto-Analyze Specs"
4
+ description: "Automatically running spec analysis when you add a new artifact."
5
+ ---
6
+
7
+ # Auto-Analyze Specs
8
+
9
+ When enabled, adding a new spec artifact triggers spec analysis immediately — no manual click required.
10
+
11
+ ## Turning It On
12
+
13
+ 1. Open VS Code Settings (`Cmd+,` / `Ctrl+,`)
14
+ 2. Search for `alucify.autoAnalyzeSpecs`
15
+ 3. Check the box
16
+
17
+ ## What Triggers an Auto-Analysis
18
+
19
+ - Adding one or more files via **Add Spec** in the Specs sidebar
20
+ - Dragging files into the sidebar
21
+ - Running `alucify add-spec` from the CLI while VS Code is open on the same workspace
22
+
23
+ Not triggered by:
24
+ - Files placed directly in `.alucify/artifacts/` without using the Add flow (considered manual; won't auto-process)
25
+ - Changes to existing artifacts (edits run via the regular re-analysis flow)
26
+
27
+ ## Mode Used
28
+
29
+ Auto-analyses run in the same mode as your last manual spec analysis. If you've never run spec analysis before, the default is **Fast (Balanced)**.
30
+
31
+ ## When Not to Use It
32
+
33
+ - **On PDFs you haven't reviewed yet** — you may want to audit the spec first (see [Auditing Specs](../spec-analysis/auditing-specs.md)) before committing token spend to analysis
34
+ - **When adding many files in a batch** — auto-analyzing each one separately is less efficient than batching; disable this, add all files, then manually click Analyze Specs
35
+
36
+ ## Token Cost
37
+
38
+ Each auto-analysis consumes tokens. If you add many artifacts in succession, token usage adds up quickly. Check the [Token Usage Panel](../token-usage/viewing-token-usage.md) to monitor spend.
39
+
40
+ ## See Also
41
+
42
+ - [Adding Specs](../spec-analysis/adding-specs.md)
43
+ - [Analyzing Specs](../spec-analysis/analyzing-specs.md)
@@ -0,0 +1,38 @@
1
+ ---
2
+ order: 2
3
+ title: "Notification Preferences"
4
+ description: "How to configure OS notifications for completed workflows."
5
+ ---
6
+
7
+ # Notification Preferences
8
+
9
+ Alucify can send native OS notifications when a workflow completes and VS Code is not in focus. This is useful when running long analyses in the background.
10
+
11
+ ## Configuring Notifications
12
+
13
+ To enable or disable OS notifications:
14
+
15
+ 1. Open VS Code Settings (`Ctrl+,` / `Cmd+,`)
16
+ 2. Search for `alucify.notifications.os`
17
+ 3. Check or uncheck **Alucify: Notifications > OS**
18
+
19
+ Or add this to your `settings.json`:
20
+
21
+ ```json
22
+ {
23
+ "alucify.notifications.os": true
24
+ }
25
+ ```
26
+
27
+ ## When Notifications Are Sent
28
+
29
+ OS notifications are sent when:
30
+
31
+ - A workflow (code analysis, spec analysis, or progress analysis) completes
32
+ - VS Code is not the focused window
33
+
34
+ If VS Code is in focus, you'll see the results directly in the sidebar without a separate notification.
35
+
36
+ ## Default Setting
37
+
38
+ OS notifications are **enabled** by default.
@@ -0,0 +1,45 @@
1
+ ---
2
+ order: 1
3
+ title: "Telemetry & Privacy"
4
+ description: "What anonymous usage data Alucify collects and how to opt out."
5
+ ---
6
+
7
+ # Telemetry & Privacy
8
+
9
+ Alucify collects anonymous usage telemetry to help improve the product. You can opt out at any time.
10
+
11
+ ## What's Collected
12
+
13
+ Alucify tracks anonymous usage events such as:
14
+
15
+ - Which commands are used (e.g., "Analyze Code was run")
16
+ - Workflow state changes (e.g., "analysis started", "analysis completed")
17
+ - General usage metrics
18
+
19
+ Telemetry does **not** include:
20
+
21
+ - Your source code
22
+ - Your specification documents
23
+ - File names or paths
24
+ - API keys or credentials
25
+ - Any personally identifiable information beyond your account ID
26
+
27
+ ## Opting Out
28
+
29
+ To disable telemetry:
30
+
31
+ 1. Open VS Code Settings (`Ctrl+,` / `Cmd+,`)
32
+ 2. Search for `alucify.telemetry`
33
+ 3. Uncheck **Alucify: Telemetry**
34
+
35
+ Or add this to your `settings.json`:
36
+
37
+ ```json
38
+ {
39
+ "alucify.telemetry": false
40
+ }
41
+ ```
42
+
43
+ ## Data Storage
44
+
45
+ All analysis data (your project model, spec analysis, versions) is stored locally in the `.alucify/` directory within your project. This data is never sent to Alucify's servers — it stays on your machine and in your repository.
@@ -0,0 +1 @@
1
+ { "title": "Spec Analysis", "order": 5 }
@@ -0,0 +1,40 @@
1
+ ---
2
+ order: 1
3
+ title: "Adding Specification Documents"
4
+ description: "How to import PRDs, requirements docs, design files, and other specs into Alucify."
5
+ ---
6
+
7
+ # Adding Specification Documents
8
+
9
+ Specs are the documents that describe what your project should do — PRDs, requirements documents, design files, API specifications, and any other project documentation.
10
+
11
+ ## How to Add Specs
12
+
13
+ 1. In the Alucify sidebar, find the **Specifications** panel
14
+ 2. Click the **Add Spec** button (plus icon)
15
+ 3. A file picker opens — select one or more files
16
+ 4. The files are imported into your project's `.alucify/artifacts/` directory
17
+
18
+ You can select multiple files at once to import them in batch.
19
+
20
+ ## Supported File Types
21
+
22
+ Alucify supports a wide range of file formats:
23
+
24
+ - **Documents:** PDF, Markdown (.md), plain text (.txt), ReStructuredText (.rst), AsciiDoc (.adoc)
25
+ - **Data formats:** JSON, YAML, TOML, XML, CSV
26
+ - **Images:** PNG, JPG, GIF, SVG, WebP
27
+ - **Code files:** TypeScript, JavaScript, Python, Java, Go, Rust, Ruby, C/C++, C#, Swift, Kotlin
28
+
29
+ ## What Happens After Import
30
+
31
+ After importing, your specs appear in the Specifications panel with a **Pending** status. They need to be analyzed before Alucify can compare them against your codebase.
32
+
33
+ To analyze your specs, click **Analyze Specs** in the Project Analysis panel. See [Running Spec Analysis](analyzing-specs.md) for details.
34
+
35
+ ## Tips
36
+
37
+ - **Import everything relevant** — PRDs, design docs, API contracts, wireframes, data models. The more context Alucify has, the better its analysis.
38
+ - **Images work too** — Screenshots of wireframes and design mockups can be imported and analyzed.
39
+ - **Large files are handled automatically** — Alucify chunks large documents for efficient processing.
40
+ - **You can add more specs later** — Import additional specs at any time. When you run Analyze Specs again, Alucify will process only the new or changed files.
@@ -0,0 +1,60 @@
1
+ ---
2
+ order: 4
3
+ title: "Running Spec Analysis"
4
+ description: "How to run spec analysis to compare your specifications against your codebase."
5
+ ---
6
+
7
+ # Running Spec Analysis
8
+
9
+ Spec analysis compares your imported specifications against your codebase to find gaps, conflicts, and coverage issues.
10
+
11
+ ## Prerequisites
12
+
13
+ Before running spec analysis:
14
+
15
+ 1. You've [run code analysis](../code-analysis/running-code-analysis.md) at least once
16
+ 2. You've [added specs](adding-specs.md) to the Specifications panel
17
+
18
+ ## How to Run Spec Analysis
19
+
20
+ 1. In the **Project Analysis** panel, switch to the **Spec Analysis** tab
21
+ 2. Click the **Analyze Specs** button
22
+ 3. Select an analysis mode:
23
+ - **Speed** — Fast mechanical projection (5–10 minutes, no AI cost)
24
+ - **Balanced** — AI-powered analysis (15–60 minutes)
25
+ - **Quality** — Comprehensive analysis (45–90 minutes)
26
+ 4. Wait for the analysis to complete
27
+
28
+ A progress indicator shows the current phase.
29
+
30
+ ## What Happens During Analysis
31
+
32
+ Spec analysis:
33
+
34
+ 1. Extracts requirements, features, and acceptance criteria from your spec documents
35
+ 2. Maps spec items to existing components in your codebase
36
+ 3. Identifies coverage gaps — requirements with no matching code
37
+ 4. Detects conflicts — contradictions between specs and code
38
+ 5. Measures congruency — how well specs and code align
39
+ 6. Generates AI coding risks based on the findings
40
+ 7. Saves a versioned snapshot
41
+
42
+ ## Incremental Analysis
43
+
44
+ When you add new specs or update existing ones and re-run analysis:
45
+
46
+ - **Unchanged specs are reused** — Only new or modified specs are re-analyzed
47
+ - **You can choose to rebuild** — If you prefer a fresh analysis, you'll see the option to do a full rebuild
48
+
49
+ This saves time and cost when iterating on your specs.
50
+
51
+ ## After Analysis
52
+
53
+ Results appear in the [Specifications Panel](specifications-panel.md). You'll see congruency scores, coverage metrics, and any identified risks.
54
+
55
+ ## Using the Command Palette
56
+
57
+ You can also start spec analysis from the Command Palette:
58
+
59
+ 1. Press `Ctrl+Shift+P` / `Cmd+Shift+P`
60
+ 2. Search for **Alucify: Analyze Specs**
@@ -0,0 +1,30 @@
1
+ ---
2
+ order: 6
3
+ title: "Auditing Imported Specs"
4
+ description: "How to run an audit on your imported specifications to check for quality and completeness."
5
+ ---
6
+
7
+ # Auditing Imported Specs
8
+
9
+ The spec audit checks the quality of your imported specifications before or after a full analysis.
10
+
11
+ ## How to Audit Specs
12
+
13
+ 1. Open the Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`)
14
+ 2. Search for **Alucify: Audit Specs**
15
+ 3. The audit runs against all imported specifications
16
+
17
+ ## What the Audit Checks
18
+
19
+ The audit evaluates your specs for:
20
+
21
+ - **Completeness** — Are all necessary details present? Are there missing sections or undefined requirements?
22
+ - **Clarity** — Are requirements specific enough for an AI coding agent to implement?
23
+ - **Consistency** — Do specs use consistent terminology? Are there contradictions between documents?
24
+ - **Actionability** — Can each requirement be turned into a concrete implementation?
25
+
26
+ ## When to Audit
27
+
28
+ - **After importing new specs** — Check that your documents are suitable for analysis before running full spec analysis
29
+ - **After refining specs** — Verify that changes improved quality
30
+ - **When AI readiness scores are low** — An audit can help identify which specs need improvement
@@ -0,0 +1,43 @@
1
+ ---
2
+ order: 3
3
+ title: "Filtering & Browsing the Specs Panel"
4
+ description: "How to filter, browse, and manage your imported specifications."
5
+ ---
6
+
7
+ # Filtering & Browsing the Specs Panel
8
+
9
+ The **Specifications** panel in the Alucify sidebar shows all your imported spec documents and their analysis status.
10
+
11
+ ## Spec Lifecycle
12
+
13
+ Each spec goes through a lifecycle shown at the top of the panel:
14
+
15
+ 1. **Pending** — The spec has been imported but not yet analyzed
16
+ 2. **Analyzed** — The spec has been fully analyzed and integrated
17
+
18
+ Click on any status label to filter the list to specs in that state. The count next to each status shows how many specs are in that phase.
19
+
20
+ ## Filtering Specs
21
+
22
+ ### Using the Filter Button
23
+
24
+ 1. Click the **Filter** icon (funnel) in the Specifications panel header
25
+ 2. Choose a filter:
26
+ - **Show All** — Display all specs regardless of status
27
+ - **Pending** — Only show specs awaiting analysis
28
+ - **Analyzed** — Only show fully analyzed specs
29
+
30
+ ### Clearing Filters
31
+
32
+ When a filter is active, the filter icon changes to indicate filtering is on. Click **Clear Filter** (filled funnel icon) to remove the filter and show all specs.
33
+
34
+ ## Refreshing the List
35
+
36
+ Click the **Refresh** icon in the panel header to update the specs list. This is useful if you've added files to the `.alucify/artifacts/` directory outside of VS Code.
37
+
38
+ ## Spec Actions
39
+
40
+ From the panel, you can:
41
+
42
+ - **Add Spec** — Import new specification documents
43
+ - **Generate Spec** — Create specs using AI (requires Claude Code CLI)
@@ -0,0 +1,47 @@
1
+ ---
2
+ order: 2
3
+ title: "Generating Specs with AI"
4
+ description: "How to use AI to generate specification documents from your codebase."
5
+ ---
6
+
7
+ # Generating Specs with AI
8
+
9
+ If you don't have existing specification documents, Alucify can help you generate them using AI.
10
+
11
+ ## Prerequisites
12
+
13
+ - **Claude Code CLI** must be installed and authenticated on your machine
14
+ - The Generate Spec button only appears when the CLI is detected
15
+
16
+ ## How to Generate a Spec
17
+
18
+ 1. In the **Specifications** panel, click the **Generate Spec** button (wand icon)
19
+ 2. Choose an artifact type from the picker:
20
+ - **Product Requirements Document** — Goals, personas, and functional requirements
21
+ - **Architecture Document** — Tech stack, system design, and architecture decisions
22
+ - **UX Specification** — User flows, screen designs, and interaction patterns
23
+ - **Epics & Stories** — Break down requirements into implementable work items
24
+ - **Quick Spec** — Lightweight technical spec for a focused task
25
+ - **Custom** — Describe any artifact you need
26
+ 3. An interactive chat session opens in the sidebar
27
+ 4. The AI uses your project context (if available) to draft the spec, and asks clarifying questions for anything it can't infer
28
+
29
+ The generated spec is saved to `.alucify/artifacts/` and automatically picked up by Alucify for analysis.
30
+
31
+ ## Project Context
32
+
33
+ If you've run a baseline or artifact analysis, the AI will use your project's architecture, data models, requirements, and coverage gaps to pre-populate the spec. This means you don't have to re-describe what already exists — the AI starts from what it knows and asks only about what's missing.
34
+
35
+ For greenfield projects with no analysis, the AI guides you through each section step by step.
36
+
37
+ ## When to Use This
38
+
39
+ - You have an existing codebase but no formal requirements documentation
40
+ - You want to create API specifications from existing endpoints
41
+ - You need to document existing business logic for AI coding agents
42
+ - You're starting a new feature and want a structured spec template
43
+
44
+ ## Notes
45
+
46
+ - The generated spec is a starting point — review and refine it before running spec analysis
47
+ - You can also [add specs manually](adding-specs.md) if you prefer to write them yourself
@@ -0,0 +1,53 @@
1
+ ---
2
+ order: 7
3
+ title: "Refining Specs with Chat"
4
+ description: "How to use the interactive chat to refine and improve your specifications."
5
+ ---
6
+
7
+ # Refining Specs with Chat
8
+
9
+ After analyzing your specs and reviewing the identified risks, you can work with Claude interactively to resolve issues and improve your specifications.
10
+
11
+ ## Starting a Refinement Session
12
+
13
+ ### From the AI Coding Risks Panel
14
+
15
+ 1. Open the [AI Coding Risks](../code-analysis/ai-coding-risks-panel.md) panel
16
+ 2. Select one or more risks using the checkboxes
17
+ 3. Click the **Refine Specs** button (shows "Refine Specs (N selected)" with your selection count)
18
+ 4. A chat panel opens in the secondary sidebar
19
+
20
+ ### From the Command Palette
21
+
22
+ 1. Press `Ctrl+Shift+P` / `Cmd+Shift+P`
23
+ 2. Search for **Alucify: Refine Specs**
24
+
25
+ ## Using the Chat
26
+
27
+ The chat panel opens with context about your selected risks. You can:
28
+
29
+ - **Discuss the risks** — Ask Claude about the issues and get suggestions
30
+ - **Review proposed changes** — Claude will suggest spec updates to resolve each risk
31
+ - **Guide the resolution** — Tell Claude how you want to address each issue
32
+ - **Type `/done`** to end the session
33
+ - **Type `/help`** to see available commands
34
+
35
+ As Claude resolves risks, their status updates from Open to Fixed in the AI Coding Risks panel.
36
+
37
+ ## Chat Mode vs. Terminal Mode
38
+
39
+ Alucify supports two modes for spec refinement, configurable in settings:
40
+
41
+ ### Chat Mode (Default)
42
+ An embedded chat panel in the VS Code secondary sidebar. You interact with Claude through a conversation interface, seeing messages, tool usage, and spec updates in real time.
43
+
44
+ ### Terminal Mode
45
+ Uses the Claude Code CLI in a VS Code terminal. Progress is shown in the terminal output. This mode is useful if you prefer a CLI-based workflow.
46
+
47
+ To switch modes, go to VS Code Settings and search for `alucify.refineSpecs.mode`.
48
+
49
+ ## Tips
50
+
51
+ - **Select related risks together** — Resolving related risks in a single session is more efficient than addressing them one at a time
52
+ - **Be specific** — Tell Claude how you want to resolve ambiguous issues rather than accepting all defaults
53
+ - **Review changes** — After a session, re-run spec analysis to verify that the refinements improved your scores
@@ -0,0 +1,46 @@
1
+ ---
2
+ order: 1
3
+ title: "Specifications Panel"
4
+ description: "A walkthrough of the Spec Analysis tab in VS Code — layout and how each section works."
5
+ ---
6
+
7
+ # Specifications Panel
8
+
9
+ The Spec Analysis tab is the second of three tabs in the Project Analysis panel. It shows how well your specifications align with your codebase.
10
+
11
+ For what these metrics measure, see [Congruency, Coverage & Completeness](../../concepts/congruency-coverage-completeness.md).
12
+
13
+ ## Key Metrics
14
+
15
+ At the top of the tab, you'll see several scores (0–100%):
16
+
17
+ - **Congruency** — How well your specs align with your code
18
+ - **Coverage** — How much of your codebase is covered by specifications
19
+ - **Blast Radius** — The percentage of your project that could be affected by a change (lower is better). See [Blast Radius](../../concepts/blast-radius.md).
20
+ - **AI Readiness** — A composite score. See [AI Readiness](../../concepts/ai-readiness.md).
21
+
22
+ Each score includes a sparkline showing the trend across analysis versions.
23
+
24
+ ## Sections
25
+
26
+ ### Congruency
27
+ Heatmap showing how well each specification aligns with the codebase. Each row represents one of your imported specs. Click **View Details** for the full congruency report for a specific spec.
28
+
29
+ ### Coverage
30
+ Horizontal bars showing what percentage of each component type is grounded in specifications. Higher bars mean better spec coverage.
31
+
32
+ ### Completeness
33
+ A visual indicator of how complete your specification coverage is across different dimensions.
34
+
35
+ ### Impact
36
+ Pie chart showing how your project is distributed across impact categories (New / Modified / Affected / Intact). See [Congruency, Coverage & Completeness → Impact Categories](../../concepts/congruency-coverage-completeness.md#impact-categories).
37
+
38
+ ### AI Coding Risks
39
+ A summary of identified risks with severity counts. Click **View Details** to open the full [AI Coding Risks Panel](../code-analysis/ai-coding-risks-panel.md).
40
+
41
+ ### Recommendations
42
+ The top priority actions to improve your AI readiness score, ordered by impact. Click **View Details** to see the full list.
43
+
44
+ ## Empty State
45
+
46
+ If you haven't added or analyzed specs yet, the tab shows: "Please add specs and analyze them to update this tab." with links to add specs and run analysis.
@@ -0,0 +1,44 @@
1
+ ---
2
+ order: 12
3
+ title: "Status Bar"
4
+ description: "The Alucify status bar item at the bottom of VS Code."
5
+ ---
6
+
7
+ # Status Bar
8
+
9
+ Alucify adds a single status bar item at the bottom-left of VS Code. It's a compact at-a-glance indicator of project state.
10
+
11
+ ## What It Shows
12
+
13
+ ### Idle State
14
+ Displays a short summary: `Alucify • AI Readiness 72%` or `Alucify • No analysis yet`. Hover for more detail (open risk count, last analysis date).
15
+
16
+ ### Active Workflow
17
+ Shows a spinner and the current phase: `Alucify • Analyzing Specs (Phase 3/7)`. Hover for a progress bar and ETA estimate.
18
+
19
+ ### Paused
20
+ Shows a pause icon: `Alucify ⏸ Paused`. Click to resume or cancel.
21
+
22
+ ### Error State
23
+ Shows an error indicator: `Alucify ⚠ Error`. Click to view the error in the Workflow Status view.
24
+
25
+ ## Clicking It
26
+
27
+ A single click toggles the Workflow Status view in the sidebar — your quick path to controls when a workflow is running.
28
+
29
+ ## Hiding the Status Bar Item
30
+
31
+ If you prefer not to see it:
32
+ 1. Right-click the VS Code status bar
33
+ 2. Uncheck **Alucify**
34
+
35
+ This hides the item but doesn't affect functionality — workflows still run, notifications still fire.
36
+
37
+ ## Re-Showing It
38
+
39
+ Same path: right-click the status bar and check **Alucify** again.
40
+
41
+ ## Related
42
+
43
+ - [Workflow Controls](workflow-controls.md)
44
+ - [Notification Preferences](settings/notification-preferences.md)
@@ -0,0 +1 @@
1
+ { "title": "Token Usage", "order": 7 }