@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.
- package/dist/cli.js +1590 -1061
- package/dist/docs/help/cli/_meta.json +1 -0
- package/dist/docs/help/cli/authentication.md +70 -0
- package/dist/docs/help/cli/automation.md +72 -0
- package/dist/docs/help/cli/commands/_meta.json +1 -0
- package/dist/docs/help/cli/commands/add-spec.md +49 -0
- package/dist/docs/help/cli/commands/analyze-code.md +54 -0
- package/dist/docs/help/cli/commands/analyze-progress.md +73 -0
- package/dist/docs/help/cli/commands/analyze-specs.md +60 -0
- package/dist/docs/help/cli/commands/capture-intent.md +56 -0
- package/dist/docs/help/cli/commands/check.md +49 -0
- package/dist/docs/help/cli/commands/context.md +52 -0
- package/dist/docs/help/cli/commands/continue.md +40 -0
- package/dist/docs/help/cli/commands/enable-disable.md +53 -0
- package/dist/docs/help/cli/commands/help.md +30 -0
- package/dist/docs/help/cli/commands/mcp-install.md +54 -0
- package/dist/docs/help/cli/commands/plan.md +43 -0
- package/dist/docs/help/cli/commands/progress.md +58 -0
- package/dist/docs/help/cli/commands/status.md +50 -0
- package/dist/docs/help/cli/commands/ui.md +50 -0
- package/dist/docs/help/cli/commands/usage.md +65 -0
- package/dist/docs/help/cli/commands/version.md +66 -0
- package/dist/docs/help/cli/installation.md +70 -0
- package/dist/docs/help/cli/quickstart.md +75 -0
- package/dist/docs/help/cli/ui/_meta.json +1 -0
- package/dist/docs/help/cli/ui/ai-coding-risks-tab.md +46 -0
- package/dist/docs/help/cli/ui/appgraph-visualizer-tab.md +54 -0
- package/dist/docs/help/cli/ui/artifacts-sidebar.md +53 -0
- package/dist/docs/help/cli/ui/chat-panel.md +56 -0
- package/dist/docs/help/cli/ui/code-analysis-tab.md +36 -0
- package/dist/docs/help/cli/ui/dashboard.md +44 -0
- package/dist/docs/help/cli/ui/launching.md +46 -0
- package/dist/docs/help/cli/ui/requirements-progress-tab.md +49 -0
- package/dist/docs/help/cli/ui/settings-tab.md +52 -0
- package/dist/docs/help/cli/ui/tech-debt-tab.md +29 -0
- package/dist/docs/help/cli/ui/token-usage-tab.md +46 -0
- package/dist/docs/help/concepts/_meta.json +1 -0
- package/dist/docs/help/concepts/ai-coding-risks.md +50 -0
- package/dist/docs/help/concepts/ai-readiness.md +34 -0
- package/dist/docs/help/concepts/analysis-modes.md +66 -0
- package/dist/docs/help/concepts/appgraph.md +56 -0
- package/dist/docs/help/concepts/artifacts-and-specs.md +46 -0
- package/dist/docs/help/concepts/authentication-modes.md +68 -0
- package/dist/docs/help/concepts/blast-radius.md +37 -0
- package/dist/docs/help/concepts/chat-refinement.md +40 -0
- package/dist/docs/help/concepts/congruency-coverage-completeness.md +50 -0
- package/dist/docs/help/concepts/implementation-progress.md +44 -0
- package/dist/docs/help/concepts/intent-capture.md +46 -0
- package/dist/docs/help/concepts/tech-debt-analysis.md +65 -0
- package/dist/docs/help/concepts/token-usage.md +70 -0
- package/dist/docs/help/concepts/versions-and-snapshots.md +57 -0
- package/dist/docs/help/concepts/workflow-overview.md +40 -0
- package/dist/docs/help/desktop/_meta.json +1 -0
- package/dist/docs/help/desktop/installation.md +56 -0
- package/dist/docs/help/desktop/keyboard-shortcuts.md +47 -0
- package/dist/docs/help/desktop/menu-bar.md +47 -0
- package/dist/docs/help/desktop/notifications.md +44 -0
- package/dist/docs/help/desktop/quickstart.md +43 -0
- package/dist/docs/help/desktop/switching-workspaces.md +39 -0
- package/dist/docs/help/desktop/workspace-picker.md +38 -0
- package/dist/docs/help/extension/_meta.json +1 -0
- package/dist/docs/help/extension/authentication/_meta.json +1 -0
- package/dist/docs/help/extension/authentication/api-key-setup.md +47 -0
- package/dist/docs/help/extension/authentication/claude-code-setup.md +43 -0
- package/dist/docs/help/extension/authentication/signing-in.md +36 -0
- package/dist/docs/help/extension/authentication/switching-auth-modes.md +28 -0
- package/dist/docs/help/extension/chat/_meta.json +1 -0
- package/dist/docs/help/extension/chat/asking-about-your-project.md +39 -0
- package/dist/docs/help/extension/code-analysis/_meta.json +1 -0
- package/dist/docs/help/extension/code-analysis/analysis-modes.md +63 -0
- package/dist/docs/help/extension/code-analysis/running-code-analysis.md +54 -0
- package/dist/docs/help/extension/code-analysis/understanding-ai-coding-risks.md +75 -0
- package/dist/docs/help/extension/code-analysis/understanding-tech-debt-analysis.md +90 -0
- package/dist/docs/help/extension/code-analysis/understanding-the-code-analysis-tab.md +49 -0
- package/dist/docs/help/extension/dev-progress/_meta.json +1 -0
- package/dist/docs/help/extension/dev-progress/analyzing-commits.md +56 -0
- package/dist/docs/help/extension/dev-progress/understanding-the-dev-progress-tab.md +40 -0
- package/dist/docs/help/extension/installation.md +34 -0
- package/dist/docs/help/extension/intent-capture/_meta.json +1 -0
- package/dist/docs/help/extension/intent-capture/enabling-intent-capture.md +40 -0
- package/dist/docs/help/extension/intent-capture/understanding-intent-capture.md +40 -0
- package/dist/docs/help/extension/quickstart.md +60 -0
- package/dist/docs/help/extension/resetting-analysis.md +46 -0
- package/dist/docs/help/extension/settings/_meta.json +1 -0
- package/dist/docs/help/extension/settings/notification-preferences.md +38 -0
- package/dist/docs/help/extension/settings/telemetry.md +45 -0
- package/dist/docs/help/extension/spec-analysis/_meta.json +1 -0
- package/dist/docs/help/extension/spec-analysis/adding-specs.md +40 -0
- package/dist/docs/help/extension/spec-analysis/analyzing-specs.md +60 -0
- package/dist/docs/help/extension/spec-analysis/auditing-specs.md +30 -0
- package/dist/docs/help/extension/spec-analysis/filtering-and-browsing-specs.md +43 -0
- package/dist/docs/help/extension/spec-analysis/generating-specs.md +47 -0
- package/dist/docs/help/extension/spec-analysis/refining-specs.md +53 -0
- package/dist/docs/help/extension/spec-analysis/understanding-the-spec-analysis-tab.md +55 -0
- package/dist/docs/help/extension/token-usage/_meta.json +1 -0
- package/dist/docs/help/extension/token-usage/understanding-token-usage.md +64 -0
- package/dist/docs/help/extension/token-usage/viewing-token-usage.md +63 -0
- package/dist/docs/help/faq.md +128 -0
- package/dist/docs/help/getting-started/_meta.json +1 -0
- package/dist/docs/help/getting-started/choosing-a-ui.md +60 -0
- package/dist/docs/help/getting-started/first-analysis.md +86 -0
- package/dist/docs/help/getting-started/installation.md +65 -0
- package/dist/docs/help/getting-started/key-concepts.md +73 -0
- package/dist/docs/help/getting-started/supported-project-types.md +65 -0
- package/dist/docs/help/getting-started/system-requirements.md +61 -0
- package/dist/docs/help/integrations/_meta.json +1 -0
- package/dist/docs/help/integrations/ci-cd.md +95 -0
- package/dist/docs/help/integrations/claude-code-hooks.md +54 -0
- package/dist/docs/help/integrations/claude-code.md +123 -0
- package/dist/docs/help/integrations/git-hooks.md +64 -0
- package/dist/docs/help/mcp-server/_meta.json +1 -0
- package/dist/docs/help/mcp-server/quickstart.md +59 -0
- package/dist/docs/help/mcp-server/resources/_meta.json +1 -0
- package/dist/docs/help/mcp-server/resources/terminology-resource.md +74 -0
- package/dist/docs/help/mcp-server/setup.md +75 -0
- package/dist/docs/help/mcp-server/tools/_meta.json +1 -0
- package/dist/docs/help/mcp-server/tools/coverage-gaps.md +58 -0
- package/dist/docs/help/mcp-server/tools/find-similar-context.md +65 -0
- package/dist/docs/help/mcp-server/tools/get-analysis.md +54 -0
- package/dist/docs/help/mcp-server/tools/get-details.md +48 -0
- package/dist/docs/help/mcp-server/tools/impact-analysis.md +49 -0
- package/dist/docs/help/mcp-server/tools/implementation-tasks.md +68 -0
- package/dist/docs/help/mcp-server/tools/link-node.md +51 -0
- package/dist/docs/help/mcp-server/tools/query.md +53 -0
- package/dist/docs/help/mcp-server/tools/tools-reference.md +63 -0
- package/dist/docs/help/mcp-server/tools/verify-plan.md +82 -0
- package/dist/docs/help/mcp-server/tools/version-diff.md +42 -0
- package/dist/docs/help/mcp-server/using-with-claude-code.md +72 -0
- package/dist/docs/help/reference/_meta.json +1 -0
- package/dist/docs/help/reference/alucify-directory.md +86 -0
- package/dist/docs/help/reference/file-types-and-formats.md +76 -0
- package/dist/docs/help/reference/glossary.md +60 -0
- package/dist/docs/help/reference/how-claude-code-integration-works.md +123 -0
- package/dist/docs/help/reference/ui-parity-matrix.md +121 -0
- package/dist/docs/help/vscode/_meta.json +1 -0
- package/dist/docs/help/vscode/advanced/_meta.json +1 -0
- package/dist/docs/help/vscode/advanced/congruency-analysis.md +32 -0
- package/dist/docs/help/vscode/advanced/coverage-analysis.md +31 -0
- package/dist/docs/help/vscode/advanced/developer-mode.md +34 -0
- package/dist/docs/help/vscode/advanced/findings-synthesis.md +27 -0
- package/dist/docs/help/vscode/advanced/impact-analysis.md +31 -0
- package/dist/docs/help/vscode/advanced/reset-extension.md +39 -0
- package/dist/docs/help/vscode/appgraph-visualizer/_meta.json +1 -0
- package/dist/docs/help/vscode/appgraph-visualizer/filtering-and-search.md +63 -0
- package/dist/docs/help/vscode/appgraph-visualizer/navigating-the-graph.md +34 -0
- package/dist/docs/help/vscode/appgraph-visualizer/node-details.md +49 -0
- package/dist/docs/help/vscode/appgraph-visualizer/opening-the-visualizer.md +33 -0
- package/dist/docs/help/vscode/authentication/_meta.json +1 -0
- package/dist/docs/help/vscode/authentication/api-key-setup.md +47 -0
- package/dist/docs/help/vscode/authentication/claude-code-setup.md +43 -0
- package/dist/docs/help/vscode/authentication/signing-in.md +36 -0
- package/dist/docs/help/vscode/authentication/switching-auth-modes.md +28 -0
- package/dist/docs/help/vscode/chat/_meta.json +1 -0
- package/dist/docs/help/vscode/chat/asking-about-your-project.md +39 -0
- package/dist/docs/help/vscode/chat/generating-artifacts-in-chat.md +53 -0
- package/dist/docs/help/vscode/chat/refining-specs-in-chat.md +47 -0
- package/dist/docs/help/vscode/code-analysis/_meta.json +1 -0
- package/dist/docs/help/vscode/code-analysis/ai-coding-risks-panel.md +42 -0
- package/dist/docs/help/vscode/code-analysis/project-analysis-panel.md +46 -0
- package/dist/docs/help/vscode/code-analysis/running-code-analysis.md +54 -0
- package/dist/docs/help/vscode/code-analysis/tech-debt-panel.md +27 -0
- package/dist/docs/help/vscode/command-palette.md +83 -0
- package/dist/docs/help/vscode/dev-progress/_meta.json +1 -0
- package/dist/docs/help/vscode/dev-progress/analyzing-commits.md +56 -0
- package/dist/docs/help/vscode/dev-progress/progress-panel-actions.md +56 -0
- package/dist/docs/help/vscode/dev-progress/understanding-the-dev-progress-tab.md +40 -0
- package/dist/docs/help/vscode/installation.md +34 -0
- package/dist/docs/help/vscode/intent-capture/_meta.json +1 -0
- package/dist/docs/help/vscode/intent-capture/analyzing-intent.md +49 -0
- package/dist/docs/help/vscode/intent-capture/enabling-intent-capture.md +40 -0
- package/dist/docs/help/vscode/quickstart.md +60 -0
- package/dist/docs/help/vscode/resetting-analysis.md +46 -0
- package/dist/docs/help/vscode/settings/_meta.json +1 -0
- package/dist/docs/help/vscode/settings/advanced-mode.md +53 -0
- package/dist/docs/help/vscode/settings/all-settings.md +66 -0
- package/dist/docs/help/vscode/settings/auto-analyze-specs.md +43 -0
- package/dist/docs/help/vscode/settings/notification-preferences.md +38 -0
- package/dist/docs/help/vscode/settings/telemetry.md +45 -0
- package/dist/docs/help/vscode/spec-analysis/_meta.json +1 -0
- package/dist/docs/help/vscode/spec-analysis/adding-specs.md +40 -0
- package/dist/docs/help/vscode/spec-analysis/analyzing-specs.md +60 -0
- package/dist/docs/help/vscode/spec-analysis/auditing-specs.md +30 -0
- package/dist/docs/help/vscode/spec-analysis/filtering-and-browsing-specs.md +43 -0
- package/dist/docs/help/vscode/spec-analysis/generating-specs.md +47 -0
- package/dist/docs/help/vscode/spec-analysis/refining-specs.md +53 -0
- package/dist/docs/help/vscode/spec-analysis/specifications-panel.md +46 -0
- package/dist/docs/help/vscode/status-bar.md +44 -0
- package/dist/docs/help/vscode/token-usage/_meta.json +1 -0
- package/dist/docs/help/vscode/token-usage/viewing-token-usage.md +63 -0
- package/dist/docs/help/vscode/versions/_meta.json +1 -0
- package/dist/docs/help/vscode/versions/comparing-versions.md +47 -0
- package/dist/docs/help/vscode/versions/deleting-versions.md +44 -0
- package/dist/docs/help/vscode/versions/switching-versions.md +43 -0
- package/dist/docs/help/vscode/workflow-controls.md +49 -0
- package/dist/docs/help/what-is-alucify.md +56 -0
- package/dist/mcp-server-vendored.js +28 -28
- package/dist/web/app.css +38 -0
- package/dist/web/app.js +671 -0
- package/dist/web/favicon.png +0 -0
- package/dist/web/favicon.svg +7 -0
- package/dist/web/index.html +15 -0
- package/package.json +1 -1
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 4
|
|
3
|
+
title: "Understanding Technical Debt Analysis"
|
|
4
|
+
description: "How to read and use the Technical Debt Analysis panel, including the Architecture Health Score."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Understanding Technical Debt Analysis
|
|
8
|
+
|
|
9
|
+
The Technical Debt Analysis panel provides a detailed assessment of your codebase's structural health, helping you identify areas of architectural risk before they cause problems for AI coding agents.
|
|
10
|
+
|
|
11
|
+
## Opening the Panel
|
|
12
|
+
|
|
13
|
+
- From the Code Analysis tab, click **View Details** next to the Architecture Health section
|
|
14
|
+
- Or open the Command Palette and search for **Alucify: View Technical Debt Analysis**
|
|
15
|
+
|
|
16
|
+
## Health Score
|
|
17
|
+
|
|
18
|
+
At the top of the panel, a large score (0–100) with a letter grade summarizes your architecture's overall health:
|
|
19
|
+
|
|
20
|
+
- **70–100 (Green)** — Healthy architecture with low structural risk
|
|
21
|
+
- **40–69 (Yellow)** — Moderate issues that should be addressed
|
|
22
|
+
- **Below 40 (Red)** — Significant structural problems that need attention
|
|
23
|
+
|
|
24
|
+
## Banner Metrics
|
|
25
|
+
|
|
26
|
+
Four cards below the health score provide key insights:
|
|
27
|
+
|
|
28
|
+
### Change Scope
|
|
29
|
+
The average percentage of your project affected when a single change propagates through dependencies. **Lower is better** — it means changes stay contained rather than rippling across the system.
|
|
30
|
+
|
|
31
|
+
### Structural Risk
|
|
32
|
+
How fragile your architecture is to cascading failures:
|
|
33
|
+
- **Low** — Less than 20% of components are at risk
|
|
34
|
+
- **Moderate** — 20–40% of components are at risk
|
|
35
|
+
- **High** — More than 40% of components are at risk
|
|
36
|
+
|
|
37
|
+
### Debt Trend
|
|
38
|
+
Whether structural debt is growing or shrinking over time:
|
|
39
|
+
- **Stable** — Debt isn't compounding
|
|
40
|
+
- **X cycles (Doubling Time)** — Debt is growing; the number indicates how quickly
|
|
41
|
+
- **X cycles (Halving Time)** — Debt is shrinking; the architecture is improving
|
|
42
|
+
|
|
43
|
+
## Detail Tabs
|
|
44
|
+
|
|
45
|
+
The panel has six tabs for deeper analysis:
|
|
46
|
+
|
|
47
|
+
### Remediation
|
|
48
|
+
Priority actions to reduce technical debt, ordered by impact. Each action shows:
|
|
49
|
+
- What percentage of total debt it addresses
|
|
50
|
+
- A description of the issue
|
|
51
|
+
- The expected outcome if addressed
|
|
52
|
+
|
|
53
|
+
A **Root Cause** alert may appear highlighting high-dependency components that are the source of multiple issues.
|
|
54
|
+
|
|
55
|
+
### Change Scope
|
|
56
|
+
Visualizes how far changes propagate through your codebase. Shows:
|
|
57
|
+
- The average scope percentage
|
|
58
|
+
- How many components a typical change touches
|
|
59
|
+
- A breakdown by change type, each rated Low / Moderate / High effort
|
|
60
|
+
|
|
61
|
+
### Structural Risk
|
|
62
|
+
A snapshot of architectural complexity today:
|
|
63
|
+
- **Fragility Index** — A 0–100 score measuring coupling, dependency cycles, and structural bottlenecks
|
|
64
|
+
- **Health Score Breakdown** — Individual scores for each health dimension with letter grades and weights
|
|
65
|
+
- **Stress Attribution** — Which specific structural patterns (like circular dependencies, single points of failure, or cross-feature coupling) contribute most to risk
|
|
66
|
+
|
|
67
|
+
### Debt Trend
|
|
68
|
+
A forward-looking simulation that projects how your architecture responds to sustained change pressure:
|
|
69
|
+
- Shows whether debt compounds or gets absorbed over time
|
|
70
|
+
- Includes a trajectory graph showing stress levels across simulation cycles
|
|
71
|
+
- Lists the most affected components and their stress changes
|
|
72
|
+
- A health callout indicates whether your architecture shows compounding risk or is structurally sound
|
|
73
|
+
|
|
74
|
+
### Complexity
|
|
75
|
+
Identifies the most complex areas of your codebase:
|
|
76
|
+
- Lists complexity hotspots by location
|
|
77
|
+
- Shows maximum cognitive complexity per component
|
|
78
|
+
- Flags functions that are candidates for refactoring
|
|
79
|
+
|
|
80
|
+
Complexity scale:
|
|
81
|
+
- **0–5:** Trivial
|
|
82
|
+
- **6–15:** Moderate
|
|
83
|
+
- **16–30:** High (flagged as hotspot)
|
|
84
|
+
- **31+:** Very high (strong refactoring signal)
|
|
85
|
+
|
|
86
|
+
### Outdated Packages
|
|
87
|
+
Shows which dependencies are out of date:
|
|
88
|
+
- Lists packages with current and latest versions
|
|
89
|
+
- Highlights risk levels for outdated dependencies
|
|
90
|
+
- Requires internet access during analysis to detect outdated packages
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 2
|
|
3
|
+
title: "Understanding the Code Analysis Tab"
|
|
4
|
+
description: "A walkthrough of the Code Analysis tab — metrics, codebase summary, and what each section means."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Understanding the Code Analysis Tab
|
|
8
|
+
|
|
9
|
+
The Code Analysis tab is the first of three tabs in the Project Analysis panel. It shows the results of your codebase scan.
|
|
10
|
+
|
|
11
|
+
## Codebase Section
|
|
12
|
+
|
|
13
|
+
This section provides a high-level summary of your project:
|
|
14
|
+
|
|
15
|
+
- **Lines of Code** — Total lines across your project (displayed as "1.2M", "301k", "45k", etc.)
|
|
16
|
+
- **Tech Stack** — Detected frameworks and languages shown as tag pills (e.g., "React", "Express", "PostgreSQL")
|
|
17
|
+
- **Analysis Date** — When the codebase was last analyzed (hover the info icon for the exact date)
|
|
18
|
+
|
|
19
|
+
## Analysis Mode
|
|
20
|
+
|
|
21
|
+
Shows which analysis mode was used, displayed as:
|
|
22
|
+
- **Speed** (catalog mode)
|
|
23
|
+
- **Balanced** (fast mode)
|
|
24
|
+
- **Quality** (full mode)
|
|
25
|
+
|
|
26
|
+
## Architecture Health
|
|
27
|
+
|
|
28
|
+
If a technical debt analysis has been run, this section shows:
|
|
29
|
+
|
|
30
|
+
- **Health Score** — A 0–100 score with a letter grade (A–F) rating your architecture's structural health
|
|
31
|
+
- **View Details** link — Opens the full [Technical Debt Analysis](understanding-tech-debt-analysis.md) panel
|
|
32
|
+
|
|
33
|
+
## AI Coding Risks
|
|
34
|
+
|
|
35
|
+
If risks have been identified, this section shows a summary:
|
|
36
|
+
|
|
37
|
+
- **Risk count** — Total number of identified risks
|
|
38
|
+
- **Severity breakdown** — Count by severity level (Critical, High, Medium, Low)
|
|
39
|
+
- **View Details** link — Opens the full [AI Coding Risks](understanding-ai-coding-risks.md) panel
|
|
40
|
+
|
|
41
|
+
## Action Buttons
|
|
42
|
+
|
|
43
|
+
- **Analyze Code** — Appears when no baseline exists, or when code has changed since the last analysis. Click to run or re-run code analysis.
|
|
44
|
+
|
|
45
|
+
## Understanding Scores
|
|
46
|
+
|
|
47
|
+
When you first see your scores, a dismissible card explains: "These scores show how ready your specs are for AI coding. Higher is better. Hover any score for details and check out the recommendations for next steps."
|
|
48
|
+
|
|
49
|
+
Click **Got it** to dismiss this card permanently.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{ "title": "Dev Progress", "order": 6 }
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 1
|
|
3
|
+
title: "Analyzing Implementation Progress"
|
|
4
|
+
description: "How to analyze your git commits to track implementation progress against specs."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Analyzing Implementation Progress
|
|
8
|
+
|
|
9
|
+
Progress tracking analyzes your git commits to determine what's been implemented, what's in progress, and what's still outstanding — all measured against your specifications.
|
|
10
|
+
|
|
11
|
+
## Prerequisites
|
|
12
|
+
|
|
13
|
+
Before analyzing progress:
|
|
14
|
+
|
|
15
|
+
1. You've run both [code analysis](../code-analysis/running-code-analysis.md) and [spec analysis](../spec-analysis/analyzing-specs.md)
|
|
16
|
+
2. You have git commits to analyze
|
|
17
|
+
|
|
18
|
+
## How to Analyze Progress
|
|
19
|
+
|
|
20
|
+
1. In the **Project Analysis** panel, switch to the **Dev Progress** tab
|
|
21
|
+
2. Click the **Analyze Progress** button
|
|
22
|
+
3. Alucify analyzes your commits since the last checkpoint
|
|
23
|
+
|
|
24
|
+
The analysis classifies each commit's changes against your specifications, updating the implementation status of each requirement.
|
|
25
|
+
|
|
26
|
+
## Automatic Progress Analysis
|
|
27
|
+
|
|
28
|
+
After running **Analyze Specs**, progress analysis runs automatically if your project has requirements linked to code. You don't need to trigger it manually the first time — it happens as part of the spec analysis workflow.
|
|
29
|
+
|
|
30
|
+
## What Happens During Analysis
|
|
31
|
+
|
|
32
|
+
Progress analysis:
|
|
33
|
+
|
|
34
|
+
1. Reads your git history since the last analyzed checkpoint
|
|
35
|
+
2. Maps file changes to project components using source file links and code references
|
|
36
|
+
3. Reads the **full file content** for components being reassessed, so the classifier can judge whether the implementation is complete — not just what changed
|
|
37
|
+
4. Classifies whether changes implement, partially implement, or test requirements
|
|
38
|
+
5. Records **implementation gaps** for in-progress components — concrete notes describing exactly what's missing (e.g., "has GET handler but missing POST/DELETE branches")
|
|
39
|
+
6. Updates implementation statuses (Planned → In Progress → Implemented)
|
|
40
|
+
7. Saves a checkpoint so future analyses only process new commits
|
|
41
|
+
8. Creates a versioned snapshot
|
|
42
|
+
|
|
43
|
+
## Using the Command Palette
|
|
44
|
+
|
|
45
|
+
You can also start progress analysis from the Command Palette:
|
|
46
|
+
|
|
47
|
+
1. Press `Ctrl+Shift+P` / `Cmd+Shift+P`
|
|
48
|
+
2. Search for **Alucify: Analyze Progress**
|
|
49
|
+
|
|
50
|
+
## Tips
|
|
51
|
+
|
|
52
|
+
- **Analyze regularly** — Run progress analysis after significant commits to keep your status up to date
|
|
53
|
+
- **The first analysis covers all history** — The initial run analyzes all commits since your spec analysis. Subsequent runs only process new commits.
|
|
54
|
+
- **Uncommitted changes are included** — Analysis looks at both committed and uncommitted changes
|
|
55
|
+
- **In-progress components are always re-checked** — Components marked as in-progress are reassessed on every run until they reach implemented, even if their files haven't changed since the last checkpoint
|
|
56
|
+
- **Link files for better accuracy** — Use `link_context` (via Claude Code) to connect components to their implementation files. This enables mechanical matching and ensures components are tracked accurately across runs.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 2
|
|
3
|
+
title: "Understanding the Dev Progress Tab"
|
|
4
|
+
description: "A walkthrough of the Dev Progress tab — progress metrics, requirement status, and commit analysis."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Understanding the Dev Progress Tab
|
|
8
|
+
|
|
9
|
+
The Dev Progress tab is the third of three tabs in the Project Analysis panel. It tracks your implementation progress against specifications.
|
|
10
|
+
|
|
11
|
+
## Dev Progress Metric
|
|
12
|
+
|
|
13
|
+
At the top, a percentage shows your overall development progress — the proportion of specified components that have been implemented or tested. A sparkline shows the trend across analysis versions.
|
|
14
|
+
|
|
15
|
+
## Requirements Section
|
|
16
|
+
|
|
17
|
+
Below the progress metric, a breakdown shows the status of each requirement:
|
|
18
|
+
|
|
19
|
+
- How many requirements exist in total
|
|
20
|
+
- How many are in each status: Planned, In Progress, Implemented
|
|
21
|
+
- A visual indicator for each requirement showing its current state
|
|
22
|
+
- Per-requirement implementation progress showing how many components are done
|
|
23
|
+
|
|
24
|
+
Requirements that were newly added since the last analysis are marked with a **NEW** badge.
|
|
25
|
+
|
|
26
|
+
For in-progress components, the tab shows **implementation gaps** — concrete notes describing what's still missing (e.g., "Missing scope check before mutation; missing audit_log() call on delete"). These gap notes are used by the `/alucify-plan` skill to generate targeted code changes.
|
|
27
|
+
|
|
28
|
+
## Getting Started
|
|
29
|
+
|
|
30
|
+
If you haven't analyzed any commits yet, the tab shows a guide explaining the feature and an **Analyze Progress** button to get started.
|
|
31
|
+
|
|
32
|
+
## Claude Code Integration
|
|
33
|
+
|
|
34
|
+
The Dev Progress tab includes a toggle to enable Alucify integration with Claude Code. When enabled, Claude Code gains access to your project analysis through the MCP server, allowing it to make more informed implementation decisions.
|
|
35
|
+
|
|
36
|
+
See [Setting Up the MCP Server](../../mcp-server/setup.md) for details.
|
|
37
|
+
|
|
38
|
+
## Empty State
|
|
39
|
+
|
|
40
|
+
If you haven't run spec analysis yet, the tab shows: "Run code and spec analysis first to start tracking progress."
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 2
|
|
3
|
+
title: "Installing the Extension"
|
|
4
|
+
description: "How to install the Alucify extension from the VS Code Marketplace."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Installing the Extension
|
|
8
|
+
|
|
9
|
+
## From the VS Code Marketplace
|
|
10
|
+
|
|
11
|
+
1. Open VS Code
|
|
12
|
+
2. Click the **Extensions** icon in the activity bar (or press `Ctrl+Shift+X` / `Cmd+Shift+X`)
|
|
13
|
+
3. Search for **Alucify**
|
|
14
|
+
4. Click **Install**
|
|
15
|
+
|
|
16
|
+
After installation, the Alucify icon appears in your activity bar (left sidebar).
|
|
17
|
+
|
|
18
|
+
## Requirements
|
|
19
|
+
|
|
20
|
+
- VS Code version 1.85.0 or later
|
|
21
|
+
- A project folder open in VS Code
|
|
22
|
+
|
|
23
|
+
## First Launch
|
|
24
|
+
|
|
25
|
+
When you click the Alucify icon for the first time, you'll see the welcome screen. This guides you through:
|
|
26
|
+
|
|
27
|
+
1. Creating an Alucify account (free)
|
|
28
|
+
2. Connecting to Claude (API key or Claude Code subscription)
|
|
29
|
+
|
|
30
|
+
See [VS Code Extension Quick Start](quickstart.md) for the complete setup walkthrough.
|
|
31
|
+
|
|
32
|
+
## Updating
|
|
33
|
+
|
|
34
|
+
The extension updates automatically through VS Code's built-in extension update mechanism. You can also manually check for updates in the Extensions panel.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{ "title": "Intent Capture", "order": 7 }
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 1
|
|
3
|
+
title: "Enabling Intent Capture"
|
|
4
|
+
description: "How to turn on intent capture and surface requirements from your Claude Code sessions."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Enabling Intent Capture
|
|
8
|
+
|
|
9
|
+
Intent capture surfaces requirements, decisions, and design context from your Claude Code sessions and adds them to your AppGraph — so the thinking behind your code doesn't get lost when a session ends.
|
|
10
|
+
|
|
11
|
+
## Prerequisites
|
|
12
|
+
|
|
13
|
+
- You've run `alucify enable` (sets up the Claude Code integration)
|
|
14
|
+
- You have an AppGraph (run **Analyze Code** or **Analyze Specs** first)
|
|
15
|
+
|
|
16
|
+
## Turning It On
|
|
17
|
+
|
|
18
|
+
1. Open VS Code Settings (`Cmd+,` / `Ctrl+,`)
|
|
19
|
+
2. Search for **Alucify Intent Capture**
|
|
20
|
+
3. Enable **Intent Capture: Enabled**
|
|
21
|
+
|
|
22
|
+
Once enabled, Alucify periodically checks your recent Claude Code sessions and extracts anything relevant to your project.
|
|
23
|
+
|
|
24
|
+
## Running It Manually
|
|
25
|
+
|
|
26
|
+
You can trigger intent capture at any time from the Command Palette (`Cmd+Shift+P` / `Ctrl+Shift+P`):
|
|
27
|
+
|
|
28
|
+
- **Alucify: Capture Intent** — Extract intent from your recent sessions. Results are staged for review before being added to the AppGraph.
|
|
29
|
+
- **Alucify: Analyze Intent** — Capture intent and immediately integrate it into the AppGraph. Use this when you want to see results right away.
|
|
30
|
+
|
|
31
|
+
## What Happens After Capture
|
|
32
|
+
|
|
33
|
+
Extracted intent shows up in the AppGraph as new nodes or as annotations on existing nodes. You can explore them in the **AppGraph Visualizer** or see them reflected in your implementation status and coverage.
|
|
34
|
+
|
|
35
|
+
## CLI
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
alucify capture-intent # Extract from recent sessions
|
|
39
|
+
alucify capture-intent --force # Extract right now, don't wait
|
|
40
|
+
```
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 2
|
|
3
|
+
title: "Understanding Intent Capture"
|
|
4
|
+
description: "What intent capture extracts from your Claude Code sessions and how it appears in your AppGraph."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Understanding Intent Capture
|
|
8
|
+
|
|
9
|
+
## What Gets Captured
|
|
10
|
+
|
|
11
|
+
When you work in a Claude Code session, you naturally produce context that's valuable for your project: requirements you clarified with Claude, design decisions you made, edge cases you discussed, and features you decided to scope in or out.
|
|
12
|
+
|
|
13
|
+
Intent capture reads your session history and looks for this kind of project-level context — things that would be useful to have in your AppGraph alongside your specs and code analysis.
|
|
14
|
+
|
|
15
|
+
Examples of what gets captured:
|
|
16
|
+
- A requirement you refined or added during a session ("we decided authentication should support SSO")
|
|
17
|
+
- A design decision tied to specific code ("we're using optimistic updates for this component")
|
|
18
|
+
- A scope clarification that affects your specs ("out of scope for v1: batch imports")
|
|
19
|
+
|
|
20
|
+
Sessions that are only execution work — running commands, fixing syntax errors, iterating on output — are skipped.
|
|
21
|
+
|
|
22
|
+
## How It Appears in the AppGraph
|
|
23
|
+
|
|
24
|
+
Captured intent shows up in two ways:
|
|
25
|
+
|
|
26
|
+
- **New nodes** — If intent introduces a new requirement or feature not already in the AppGraph, a new node is created with an `intent` origin, so you can tell where it came from.
|
|
27
|
+
- **Annotations on existing nodes** — If intent relates to something already in the AppGraph, it's attached to that node as additional context.
|
|
28
|
+
|
|
29
|
+
You can filter by origin in the AppGraph Visualizer to see only intent-captured nodes.
|
|
30
|
+
|
|
31
|
+
## What It Doesn't Capture
|
|
32
|
+
|
|
33
|
+
Intent capture is selective — it's designed to surface project-level decisions, not a transcript of everything you discussed. It won't add:
|
|
34
|
+
- Code snippets or implementation details (those belong in the code itself)
|
|
35
|
+
- Back-and-forth troubleshooting that didn't produce a decision
|
|
36
|
+
- Context that's already reflected in your specs or AppGraph
|
|
37
|
+
|
|
38
|
+
## Privacy
|
|
39
|
+
|
|
40
|
+
Intent capture only reads local session files on your machine (`~/.claude/projects/`). Nothing is sent anywhere beyond the same Claude API calls your other Alucify workflows use. Captured intent is stored in `.alucify/extractions/intents/`, which you can commit or gitignore as you see fit.
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 1
|
|
3
|
+
title: "VS Code Extension Quick Start"
|
|
4
|
+
description: "Get up and running with the Alucify VS Code extension in under 5 minutes."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# VS Code Extension Quick Start
|
|
8
|
+
|
|
9
|
+
Get Alucify analyzing your project in just a few steps.
|
|
10
|
+
|
|
11
|
+
## 1. Install the Extension
|
|
12
|
+
|
|
13
|
+
Search for **Alucify** in the VS Code Extensions marketplace and click **Install**. See [Installing the Extension](installation.md) for details.
|
|
14
|
+
|
|
15
|
+
## 2. Open a Project
|
|
16
|
+
|
|
17
|
+
Open a project folder in VS Code. The Alucify icon will appear in your activity bar (left sidebar).
|
|
18
|
+
|
|
19
|
+
## 3. Complete the Welcome Setup
|
|
20
|
+
|
|
21
|
+
Click the Alucify icon to open the sidebar. The welcome screen walks you through two setup steps:
|
|
22
|
+
|
|
23
|
+
1. **Sign in to Alucify** — Create a free account or sign in to your existing one. Click **Sign Up / Sign In** to get started.
|
|
24
|
+
|
|
25
|
+
2. **Connect to Claude** — Choose how Alucify connects to Claude for AI analysis:
|
|
26
|
+
- **Claude Code Subscription** — Use your existing Claude Code or Claude Max subscription
|
|
27
|
+
- **Anthropic API Key** — Pay per token with your own API key
|
|
28
|
+
|
|
29
|
+
## 4. Analyze Your Code
|
|
30
|
+
|
|
31
|
+
Once setup is complete, you'll see the **Project Analysis** panel. Click the **Analyze Code** button to scan your codebase.
|
|
32
|
+
|
|
33
|
+
Choose an analysis mode:
|
|
34
|
+
- **Speed** — Fast mechanical analysis (5–10 minutes, no AI cost)
|
|
35
|
+
- **Balanced** — AI-powered analysis (15–60 minutes)
|
|
36
|
+
- **Quality** — Comprehensive analysis (45–90 minutes)
|
|
37
|
+
|
|
38
|
+
Wait for the analysis to complete. You'll see a progress indicator and can continue working while it runs.
|
|
39
|
+
|
|
40
|
+
## 5. Review Your Results
|
|
41
|
+
|
|
42
|
+
When analysis finishes, the **Code Analysis** tab shows:
|
|
43
|
+
- Your tech stack
|
|
44
|
+
- Lines of code
|
|
45
|
+
- Architecture health score
|
|
46
|
+
- AI coding risks (if any)
|
|
47
|
+
|
|
48
|
+
## 6. Add and Analyze Specs (Optional)
|
|
49
|
+
|
|
50
|
+
To compare your code against your requirements:
|
|
51
|
+
|
|
52
|
+
1. Click **Add Spec** in the **Specifications** panel to import your PRDs, design docs, or other spec files
|
|
53
|
+
2. Click **Analyze Specs** to run the comparison
|
|
54
|
+
3. Review the results in the **Spec Analysis** tab
|
|
55
|
+
|
|
56
|
+
## What's Next?
|
|
57
|
+
|
|
58
|
+
- [Understanding the Code Analysis Tab](code-analysis/understanding-the-code-analysis-tab.md)
|
|
59
|
+
- [Adding Specification Documents](spec-analysis/adding-specs.md)
|
|
60
|
+
- [Analyzing Implementation Progress](dev-progress/analyzing-commits.md)
|
|
@@ -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,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 [Spec Analysis tab](understanding-the-spec-analysis-tab.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**
|