@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,63 @@
1
+ ---
2
+ order: 1
3
+ title: "Viewing Token Usage"
4
+ description: "How to open the Token Usage panel and monitor your AI token consumption."
5
+ ---
6
+
7
+ # Viewing Token Usage
8
+
9
+ Alucify tracks all AI token consumption across your project — both from Alucify workflows (code analysis, spec analysis, progress tracking) and from your direct Claude Code sessions.
10
+
11
+ ## Token Strip
12
+
13
+ At the top of the Project Analysis panel, a compact strip shows your total and today's token usage. Click anywhere on the strip to open the full Token Usage panel.
14
+
15
+ ## Opening the Panel
16
+
17
+ - Click the **token strip** at the top of the Project Analysis panel
18
+ - Or open the Command Palette and search for **Alucify: View Token Usage**
19
+
20
+ ## Banner Metrics
21
+
22
+ Four cards at the top of the panel provide a quick summary:
23
+
24
+ - **Total Tokens** — All-time token consumption across all sources
25
+ - **This Week** — Tokens used in the last 7 days, with a percentage showing how it compares to your daily average
26
+ - **Today** — Tokens used today, with a comparison to your daily average
27
+ - **Sessions** — Total number of Claude Code sessions and Alucify workflow runs
28
+
29
+ ## Tabs
30
+
31
+ The panel has three tabs:
32
+
33
+ ### Overview
34
+
35
+ A daily usage bar chart showing the last 30 days of token consumption, stacked by source (Alucify in cyan, Claude Code in orange). Below the chart, a daily breakdown table lists each active day with totals.
36
+
37
+ ### Breakdowns
38
+
39
+ Six breakdown cards showing how tokens are distributed across different dimensions. Use the time period buttons (All Time, This Month, This Week, Today) to filter.
40
+
41
+ Cards include:
42
+ - **By Token Type** — Input, output, cache read, and cache creation tokens
43
+ - **By Source** — Alucify workflows vs direct Claude Code sessions
44
+ - **By Model** — Opus, Sonnet, Haiku
45
+ - **By User** — Per-user attribution (useful for teams)
46
+ - **By Branch** — Claude Code sessions grouped by git branch
47
+ - **By Workflow** — Alucify workflow types (baseline, artifact integration, etc.)
48
+ - **By Auth Mode** — SDK Runner vs API Runner (Alucify only)
49
+
50
+ ### Activity
51
+
52
+ A sortable, filterable table of individual usage records. Each row shows the date, source, user, detail (workflow/phase or session ID), model, token counts, and duration. Use the dropdown filters to narrow by source, model, or user. Click any column header to sort.
53
+
54
+ ## CLI
55
+
56
+ Run `alucify usage` in your terminal to see a summary of token usage. Add `--json` for machine-readable output.
57
+
58
+ ## Automatic Updates
59
+
60
+ Token usage data updates automatically:
61
+ - **Alucify workflows** — recorded in real time as agents run
62
+ - **Claude Code sessions** — ingested from local session logs on extension activation and every 60 seconds while the extension is active
63
+ - **Git commits** — session data is refreshed on each commit (via the post-commit hook installed by `alucify enable`)
@@ -0,0 +1 @@
1
+ { "title": "Versions", "order": 9 }
@@ -0,0 +1,47 @@
1
+ ---
2
+ order: 1
3
+ title: "Comparing Versions"
4
+ description: "Diffing two AppGraph versions in VS Code."
5
+ ---
6
+
7
+ # Comparing Versions
8
+
9
+ For what versions are and why they exist, see [Versions & Snapshots](../../concepts/versions-and-snapshots.md).
10
+
11
+ ## Opening the Compare View
12
+
13
+ - **Command Palette** — **Alucify: Compare Versions**
14
+ - **Advanced menu** — **Compare Versions** (requires [Advanced Mode](../settings/advanced-mode.md))
15
+
16
+ ## Selecting Versions
17
+
18
+ The compare view asks you to pick two version snapshots: a **base** and a **target**. By convention you compare an older version (base) against a newer one (target), but either order works.
19
+
20
+ ## What's Shown
21
+
22
+ The diff view has three sections:
23
+
24
+ ### Nodes
25
+ - **Added** — nodes present in target but not base
26
+ - **Removed** — nodes in base but not target
27
+ - **Modified** — nodes whose fields changed (status, source file, description)
28
+
29
+ Click any node to see the per-field diff.
30
+
31
+ ### Scores
32
+ Before/after values for congruency, coverage, completeness, AI readiness, and blast radius. Deltas are color-coded (green for improvement, red for regression).
33
+
34
+ ### Risks
35
+ - **Resolved** — risks present in base but not target
36
+ - **New** — risks in target but not base
37
+ - **Persisting** — risks present in both
38
+
39
+ ## Use Cases
40
+
41
+ - **Track progress over a sprint** — compare the start and end of a two-week window
42
+ - **Validate spec changes** — compare pre- and post-spec-refinement
43
+ - **Compare analysis modes** — run the same project in Fast and Full, compare what Full catches
44
+
45
+ ## Exporting a Diff
46
+
47
+ The **Export** button produces a Markdown or JSON summary of the diff. Useful for PR descriptions, sprint reviews, or audit trails.
@@ -0,0 +1,44 @@
1
+ ---
2
+ order: 3
3
+ title: "Deleting Versions"
4
+ description: "Removing old AppGraph versions you no longer need."
5
+ ---
6
+
7
+ # Deleting Versions
8
+
9
+ Each version snapshot takes disk space (a few MB to tens of MB depending on project size). You can delete versions you no longer need.
10
+
11
+ ## Opening the Delete Dialog
12
+
13
+ - **Command Palette** — **Alucify: Delete Version**
14
+ - **Advanced menu** — **Delete Version** (requires [Advanced Mode](../settings/advanced-mode.md))
15
+
16
+ ## What Can Be Deleted
17
+
18
+ Any version **except the current one**. If you need to delete the current version, switch to a different one first (see [Switching Versions](switching-versions.md)).
19
+
20
+ ## What Gets Removed
21
+
22
+ Deletion removes:
23
+ - The version's AppGraph JSON files from `.alucify/versions/`
24
+ - Associated analysis reports (congruency, coverage, etc.)
25
+ - Risk records specific to that version
26
+
27
+ The token usage log is **not** affected — usage history is append-only and lives separately.
28
+
29
+ ## Reversing a Delete
30
+
31
+ Deletion is not reversible. If you've committed `.alucify/` to git, you can recover deleted versions via `git checkout`. Otherwise, they're gone.
32
+
33
+ ## Bulk Deletion
34
+
35
+ To delete multiple versions at once, select them in the version list with checkboxes, then click **Delete selected**. You'll be asked to confirm before the delete runs.
36
+
37
+ ## Automatic Cleanup
38
+
39
+ Alucify does not automatically delete old versions. If you want regular cleanup, delete manually on a schedule that fits your team's needs.
40
+
41
+ ## See Also
42
+
43
+ - [Versions & Snapshots](../../concepts/versions-and-snapshots.md)
44
+ - [Alucify Directory Structure](../../reference/alucify-directory.md)
@@ -0,0 +1,43 @@
1
+ ---
2
+ order: 2
3
+ title: "Switching Versions"
4
+ description: "Loading an older AppGraph version as your current view."
5
+ ---
6
+
7
+ # Switching Versions
8
+
9
+ You can load an older version as your current view — useful for investigating how the project looked at a past point without losing newer versions.
10
+
11
+ ## Opening the Version List
12
+
13
+ - **Command Palette** — **Alucify: Switch Version**
14
+ - **Advanced menu** — **Switch Version** (requires [Advanced Mode](../settings/advanced-mode.md))
15
+
16
+ ## What Happens When You Switch
17
+
18
+ The extension reloads all panels against the selected version:
19
+
20
+ - Project Analysis panel shows that version's scores
21
+ - AI Coding Risks panel shows risks as they existed at that version
22
+ - Requirements Progress shows status as it was then
23
+
24
+ New analyses you run will create new versions — they don't overwrite older ones.
25
+
26
+ ## Returning to Latest
27
+
28
+ To go back to the newest version, open the version list and pick the most recent entry (marked with a **Current** badge when selected).
29
+
30
+ ## In-Progress Versions
31
+
32
+ Versions created during an in-progress analysis are filtered out of the default list. To see them, toggle **Show in-progress versions** in the version list. These are useful for debugging partially-completed analyses.
33
+
34
+ ## Gotchas
35
+
36
+ - Switching to an older version affects what's shown in the UI but doesn't change files on disk. Your code isn't modified.
37
+ - MCP tools serve the **current** version (the latest). To point Claude Code at an older version, you'd need to delete newer ones — usually not what you want.
38
+
39
+ ## See Also
40
+
41
+ - [Versions & Snapshots](../../concepts/versions-and-snapshots.md)
42
+ - [Comparing Versions](comparing-versions.md)
43
+ - [Deleting Versions](deleting-versions.md)
@@ -0,0 +1,49 @@
1
+ ---
2
+ order: 11
3
+ title: "Workflow Controls"
4
+ description: "Pausing, resuming, and canceling long-running analyses in VS Code."
5
+ ---
6
+
7
+ # Workflow Controls
8
+
9
+ Analyses that take more than a few minutes (Balanced and Quality modes, especially on large projects) can be paused, resumed, or canceled.
10
+
11
+ ## Where the Controls Are
12
+
13
+ - **Workflow Status view** in the Alucify Activity Bar shows live progress and exposes the controls
14
+ - **Status bar item** at the bottom of VS Code shows a compact indicator; click it to open the Workflow Status view
15
+
16
+ ## Controls
17
+
18
+ ### Pause
19
+ Suspends the current workflow at the next phase boundary. Any in-flight LLM calls finish first — no tokens are wasted. State is checkpointed so you can resume later.
20
+
21
+ Use when:
22
+ - You need to step away and want to pick up later
23
+ - You're close to your API rate limit and want to let it reset
24
+ - You want to inspect intermediate results before continuing
25
+
26
+ ### Resume
27
+ Picks up from the last checkpoint. Already-completed phases don't re-run; only the work that was pending continues.
28
+
29
+ ### Cancel
30
+ Stops the workflow entirely. In-flight LLM calls finish, then the workflow exits without writing final results. Any partial data produced up to that point is preserved as an in-progress version.
31
+
32
+ ## What's Preserved
33
+
34
+ - **Paused:** everything — the run resumes exactly where it stopped
35
+ - **Canceled:** partial outputs, written as an in-progress version (not visible in the default version list)
36
+
37
+ To view an in-progress version, enable [Advanced Mode](settings/advanced-mode.md) and toggle **Show in-progress versions** in the version list.
38
+
39
+ ## Notifications
40
+
41
+ If you've enabled OS notifications, you'll get a notification when:
42
+ - A workflow completes (or fails)
43
+ - A paused workflow has been idle for 30+ minutes (reminder to resume or cancel)
44
+
45
+ See [Notification Preferences](settings/notification-preferences.md).
46
+
47
+ ## What Can't Be Controlled
48
+
49
+ Mechanical phases (AST parsing, file scanning) run too fast to expose pause controls — they complete in seconds. Controls apply only to LLM-driven phases.
@@ -0,0 +1,56 @@
1
+ ---
2
+ order: 0
3
+ title: "What is Alucify?"
4
+ description: "An overview of Alucify — what it does, who it's for, and how it helps you build better software with AI coding agents."
5
+ ---
6
+
7
+ # What is Alucify?
8
+
9
+ Alucify ensures your project is ready for AI coding by creating a unified, structured context and identifying potential gaps and issues to save you time and tokens.
10
+
11
+ ## The Problem
12
+
13
+ When you use AI coding agents like Claude Code to build features, the AI needs to understand your project — its architecture, requirements, and how everything fits together. Without this context, AI agents can:
14
+
15
+ - Miss requirements that aren't documented in code
16
+ - Create implementations that conflict with existing specs
17
+ - Introduce technical debt by not understanding the broader system
18
+ - Waste tokens re-discovering project structure on every session
19
+
20
+ ## How Alucify Helps
21
+
22
+ Alucify works in five steps — see the [Workflow Overview](concepts/workflow-overview.md):
23
+
24
+ 1. **Analyze Code** — Scan your codebase to identify its structure, components, data models, and business logic.
25
+ 2. **Add Specs** — Import your PRDs, design docs, API specs, and any other project documents. Many formats supported.
26
+ 3. **Analyze Specs** — Compare your specifications against your codebase to identify coverage gaps, contradictions, and potential impact.
27
+ 4. **Review Risks** — Use the interactive chat to refine your specs based on the analysis findings. Resolve risks before handing work to an AI coding agent.
28
+ 5. **Plan & Track Progress** — Plan implementation work against open requirements and monitor AI-generated code against your specs as commits land.
29
+
30
+ ## Who Is Alucify For?
31
+
32
+ Alucify is designed for software teams and individual developers who:
33
+
34
+ - Use AI coding agents (like Claude Code) to implement features
35
+ - Have requirements documents, PRDs, or design specs that guide their work
36
+ - Want to ensure their AI-generated code aligns with project requirements
37
+ - Need to track implementation progress against specifications
38
+
39
+ ## Four UIs, One Core
40
+
41
+ You can use Alucify through whichever interface fits your workflow — they're all equal peers backed by the same core engine:
42
+
43
+ - **[VS Code Extension](vscode/installation.md)** — tightly integrated with your editor (tree views, status bar, command palette, inline jumps)
44
+ - **[CLI](cli/installation.md)** — scriptable, great for automation and CI/CD; also launches the Web UI
45
+ - **[Web UI](cli/ui/launching.md)** — rich browser dashboard with chat and visualizations
46
+ - **[Desktop App](desktop/installation.md)** — standalone native app with workspace management and OS notifications
47
+
48
+ Alucify also exposes an **[MCP Server](mcp-server/setup.md)** that gives Claude Code direct access to your project analysis.
49
+
50
+ Not sure which UI to pick? See [Choosing a UI](getting-started/choosing-a-ui.md).
51
+
52
+ ## What's Next?
53
+
54
+ - [Choosing a UI](getting-started/choosing-a-ui.md) — Pick the right interface for you
55
+ - [Key Concepts](getting-started/key-concepts.md) — Understand the core ideas behind Alucify
56
+ - [Your First Analysis](getting-started/first-analysis.md) — Run through the full workflow end-to-end