@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,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 2
|
|
3
|
+
title: "Refining Specs in Chat"
|
|
4
|
+
description: "Using chat to resolve AI Coding Risks and improve specifications."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Refining Specs in Chat
|
|
8
|
+
|
|
9
|
+
Chat-based spec refinement is the fastest way to resolve an [AI Coding Risk](../../concepts/ai-coding-risks.md). Claude sees the risk context, the relevant spec, and the code — so you can have a focused conversation about the fix.
|
|
10
|
+
|
|
11
|
+
For the general concept of chat across Alucify, see [Chat Refinement](../../concepts/chat-refinement.md).
|
|
12
|
+
|
|
13
|
+
## Starting from a Risk
|
|
14
|
+
|
|
15
|
+
1. Open the [AI Coding Risks Panel](../code-analysis/ai-coding-risks-panel.md)
|
|
16
|
+
2. Click a risk to expand it
|
|
17
|
+
3. Click **Resolve via chat**
|
|
18
|
+
|
|
19
|
+
The Chat view opens in the secondary sidebar with the risk context loaded.
|
|
20
|
+
|
|
21
|
+
## Bulk Refinement
|
|
22
|
+
|
|
23
|
+
Select multiple risks via checkboxes and click **Refine Specs** at the top of the panel. Claude will see all selected risks together and work through them systematically.
|
|
24
|
+
|
|
25
|
+
## What Claude Sees
|
|
26
|
+
|
|
27
|
+
When you open refinement chat, the session pre-loads:
|
|
28
|
+
|
|
29
|
+
- The risk(s) you selected (type, severity, label, suggested action)
|
|
30
|
+
- The relevant spec content
|
|
31
|
+
- The connected code nodes
|
|
32
|
+
- Alucify's suggested solutions
|
|
33
|
+
|
|
34
|
+
This grounding prevents hallucination — Claude won't invent specs that don't exist or misquote code.
|
|
35
|
+
|
|
36
|
+
## Applying Suggestions
|
|
37
|
+
|
|
38
|
+
When Claude proposes a spec edit, an **Apply to spec** button appears next to the suggestion. Clicking it opens a diff view in VS Code so you can approve or modify the change before it's written.
|
|
39
|
+
|
|
40
|
+
## When Chat Isn't the Right Tool
|
|
41
|
+
|
|
42
|
+
- **If the fix is in code, not specs** — close the chat and edit the code directly, or use `/alucify-continue` in Claude Code to have an agent do it
|
|
43
|
+
- **If you're exploring, not fixing** — use [Ask About Your Project](asking-about-your-project.md) instead
|
|
44
|
+
|
|
45
|
+
## Session Persistence
|
|
46
|
+
|
|
47
|
+
Each refinement session is saved per-workspace and can be resumed later from the session switcher at the top of the chat panel.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{ "title": "Code Analysis", "order": 4 }
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 5
|
|
3
|
+
title: "AI Coding Risks Panel"
|
|
4
|
+
description: "How to view and interpret the AI Coding Risks panel in VS Code."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# AI Coding Risks Panel
|
|
8
|
+
|
|
9
|
+
For what AI Coding Risks are and what each risk type means, see [AI Coding Risks](../../concepts/ai-coding-risks.md).
|
|
10
|
+
|
|
11
|
+
## Opening the Panel
|
|
12
|
+
|
|
13
|
+
- From the Code Analysis tab, click **View Details** next to the AI Coding Risks section
|
|
14
|
+
- Or open the Command Palette and search for **Alucify: View AI Coding Risks**
|
|
15
|
+
|
|
16
|
+
## Reading a Risk Entry
|
|
17
|
+
|
|
18
|
+
Each risk in the list shows:
|
|
19
|
+
|
|
20
|
+
1. **Severity** — Color-coded dot indicating severity level
|
|
21
|
+
2. **Risk Type** — Category of the risk
|
|
22
|
+
3. **Label** — A brief description of the specific issue
|
|
23
|
+
4. **Action** — The recommended action to resolve it
|
|
24
|
+
|
|
25
|
+
## Exploring Solutions
|
|
26
|
+
|
|
27
|
+
Click on a risk to expand it and see solution options:
|
|
28
|
+
|
|
29
|
+
- **Recommended** — The solution Alucify suggests based on the analysis (marked with a badge)
|
|
30
|
+
- **Alternative options** — Other ways to address the issue
|
|
31
|
+
- Each solution shows its expected impact
|
|
32
|
+
|
|
33
|
+
## Resolving Risks
|
|
34
|
+
|
|
35
|
+
You have several options for each risk:
|
|
36
|
+
|
|
37
|
+
- **Resolve via chat** — Opens the [Refine Specs](../spec-analysis/refining-specs.md) chat to work with Claude on resolving the issue interactively
|
|
38
|
+
- **Ignore this issue** — Marks the risk as ignored if it's not relevant to your project
|
|
39
|
+
|
|
40
|
+
## Bulk Actions
|
|
41
|
+
|
|
42
|
+
You can select multiple risks using checkboxes and resolve them together using the **Refine Specs** button at the top of the panel.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 2
|
|
3
|
+
title: "Project Analysis Panel"
|
|
4
|
+
description: "A walkthrough of the Code Analysis tab in VS Code — metrics, codebase summary, and what each section means."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Project Analysis Panel
|
|
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](../../concepts/analysis-modes.md) was used: **Speed**, **Balanced**, or **Quality**.
|
|
22
|
+
|
|
23
|
+
## Architecture Health
|
|
24
|
+
|
|
25
|
+
If a technical debt analysis has been run, this section shows:
|
|
26
|
+
|
|
27
|
+
- **Health Score** — A 0–100 score with a letter grade (A–F) rating your architecture's structural health
|
|
28
|
+
- **View Details** link — Opens the full [Tech Debt Panel](tech-debt-panel.md)
|
|
29
|
+
|
|
30
|
+
## AI Coding Risks
|
|
31
|
+
|
|
32
|
+
If risks have been identified, this section shows a summary:
|
|
33
|
+
|
|
34
|
+
- **Risk count** — Total number of identified risks
|
|
35
|
+
- **Severity breakdown** — Count by severity level (Critical, High, Medium, Low)
|
|
36
|
+
- **View Details** link — Opens the full [AI Coding Risks Panel](ai-coding-risks-panel.md)
|
|
37
|
+
|
|
38
|
+
## Action Buttons
|
|
39
|
+
|
|
40
|
+
- **Analyze Code** — Appears when no baseline exists, or when code has changed since the last analysis. Click to run or re-run code analysis.
|
|
41
|
+
|
|
42
|
+
## Understanding Scores
|
|
43
|
+
|
|
44
|
+
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."
|
|
45
|
+
|
|
46
|
+
Click **Got it** to dismiss this card permanently.
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 1
|
|
3
|
+
title: "Analyzing Your Codebase"
|
|
4
|
+
description: "How to run code analysis to build a baseline understanding of your project."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Analyzing Your Codebase
|
|
8
|
+
|
|
9
|
+
Code analysis scans your project's source code to build a structured understanding of its architecture — what screens, logic, and data models exist.
|
|
10
|
+
|
|
11
|
+
## Running Code Analysis
|
|
12
|
+
|
|
13
|
+
1. Open the Alucify sidebar by clicking the Alucify icon in the activity bar
|
|
14
|
+
2. In the **Project Analysis** panel, click the **Analyze Code** button
|
|
15
|
+
3. Select an analysis mode:
|
|
16
|
+
- **Speed** — Optimized for speed, usually 5–10 minutes
|
|
17
|
+
- **Balanced** — Balances speed and quality, usually 15–60 minutes
|
|
18
|
+
- **Quality** — Optimized for quality, usually 45–90 minutes
|
|
19
|
+
4. Wait for the analysis to complete
|
|
20
|
+
|
|
21
|
+
A progress indicator shows the current phase. You can continue working in VS Code while the analysis runs.
|
|
22
|
+
|
|
23
|
+
## Choosing an Analysis Mode
|
|
24
|
+
|
|
25
|
+
See [Analysis Modes](../../concepts/analysis-modes.md) for a detailed comparison of the three modes.
|
|
26
|
+
|
|
27
|
+
As a general rule:
|
|
28
|
+
- Start with **Speed** to get quick results at no cost
|
|
29
|
+
- Use **Balanced** for most projects where you want AI-powered insights
|
|
30
|
+
- Use **Quality** for important analyses where thoroughness matters most
|
|
31
|
+
|
|
32
|
+
## Re-Analyzing After Code Changes
|
|
33
|
+
|
|
34
|
+
When your code changes after a previous analysis, the Code Analysis tab shows a message: "Code has changed since the last baseline was generated." Click **Analyze Code** again to update your baseline with the latest changes.
|
|
35
|
+
|
|
36
|
+
## What Happens During Analysis
|
|
37
|
+
|
|
38
|
+
During code analysis, Alucify:
|
|
39
|
+
|
|
40
|
+
1. Scans your source files to identify components, services, and data models
|
|
41
|
+
2. Maps dependencies and relationships between them
|
|
42
|
+
3. Detects your tech stack (frameworks, languages)
|
|
43
|
+
4. Counts lines of code
|
|
44
|
+
5. Saves a versioned snapshot of the analysis
|
|
45
|
+
|
|
46
|
+
When complete, the results appear in the [Project Analysis Panel](project-analysis-panel.md).
|
|
47
|
+
|
|
48
|
+
## Using the Command Palette
|
|
49
|
+
|
|
50
|
+
You can also start code analysis from the Command Palette:
|
|
51
|
+
|
|
52
|
+
1. Press `Ctrl+Shift+P` / `Cmd+Shift+P`
|
|
53
|
+
2. Search for **Alucify: Analyze Code**
|
|
54
|
+
3. Select your analysis mode
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 4
|
|
3
|
+
title: "Tech Debt Panel"
|
|
4
|
+
description: "How to view and interpret the Technical Debt Analysis panel in VS Code."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Tech Debt Panel
|
|
8
|
+
|
|
9
|
+
For what Tech Debt Analysis measures and how to read each dimension, see [Tech Debt Analysis](../../concepts/tech-debt-analysis.md).
|
|
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
|
+
## Layout
|
|
17
|
+
|
|
18
|
+
The panel shows the Architecture Health Score at top, four banner metrics below (Change Scope, Structural Risk, Debt Trend, plus a summary card), and six detail tabs:
|
|
19
|
+
|
|
20
|
+
- **Remediation** — priority actions to reduce debt
|
|
21
|
+
- **Change Scope** — visualization of change propagation
|
|
22
|
+
- **Structural Risk** — Fragility Index + score breakdown + stress attribution
|
|
23
|
+
- **Debt Trend** — forward-looking projection with trajectory graph
|
|
24
|
+
- **Complexity** — complexity hotspots by location
|
|
25
|
+
- **Outdated Packages** — dependency freshness
|
|
26
|
+
|
|
27
|
+
Each dimension is explained in [Tech Debt Analysis](../../concepts/tech-debt-analysis.md). Click any hotspot or component name to jump to the source file in your editor.
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 13
|
|
3
|
+
title: "Command Palette Reference"
|
|
4
|
+
description: "Every Alucify command you can invoke from the Command Palette in VS Code."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Command Palette Reference
|
|
8
|
+
|
|
9
|
+
Open the Command Palette with `Cmd+Shift+P` (macOS) or `Ctrl+Shift+P` (Windows/Linux), then type `Alucify` to filter.
|
|
10
|
+
|
|
11
|
+
## Analysis
|
|
12
|
+
|
|
13
|
+
| Command | What it does |
|
|
14
|
+
|---|---|
|
|
15
|
+
| **Alucify: Analyze Code** | Run baseline code analysis. [Docs](code-analysis/running-code-analysis.md) |
|
|
16
|
+
| **Alucify: Analyze Specs** | Analyze imported specs against code. [Docs](spec-analysis/analyzing-specs.md) |
|
|
17
|
+
| **Alucify: Add Spec** | Import a spec file. [Docs](spec-analysis/adding-specs.md) |
|
|
18
|
+
| **Alucify: Generate Spec** | Generate a new artifact from a template. [Docs](spec-analysis/generating-specs.md) |
|
|
19
|
+
| **Alucify: Refine Specs** | Open the chat to work on specific risks. [Docs](chat/refining-specs-in-chat.md) |
|
|
20
|
+
| **Alucify: Audit Specs** | Quality-check specs before analysis. [Docs](spec-analysis/auditing-specs.md) |
|
|
21
|
+
| **Alucify: Preview Specs** | Partial analysis for preview. [Docs](spec-analysis/filtering-and-browsing-specs.md) |
|
|
22
|
+
|
|
23
|
+
## Progress
|
|
24
|
+
|
|
25
|
+
| Command | What it does |
|
|
26
|
+
|---|---|
|
|
27
|
+
| **Alucify: Analyze Progress** | Track implementation status against commits. [Docs](dev-progress/analyzing-commits.md) |
|
|
28
|
+
| **Alucify: Analyze Commits** (advanced) | Manual commit-by-commit analysis |
|
|
29
|
+
| **Alucify: Analyze Intent** | Capture + integrate intent in one step. [Docs](intent-capture/analyzing-intent.md) |
|
|
30
|
+
| **Alucify: Capture Intent** | Capture only (no integration). [Docs](intent-capture/enabling-intent-capture.md) |
|
|
31
|
+
|
|
32
|
+
## Panels
|
|
33
|
+
|
|
34
|
+
| Command | What it does |
|
|
35
|
+
|---|---|
|
|
36
|
+
| **Alucify: Open AppGraph Visualizer** | Interactive graph view. [Docs](appgraph-visualizer/opening-the-visualizer.md) |
|
|
37
|
+
| **Alucify: View AI Coding Risks** | Full risks panel. [Docs](code-analysis/ai-coding-risks-panel.md) |
|
|
38
|
+
| **Alucify: View Technical Debt Analysis** | Full tech debt panel. [Docs](code-analysis/tech-debt-panel.md) |
|
|
39
|
+
| **Alucify: View Token Usage** | Token consumption panel. [Docs](token-usage/viewing-token-usage.md) |
|
|
40
|
+
|
|
41
|
+
## Versions (Advanced Mode)
|
|
42
|
+
|
|
43
|
+
| Command | What it does |
|
|
44
|
+
|---|---|
|
|
45
|
+
| **Alucify: Compare Versions** | Diff two snapshots. [Docs](versions/comparing-versions.md) |
|
|
46
|
+
| **Alucify: Switch Version** | Load an older version. [Docs](versions/switching-versions.md) |
|
|
47
|
+
| **Alucify: Delete Version** | Remove a snapshot. [Docs](versions/deleting-versions.md) |
|
|
48
|
+
|
|
49
|
+
## Authentication
|
|
50
|
+
|
|
51
|
+
| Command | What it does |
|
|
52
|
+
|---|---|
|
|
53
|
+
| **Alucify: Set Anthropic API Key** | Configure API key. [Docs](authentication/api-key-setup.md) |
|
|
54
|
+
| **Alucify: Sign In** | Auth0 login. [Docs](authentication/signing-in.md) |
|
|
55
|
+
| **Alucify: Logout** | Sign out |
|
|
56
|
+
| **Alucify: Switch Auth Mode** | API Key ↔ Claude Code. [Docs](authentication/switching-auth-modes.md) |
|
|
57
|
+
|
|
58
|
+
## Reset / Advanced Mode
|
|
59
|
+
|
|
60
|
+
| Command | What it does |
|
|
61
|
+
|---|---|
|
|
62
|
+
| **Alucify (Advanced): Reset Progress** | Clear implementation statuses. [Docs](dev-progress/progress-panel-actions.md#reset-progress) |
|
|
63
|
+
| **Alucify (Advanced): Reset Analysis** | Archive and start fresh. [Docs](resetting-analysis.md) |
|
|
64
|
+
| **Alucify (Advanced): Reset Extension** | Factory reset including auth. [Docs](advanced/reset-extension.md) |
|
|
65
|
+
| **Alucify (Advanced): Reset Welcome Screen** | Restore first-run onboarding |
|
|
66
|
+
|
|
67
|
+
## Advanced Analyses
|
|
68
|
+
|
|
69
|
+
Available only in [Advanced Mode](settings/advanced-mode.md):
|
|
70
|
+
|
|
71
|
+
| Command | What it does |
|
|
72
|
+
|---|---|
|
|
73
|
+
| **Alucify (Advanced): Analyze Congruency** | Spec-code alignment check. [Docs](advanced/congruency-analysis.md) |
|
|
74
|
+
| **Alucify (Advanced): Analyze Coverage** | Coverage gap check. [Docs](advanced/coverage-analysis.md) |
|
|
75
|
+
| **Alucify (Advanced): Analyze Impact** | Blast radius analysis. [Docs](advanced/impact-analysis.md) |
|
|
76
|
+
| **Alucify (Advanced): Analyze Findings** | Quality insight synthesis. [Docs](advanced/findings-synthesis.md) |
|
|
77
|
+
|
|
78
|
+
## Help & Feedback
|
|
79
|
+
|
|
80
|
+
| Command | What it does |
|
|
81
|
+
|---|---|
|
|
82
|
+
| **Alucify: Open Help** | Open this help browser |
|
|
83
|
+
| **Alucify: Send Feedback** | Send feedback to the Alucify team |
|
|
@@ -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,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 3
|
|
3
|
+
title: "Progress Panel Actions"
|
|
4
|
+
description: "Actions available on the Dev Progress panel — re-analyze, reset, filter."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Progress Panel Actions
|
|
8
|
+
|
|
9
|
+
The Dev Progress panel has several actions beyond just viewing status.
|
|
10
|
+
|
|
11
|
+
## Re-Analyze Progress
|
|
12
|
+
|
|
13
|
+
Triggers a fresh [`alucify analyze-progress`](../../cli/commands/analyze-progress.md) run against your current git state.
|
|
14
|
+
|
|
15
|
+
- **Command Palette** — **Alucify: Analyze Progress**
|
|
16
|
+
- **Dev Progress panel** — the **Re-analyze** button in the header
|
|
17
|
+
|
|
18
|
+
Use this if:
|
|
19
|
+
- You want to see changes that landed outside of a normal commit (e.g., a `git reset` or `cherry-pick`)
|
|
20
|
+
- The post-commit hook didn't fire
|
|
21
|
+
- You haven't run [`alucify enable`](../../cli/commands/enable-disable.md) and want to manually update progress
|
|
22
|
+
|
|
23
|
+
## Reset Progress
|
|
24
|
+
|
|
25
|
+
**Advanced Mode only.** Wipes all implementation status tracking and starts fresh. Does **not** delete specs, code analysis, or versions — only the per-node status fields.
|
|
26
|
+
|
|
27
|
+
- **Command Palette** — **Alucify: Reset Progress**
|
|
28
|
+
- **Advanced menu** — **Reset Progress**
|
|
29
|
+
|
|
30
|
+
When to use:
|
|
31
|
+
- You've significantly restructured specs and the old statuses are no longer meaningful
|
|
32
|
+
- You want to re-baseline progress from scratch
|
|
33
|
+
|
|
34
|
+
This doesn't undo existing commits or re-run analysis — it just clears the "implemented / in progress / tested" state so the next `analyze-progress` starts from zero.
|
|
35
|
+
|
|
36
|
+
## Filtering
|
|
37
|
+
|
|
38
|
+
The panel has filter controls at the top:
|
|
39
|
+
|
|
40
|
+
- **Status** — show only Planned / In Progress / Implemented / Tested
|
|
41
|
+
- **FunctionalArea** — narrow to a specific area
|
|
42
|
+
- **New since last version** — only items added or changed since the previous snapshot
|
|
43
|
+
|
|
44
|
+
## Jump to Node
|
|
45
|
+
|
|
46
|
+
Click any requirement name to jump to its node in the [AppGraph Visualizer](../appgraph-visualizer/opening-the-visualizer.md), where you can see dependencies, connected code, and test coverage.
|
|
47
|
+
|
|
48
|
+
## Export
|
|
49
|
+
|
|
50
|
+
**Export Progress Report** produces a Markdown summary suitable for pasting into a status doc or sprint review.
|
|
51
|
+
|
|
52
|
+
## See Also
|
|
53
|
+
|
|
54
|
+
- [Understanding the Dev Progress Tab](understanding-the-dev-progress-tab.md)
|
|
55
|
+
- [Analyzing Commits](analyzing-commits.md)
|
|
56
|
+
- [Implementation Progress](../../concepts/implementation-progress.md)
|
|
@@ -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,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 3
|
|
3
|
+
title: "Analyzing Intent"
|
|
4
|
+
description: "Running the full intent capture + integration pass in one step."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Analyzing Intent
|
|
8
|
+
|
|
9
|
+
The **Analyze Intent** command captures intent from recent Claude Code sessions *and* integrates it into your AppGraph in one step — so you can see the results immediately.
|
|
10
|
+
|
|
11
|
+
For what intent capture is, see [Intent Capture](../../concepts/intent-capture.md).
|
|
12
|
+
|
|
13
|
+
## Running It
|
|
14
|
+
|
|
15
|
+
- **Command Palette** — `Cmd+Shift+P` / `Ctrl+Shift+P` → **Alucify: Analyze Intent**
|
|
16
|
+
|
|
17
|
+
## What It Does (Two Phases)
|
|
18
|
+
|
|
19
|
+
### 1. Capture
|
|
20
|
+
Reads your recent Claude Code sessions from `~/.claude/projects/` and extracts project-level decisions, requirements, and design context. Captured intent is staged in `.alucify/extractions/intents/`.
|
|
21
|
+
|
|
22
|
+
### 2. Integrate
|
|
23
|
+
Merges the staged intent into your project AppGraph:
|
|
24
|
+
- New requirements become new FeatureSpec or AcceptanceCriterion nodes
|
|
25
|
+
- Decisions attached to existing nodes become annotations
|
|
26
|
+
- Origin is marked as `intent` so you can filter later
|
|
27
|
+
|
|
28
|
+
## `Analyze Intent` vs. `Capture Intent`
|
|
29
|
+
|
|
30
|
+
| Command | What it does | When to use |
|
|
31
|
+
|---|---|---|
|
|
32
|
+
| **Alucify: Capture Intent** | Extracts; stages for review | You want to review before integrating |
|
|
33
|
+
| **Alucify: Analyze Intent** | Extract + integrate in one go | You trust the capture; want results now |
|
|
34
|
+
|
|
35
|
+
For CLI equivalents, see [`alucify capture-intent`](../../cli/commands/capture-intent.md).
|
|
36
|
+
|
|
37
|
+
## When There's Nothing New
|
|
38
|
+
|
|
39
|
+
If no new intent is found (or no new sessions have run since last capture), the command exits quickly with a notification. Nothing is staged or integrated.
|
|
40
|
+
|
|
41
|
+
## Reviewing What Was Integrated
|
|
42
|
+
|
|
43
|
+
Open the [AppGraph Visualizer](../appgraph-visualizer/opening-the-visualizer.md) and filter by **Origin: Intent** to see the nodes and annotations added by intent capture.
|
|
44
|
+
|
|
45
|
+
You can also compare before/after with [Comparing Versions](../versions/comparing-versions.md) — select the last version before intent integration as the base.
|
|
46
|
+
|
|
47
|
+
## Turning It Off
|
|
48
|
+
|
|
49
|
+
If you don't want automatic captures, turn off **Intent Capture: Enabled** in settings (see [Enabling Intent Capture](enabling-intent-capture.md)). You can still run `Analyze Intent` manually.
|
|
@@ -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,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
|
+
- [Project Analysis Panel](code-analysis/project-analysis-panel.md)
|
|
59
|
+
- [Adding Specification Documents](spec-analysis/adding-specs.md)
|
|
60
|
+
- [Analyzing Implementation Progress](dev-progress/analyzing-commits.md)
|