@alucify/cli 0.6.5 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 6
|
|
3
|
+
title: "Auditing Imported Specs"
|
|
4
|
+
description: "How to run an audit on your imported specifications to check for quality and completeness."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Auditing Imported Specs
|
|
8
|
+
|
|
9
|
+
The spec audit checks the quality of your imported specifications before or after a full analysis.
|
|
10
|
+
|
|
11
|
+
## How to Audit Specs
|
|
12
|
+
|
|
13
|
+
1. Open the Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`)
|
|
14
|
+
2. Search for **Alucify: Audit Specs**
|
|
15
|
+
3. The audit runs against all imported specifications
|
|
16
|
+
|
|
17
|
+
## What the Audit Checks
|
|
18
|
+
|
|
19
|
+
The audit evaluates your specs for:
|
|
20
|
+
|
|
21
|
+
- **Completeness** — Are all necessary details present? Are there missing sections or undefined requirements?
|
|
22
|
+
- **Clarity** — Are requirements specific enough for an AI coding agent to implement?
|
|
23
|
+
- **Consistency** — Do specs use consistent terminology? Are there contradictions between documents?
|
|
24
|
+
- **Actionability** — Can each requirement be turned into a concrete implementation?
|
|
25
|
+
|
|
26
|
+
## When to Audit
|
|
27
|
+
|
|
28
|
+
- **After importing new specs** — Check that your documents are suitable for analysis before running full spec analysis
|
|
29
|
+
- **After refining specs** — Verify that changes improved quality
|
|
30
|
+
- **When AI readiness scores are low** — An audit can help identify which specs need improvement
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 3
|
|
3
|
+
title: "Filtering & Browsing the Specs Panel"
|
|
4
|
+
description: "How to filter, browse, and manage your imported specifications."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Filtering & Browsing the Specs Panel
|
|
8
|
+
|
|
9
|
+
The **Specifications** panel in the Alucify sidebar shows all your imported spec documents and their analysis status.
|
|
10
|
+
|
|
11
|
+
## Spec Lifecycle
|
|
12
|
+
|
|
13
|
+
Each spec goes through a lifecycle shown at the top of the panel:
|
|
14
|
+
|
|
15
|
+
1. **Pending** — The spec has been imported but not yet analyzed
|
|
16
|
+
2. **Analyzed** — The spec has been fully analyzed and integrated
|
|
17
|
+
|
|
18
|
+
Click on any status label to filter the list to specs in that state. The count next to each status shows how many specs are in that phase.
|
|
19
|
+
|
|
20
|
+
## Filtering Specs
|
|
21
|
+
|
|
22
|
+
### Using the Filter Button
|
|
23
|
+
|
|
24
|
+
1. Click the **Filter** icon (funnel) in the Specifications panel header
|
|
25
|
+
2. Choose a filter:
|
|
26
|
+
- **Show All** — Display all specs regardless of status
|
|
27
|
+
- **Pending** — Only show specs awaiting analysis
|
|
28
|
+
- **Analyzed** — Only show fully analyzed specs
|
|
29
|
+
|
|
30
|
+
### Clearing Filters
|
|
31
|
+
|
|
32
|
+
When a filter is active, the filter icon changes to indicate filtering is on. Click **Clear Filter** (filled funnel icon) to remove the filter and show all specs.
|
|
33
|
+
|
|
34
|
+
## Refreshing the List
|
|
35
|
+
|
|
36
|
+
Click the **Refresh** icon in the panel header to update the specs list. This is useful if you've added files to the `.alucify/artifacts/` directory outside of VS Code.
|
|
37
|
+
|
|
38
|
+
## Spec Actions
|
|
39
|
+
|
|
40
|
+
From the panel, you can:
|
|
41
|
+
|
|
42
|
+
- **Add Spec** — Import new specification documents
|
|
43
|
+
- **Generate Spec** — Create specs using AI (requires Claude Code CLI)
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 2
|
|
3
|
+
title: "Generating Specs with AI"
|
|
4
|
+
description: "How to use AI to generate specification documents from your codebase."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Generating Specs with AI
|
|
8
|
+
|
|
9
|
+
If you don't have existing specification documents, Alucify can help you generate them using AI.
|
|
10
|
+
|
|
11
|
+
## Prerequisites
|
|
12
|
+
|
|
13
|
+
- **Claude Code CLI** must be installed and authenticated on your machine
|
|
14
|
+
- The Generate Spec button only appears when the CLI is detected
|
|
15
|
+
|
|
16
|
+
## How to Generate a Spec
|
|
17
|
+
|
|
18
|
+
1. In the **Specifications** panel, click the **Generate Spec** button (wand icon)
|
|
19
|
+
2. Choose an artifact type from the picker:
|
|
20
|
+
- **Product Requirements Document** — Goals, personas, and functional requirements
|
|
21
|
+
- **Architecture Document** — Tech stack, system design, and architecture decisions
|
|
22
|
+
- **UX Specification** — User flows, screen designs, and interaction patterns
|
|
23
|
+
- **Epics & Stories** — Break down requirements into implementable work items
|
|
24
|
+
- **Quick Spec** — Lightweight technical spec for a focused task
|
|
25
|
+
- **Custom** — Describe any artifact you need
|
|
26
|
+
3. An interactive chat session opens in the sidebar
|
|
27
|
+
4. The AI uses your project context (if available) to draft the spec, and asks clarifying questions for anything it can't infer
|
|
28
|
+
|
|
29
|
+
The generated spec is saved to `.alucify/artifacts/` and automatically picked up by Alucify for analysis.
|
|
30
|
+
|
|
31
|
+
## Project Context
|
|
32
|
+
|
|
33
|
+
If you've run a baseline or artifact analysis, the AI will use your project's architecture, data models, requirements, and coverage gaps to pre-populate the spec. This means you don't have to re-describe what already exists — the AI starts from what it knows and asks only about what's missing.
|
|
34
|
+
|
|
35
|
+
For greenfield projects with no analysis, the AI guides you through each section step by step.
|
|
36
|
+
|
|
37
|
+
## When to Use This
|
|
38
|
+
|
|
39
|
+
- You have an existing codebase but no formal requirements documentation
|
|
40
|
+
- You want to create API specifications from existing endpoints
|
|
41
|
+
- You need to document existing business logic for AI coding agents
|
|
42
|
+
- You're starting a new feature and want a structured spec template
|
|
43
|
+
|
|
44
|
+
## Notes
|
|
45
|
+
|
|
46
|
+
- The generated spec is a starting point — review and refine it before running spec analysis
|
|
47
|
+
- You can also [add specs manually](adding-specs.md) if you prefer to write them yourself
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 7
|
|
3
|
+
title: "Refining Specs with Chat"
|
|
4
|
+
description: "How to use the interactive chat to refine and improve your specifications."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Refining Specs with Chat
|
|
8
|
+
|
|
9
|
+
After analyzing your specs and reviewing the identified risks, you can work with Claude interactively to resolve issues and improve your specifications.
|
|
10
|
+
|
|
11
|
+
## Starting a Refinement Session
|
|
12
|
+
|
|
13
|
+
### From the AI Coding Risks Panel
|
|
14
|
+
|
|
15
|
+
1. Open the [AI Coding Risks](../code-analysis/understanding-ai-coding-risks.md) panel
|
|
16
|
+
2. Select one or more risks using the checkboxes
|
|
17
|
+
3. Click the **Refine Specs** button (shows "Refine Specs (N selected)" with your selection count)
|
|
18
|
+
4. A chat panel opens in the secondary sidebar
|
|
19
|
+
|
|
20
|
+
### From the Command Palette
|
|
21
|
+
|
|
22
|
+
1. Press `Ctrl+Shift+P` / `Cmd+Shift+P`
|
|
23
|
+
2. Search for **Alucify: Refine Specs**
|
|
24
|
+
|
|
25
|
+
## Using the Chat
|
|
26
|
+
|
|
27
|
+
The chat panel opens with context about your selected risks. You can:
|
|
28
|
+
|
|
29
|
+
- **Discuss the risks** — Ask Claude about the issues and get suggestions
|
|
30
|
+
- **Review proposed changes** — Claude will suggest spec updates to resolve each risk
|
|
31
|
+
- **Guide the resolution** — Tell Claude how you want to address each issue
|
|
32
|
+
- **Type `/done`** to end the session
|
|
33
|
+
- **Type `/help`** to see available commands
|
|
34
|
+
|
|
35
|
+
As Claude resolves risks, their status updates from Open to Fixed in the AI Coding Risks panel.
|
|
36
|
+
|
|
37
|
+
## Chat Mode vs. Terminal Mode
|
|
38
|
+
|
|
39
|
+
Alucify supports two modes for spec refinement, configurable in settings:
|
|
40
|
+
|
|
41
|
+
### Chat Mode (Default)
|
|
42
|
+
An embedded chat panel in the VS Code secondary sidebar. You interact with Claude through a conversation interface, seeing messages, tool usage, and spec updates in real time.
|
|
43
|
+
|
|
44
|
+
### Terminal Mode
|
|
45
|
+
Uses the Claude Code CLI in a VS Code terminal. Progress is shown in the terminal output. This mode is useful if you prefer a CLI-based workflow.
|
|
46
|
+
|
|
47
|
+
To switch modes, go to VS Code Settings and search for `alucify.refineSpecs.mode`.
|
|
48
|
+
|
|
49
|
+
## Tips
|
|
50
|
+
|
|
51
|
+
- **Select related risks together** — Resolving related risks in a single session is more efficient than addressing them one at a time
|
|
52
|
+
- **Be specific** — Tell Claude how you want to resolve ambiguous issues rather than accepting all defaults
|
|
53
|
+
- **Review changes** — After a session, re-run spec analysis to verify that the refinements improved your scores
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 5
|
|
3
|
+
title: "Understanding the Spec Analysis Tab"
|
|
4
|
+
description: "A walkthrough of the Spec Analysis tab — congruency, coverage, completeness, and recommendations."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Understanding the Spec Analysis Tab
|
|
8
|
+
|
|
9
|
+
The Spec Analysis tab is the second of three tabs in the Project Analysis panel. It shows how well your specifications align with your codebase.
|
|
10
|
+
|
|
11
|
+
## Key Metrics
|
|
12
|
+
|
|
13
|
+
At the top of the tab, you'll see several scores (0–100%):
|
|
14
|
+
|
|
15
|
+
### Congruency
|
|
16
|
+
How well your specs align with your code. A high congruency score means your specs and code tell the same story — there are few contradictions or mismatches.
|
|
17
|
+
|
|
18
|
+
### Coverage
|
|
19
|
+
How much of your codebase is covered by specifications. High coverage means most components have corresponding requirements or specs.
|
|
20
|
+
|
|
21
|
+
### Blast Radius
|
|
22
|
+
The percentage of your project that could be affected by a change. Lower is better — it means changes are well-contained.
|
|
23
|
+
|
|
24
|
+
### AI Readiness
|
|
25
|
+
A composite score combining congruency, coverage, and other factors. This is the overall indicator of how prepared your project is for AI coding.
|
|
26
|
+
|
|
27
|
+
Each score includes a sparkline showing the trend across analysis versions.
|
|
28
|
+
|
|
29
|
+
## Sections
|
|
30
|
+
|
|
31
|
+
### Congruency
|
|
32
|
+
Shows a heatmap of how well each specification aligns with the codebase. Each row represents one of your imported specs. Click **View Details** to see the full congruency report for a specific spec.
|
|
33
|
+
|
|
34
|
+
### Coverage
|
|
35
|
+
Horizontal bars showing what percentage of each component type is grounded in specifications. Higher bars mean better spec coverage.
|
|
36
|
+
|
|
37
|
+
### Completeness
|
|
38
|
+
A visual indicator of how complete your specification coverage is across different dimensions.
|
|
39
|
+
|
|
40
|
+
### Impact
|
|
41
|
+
A pie chart showing how your project is distributed across impact categories:
|
|
42
|
+
- **New** — Components introduced by specs that don't exist in code yet
|
|
43
|
+
- **Modified** — Existing components that specs would change
|
|
44
|
+
- **Affected** — Components indirectly impacted by spec changes
|
|
45
|
+
- **Intact** — Components unaffected by spec changes
|
|
46
|
+
|
|
47
|
+
### AI Coding Risks
|
|
48
|
+
A summary of identified risks with severity counts. Click **View Details** to open the full [AI Coding Risks](../code-analysis/understanding-ai-coding-risks.md) panel.
|
|
49
|
+
|
|
50
|
+
### Recommendations
|
|
51
|
+
The top priority actions to improve your AI readiness score, ordered by impact. Click **View Details** to see the full list of recommendations.
|
|
52
|
+
|
|
53
|
+
## Empty State
|
|
54
|
+
|
|
55
|
+
If you haven't added or analyzed specs yet, the tab shows: "Please add specs and analyze them to update this tab." with links to add specs and run analysis.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{ "title": "Token Usage", "order": 7 }
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 2
|
|
3
|
+
title: "Understanding Token Usage"
|
|
4
|
+
description: "What tokens are, how they're categorized, and how to interpret your usage data."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Understanding Token Usage
|
|
8
|
+
|
|
9
|
+
## What Are Tokens?
|
|
10
|
+
|
|
11
|
+
Tokens are the unit of measurement for AI model input and output. Roughly, 1 token is about 4 characters of English text. Every interaction with Claude — whether through Alucify workflows or direct Claude Code sessions — consumes tokens.
|
|
12
|
+
|
|
13
|
+
## Token Types
|
|
14
|
+
|
|
15
|
+
Each API call produces four types of token usage:
|
|
16
|
+
|
|
17
|
+
### Output Tokens
|
|
18
|
+
Tokens generated by the model in its response (completions, code, analysis). This is typically the largest component of usage.
|
|
19
|
+
|
|
20
|
+
### Cache Read Tokens
|
|
21
|
+
Input tokens that were served from Claude's prompt cache rather than reprocessed. Cached tokens are significantly cheaper than regular input tokens (90% discount). Alucify uses prompt caching extensively to reduce costs.
|
|
22
|
+
|
|
23
|
+
### Cache Creation Tokens
|
|
24
|
+
Input tokens that were written to the prompt cache for the first time. These cost slightly more than regular input (25% premium) but enable cache reads on subsequent calls.
|
|
25
|
+
|
|
26
|
+
### Input Tokens (Non-cached)
|
|
27
|
+
Input tokens that were neither cached nor cache-eligible. This is typically a small number since Alucify enables caching on system prompts and large content blocks.
|
|
28
|
+
|
|
29
|
+
## Sources
|
|
30
|
+
|
|
31
|
+
Token usage comes from two distinct sources:
|
|
32
|
+
|
|
33
|
+
### Alucify
|
|
34
|
+
Tokens consumed by Alucify's analysis workflows — code analysis, spec analysis, progress tracking, congruency checks, etc. These are automated agent calls managed by Alucify. Each record includes the specific workflow, phase, and agent that consumed the tokens.
|
|
35
|
+
|
|
36
|
+
### Claude Code
|
|
37
|
+
Tokens consumed during your direct Claude Code sessions (CLI or IDE). These are your interactive coding sessions where you chat with Claude. Alucify reads the local session logs from `~/.claude/projects/` to track this usage. The two sources never overlap — Alucify's SDK calls use `persistSession: false` and don't appear in Claude Code logs.
|
|
38
|
+
|
|
39
|
+
## Models
|
|
40
|
+
|
|
41
|
+
Different models have different token costs:
|
|
42
|
+
- **Opus** — Most capable, highest per-token cost
|
|
43
|
+
- **Sonnet** — Balanced capability and cost (Alucify's default for most agents)
|
|
44
|
+
- **Haiku** — Fastest and cheapest (used by Alucify for template-driven extraction)
|
|
45
|
+
|
|
46
|
+
The "By Model" breakdown helps you understand which models are consuming the most tokens.
|
|
47
|
+
|
|
48
|
+
## Daily Average Comparison
|
|
49
|
+
|
|
50
|
+
The "This Week" and "Today" banner cards show a percentage comparing your current usage to your daily average. This helps you quickly spot whether today is a heavy or light usage day:
|
|
51
|
+
|
|
52
|
+
- **Orange (up arrow)** — Above your daily average by more than 10%
|
|
53
|
+
- **Green (down arrow)** — Below your daily average by more than 10%
|
|
54
|
+
- **"avg"** — Within 10% of your daily average
|
|
55
|
+
|
|
56
|
+
## Per-User Tracking
|
|
57
|
+
|
|
58
|
+
Every usage record is tagged with the git user email (`git config user.email`) of whoever triggered it. This enables per-user breakdowns in team environments. The token usage JSONL file is shared across the team (if committed), while the session reader state is per-user and gitignored.
|
|
59
|
+
|
|
60
|
+
## Data Storage
|
|
61
|
+
|
|
62
|
+
Token usage data is stored in `.alucify/token-usage/usage.jsonl` as an append-only log. Each line is a JSON record with all token counts, metadata, and timestamps. This file can be committed to version control for team visibility or gitignored for privacy — your choice.
|
|
63
|
+
|
|
64
|
+
Per-user reader state files (`.alucify/token-usage/state.*.json`) track which Claude Code sessions have been ingested. These are automatically gitignored.
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 1
|
|
3
|
+
title: "Viewing Token Usage"
|
|
4
|
+
description: "How to open the Token Usage panel and monitor your AI token consumption."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Viewing Token Usage
|
|
8
|
+
|
|
9
|
+
Alucify tracks all AI token consumption across your project — both from Alucify workflows (code analysis, spec analysis, progress tracking) and from your direct Claude Code sessions.
|
|
10
|
+
|
|
11
|
+
## Token Strip
|
|
12
|
+
|
|
13
|
+
At the top of the Project Analysis panel, a compact strip shows your total and today's token usage. Click anywhere on the strip to open the full Token Usage panel.
|
|
14
|
+
|
|
15
|
+
## Opening the Panel
|
|
16
|
+
|
|
17
|
+
- Click the **token strip** at the top of the Project Analysis panel
|
|
18
|
+
- Or open the Command Palette and search for **Alucify: View Token Usage**
|
|
19
|
+
|
|
20
|
+
## Banner Metrics
|
|
21
|
+
|
|
22
|
+
Four cards at the top of the panel provide a quick summary:
|
|
23
|
+
|
|
24
|
+
- **Total Tokens** — All-time token consumption across all sources
|
|
25
|
+
- **This Week** — Tokens used in the last 7 days, with a percentage showing how it compares to your daily average
|
|
26
|
+
- **Today** — Tokens used today, with a comparison to your daily average
|
|
27
|
+
- **Sessions** — Total number of Claude Code sessions and Alucify workflow runs
|
|
28
|
+
|
|
29
|
+
## Tabs
|
|
30
|
+
|
|
31
|
+
The panel has three tabs:
|
|
32
|
+
|
|
33
|
+
### Overview
|
|
34
|
+
|
|
35
|
+
A daily usage bar chart showing the last 30 days of token consumption, stacked by source (Alucify in cyan, Claude Code in orange). Below the chart, a daily breakdown table lists each active day with totals.
|
|
36
|
+
|
|
37
|
+
### Breakdowns
|
|
38
|
+
|
|
39
|
+
Six breakdown cards showing how tokens are distributed across different dimensions. Use the time period buttons (All Time, This Month, This Week, Today) to filter.
|
|
40
|
+
|
|
41
|
+
Cards include:
|
|
42
|
+
- **By Token Type** — Input, output, cache read, and cache creation tokens
|
|
43
|
+
- **By Source** — Alucify workflows vs direct Claude Code sessions
|
|
44
|
+
- **By Model** — Opus, Sonnet, Haiku
|
|
45
|
+
- **By User** — Per-user attribution (useful for teams)
|
|
46
|
+
- **By Branch** — Claude Code sessions grouped by git branch
|
|
47
|
+
- **By Workflow** — Alucify workflow types (baseline, artifact integration, etc.)
|
|
48
|
+
- **By Auth Mode** — SDK Runner vs API Runner (Alucify only)
|
|
49
|
+
|
|
50
|
+
### Activity
|
|
51
|
+
|
|
52
|
+
A sortable, filterable table of individual usage records. Each row shows the date, source, user, detail (workflow/phase or session ID), model, token counts, and duration. Use the dropdown filters to narrow by source, model, or user. Click any column header to sort.
|
|
53
|
+
|
|
54
|
+
## CLI
|
|
55
|
+
|
|
56
|
+
Run `alucify usage` in your terminal to see a summary of token usage. Add `--json` for machine-readable output.
|
|
57
|
+
|
|
58
|
+
## Automatic Updates
|
|
59
|
+
|
|
60
|
+
Token usage data updates automatically:
|
|
61
|
+
- **Alucify workflows** — recorded in real time as agents run
|
|
62
|
+
- **Claude Code sessions** — ingested from local session logs on extension activation and every 60 seconds while the extension is active
|
|
63
|
+
- **Git commits** — session data is refreshed on each commit (via the post-commit hook installed by `alucify enable`)
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 99
|
|
3
|
+
title: "Frequently Asked Questions"
|
|
4
|
+
description: "Answers to common questions about Alucify, its features, pricing, and usage."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Frequently Asked Questions
|
|
8
|
+
|
|
9
|
+
## General
|
|
10
|
+
|
|
11
|
+
### What is Alucify?
|
|
12
|
+
Alucify ensures your project is ready for AI coding by creating a unified, structured context and identifying potential gaps and issues to save you time and tokens. It analyzes your code and specifications, identifies risks, and gives AI coding agents like Claude Code the context they need to produce better implementations.
|
|
13
|
+
|
|
14
|
+
### Is Alucify free?
|
|
15
|
+
Alucify accounts are free. Analysis costs depend on the mode you choose:
|
|
16
|
+
- **Speed mode** is completely free — it uses mechanical analysis with no AI calls
|
|
17
|
+
- **Balanced** and **Quality** modes require Claude access (either a subscription or API key) and cost varies by project size
|
|
18
|
+
|
|
19
|
+
### What languages and frameworks does Alucify support?
|
|
20
|
+
Alucify supports TypeScript, JavaScript, Python, Java, Go, Rust, Ruby, C/C++, C#, Swift, Kotlin, and more. It works with popular frameworks including React, Next.js, Django, Rails, Spring Boot, and many others. See [Supported Project Types](getting-started/supported-project-types.md).
|
|
21
|
+
|
|
22
|
+
### Does Alucify send my code to the cloud?
|
|
23
|
+
Alucify uses Claude (Anthropic's AI) for analysis, which requires sending code context to the Anthropic API. However, all analysis results are stored locally in the `.alucify/` directory in your project. Speed mode runs entirely locally with no cloud calls.
|
|
24
|
+
|
|
25
|
+
## Extension
|
|
26
|
+
|
|
27
|
+
### Where do I find Alucify in VS Code?
|
|
28
|
+
After installing the extension, the Alucify icon appears in the activity bar (left sidebar). Click it to open the Alucify panel.
|
|
29
|
+
|
|
30
|
+
### I dismissed the welcome screen. How do I get it back?
|
|
31
|
+
In [Advanced Mode](vscode/settings/advanced-mode.md), open the Command Palette and run **Alucify (Advanced): Reset Welcome Screen**.
|
|
32
|
+
|
|
33
|
+
### How long does analysis take?
|
|
34
|
+
It depends on the analysis mode and your project size:
|
|
35
|
+
- **Speed** — 5–10 minutes
|
|
36
|
+
- **Balanced** — 15–60 minutes
|
|
37
|
+
- **Quality** — 45–90 minutes
|
|
38
|
+
|
|
39
|
+
You can continue working in VS Code while analysis runs in the background.
|
|
40
|
+
|
|
41
|
+
### Can I cancel a running analysis?
|
|
42
|
+
Yes. While an analysis is running, you can pause it using the pause button in the workflow status area, or clear it entirely.
|
|
43
|
+
|
|
44
|
+
### What file types can I import as specs?
|
|
45
|
+
PDFs, Markdown, plain text, images (PNG, JPG, SVG, etc.), JSON, YAML, TOML, XML, CSV, and code files. See [Supported Project Types](getting-started/supported-project-types.md) for the full list.
|
|
46
|
+
|
|
47
|
+
### What does the AI Readiness score mean?
|
|
48
|
+
AI Readiness is a composite score (0–100%) that summarizes how prepared your project is for AI coding. It factors in congruency (spec-code alignment), coverage (spec completeness), and other quality metrics. Higher scores mean AI agents are more likely to produce correct, aligned implementations.
|
|
49
|
+
|
|
50
|
+
### How do I update my API key?
|
|
51
|
+
Open the Command Palette and search for **Alucify: Set Anthropic API Key**. Enter your new key — it replaces the previous one securely.
|
|
52
|
+
|
|
53
|
+
## CLI
|
|
54
|
+
|
|
55
|
+
### How do I install the CLI?
|
|
56
|
+
Run `npm install -g alucify` for a global install, or use `npx alucify <command>` without installing. Requires Node.js 18+.
|
|
57
|
+
|
|
58
|
+
### Can I use the CLI without the VS Code extension?
|
|
59
|
+
Yes. The CLI is fully standalone and works independently of the extension. You can run all analysis, tracking, and integration commands from the terminal.
|
|
60
|
+
|
|
61
|
+
### What's the difference between `enable` and `mcp-install`?
|
|
62
|
+
`alucify enable` installs the full integration (MCP server, hooks, CLAUDE.md rules, git hook). `alucify mcp-install` installs only the MCP server for lightweight, read-only access. Use `enable` for the full experience; use `mcp-install` when you just want Claude Code to query existing analysis.
|
|
63
|
+
|
|
64
|
+
### How do I use the CLI in CI/CD?
|
|
65
|
+
Run analysis commands with explicit auth:
|
|
66
|
+
```bash
|
|
67
|
+
alucify analyze-code --mode catalog # Free, no auth needed
|
|
68
|
+
alucify analyze-specs --auth apiKey --api-key $ANTHROPIC_API_KEY
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## MCP Server
|
|
72
|
+
|
|
73
|
+
### What is the MCP server?
|
|
74
|
+
The MCP (Model Context Protocol) server gives Claude Code direct access to your project analysis. When enabled, Claude Code can search your project model, check impact of changes, find coverage gaps, and more — all without you having to manually provide context.
|
|
75
|
+
|
|
76
|
+
### How do I set up the MCP server?
|
|
77
|
+
The easiest way is `alucify enable`, which configures everything. See [Setting Up the MCP Server](mcp-server/setup.md) for all options.
|
|
78
|
+
|
|
79
|
+
### Does the MCP server modify my analysis data?
|
|
80
|
+
No. The MCP server is completely read-only. It queries your `.alucify/` data but never writes to it.
|
|
81
|
+
|
|
82
|
+
### Can my whole team use the MCP server?
|
|
83
|
+
Yes. If you commit the `.alucify/` directory (or at least `.alucify/mcp-server.js`) to your repository, team members can run `alucify enable` or `alucify mcp-install` to get MCP access without re-running analysis.
|
|
84
|
+
|
|
85
|
+
## Web UI & Desktop App
|
|
86
|
+
|
|
87
|
+
### How do I open the web UI?
|
|
88
|
+
Run `alucify ui` from the CLI — it starts a local server and opens your browser. See [Launching the Web UI](cli/ui/launching.md).
|
|
89
|
+
|
|
90
|
+
### Is the web UI the same as the desktop app?
|
|
91
|
+
The desktop app embeds the web UI. The functional content is identical; the desktop app adds native features: OS-level workspace picker, native menu bar, OS notifications, and single-instance app behavior. See [Desktop App](desktop/quickstart.md).
|
|
92
|
+
|
|
93
|
+
### Can I open the web UI from another machine?
|
|
94
|
+
No. The web server binds to `127.0.0.1` only. Use an SSH tunnel if you need remote access, or use the Desktop app locally.
|
|
95
|
+
|
|
96
|
+
### Do I need the CLI to run the desktop app?
|
|
97
|
+
No. The desktop app is a standalone installer (`.dmg`, `.exe`, `.AppImage`). It bundles everything it needs.
|
|
98
|
+
|
|
99
|
+
### Can I run the desktop app and the CLI web UI at the same time?
|
|
100
|
+
Yes. The desktop app binds its own port, and CLI `alucify ui` finds its own free port. You can run both side-by-side on different projects.
|
|
101
|
+
|
|
102
|
+
## Token Usage & Costs
|
|
103
|
+
|
|
104
|
+
### How do I see how many tokens I've used?
|
|
105
|
+
In the VS Code extension, look at the token strip at the top of the Project Analysis panel. Click it to open the full Token Usage panel with charts and breakdowns. From the CLI, run `alucify usage`.
|
|
106
|
+
|
|
107
|
+
### Does it track my Claude Code sessions?
|
|
108
|
+
Yes. Alucify reads Claude Code's local session logs (stored at `~/.claude/projects/`) to track token usage from your interactive coding sessions. This data stays on your machine.
|
|
109
|
+
|
|
110
|
+
### Where is token usage data stored?
|
|
111
|
+
In `.alucify/token-usage/usage.jsonl` as an append-only log. You can commit this file for team visibility or gitignore it for privacy. Per-user reader state files (`.alucify/token-usage/state.*.json`) are automatically gitignored.
|
|
112
|
+
|
|
113
|
+
### How far back does token history go?
|
|
114
|
+
On first activation, Alucify ingests all existing Claude Code session logs for the project. Alucify workflow usage is recorded from the first workflow run after the feature was enabled. If the JSONL file is deleted, Claude Code session history is automatically re-ingested on the next activation.
|
|
115
|
+
|
|
116
|
+
### Can multiple team members track their usage?
|
|
117
|
+
Yes. Every usage record includes the git user email. The shared `.alucify/token-usage/usage.jsonl` file contains records from all users, and the Token Usage panel can filter and break down by user.
|
|
118
|
+
|
|
119
|
+
## Data & Privacy
|
|
120
|
+
|
|
121
|
+
### Where is my analysis data stored?
|
|
122
|
+
All analysis data is stored locally in the `.alucify/` directory within your project. It's never uploaded to Alucify's servers.
|
|
123
|
+
|
|
124
|
+
### Can I opt out of telemetry?
|
|
125
|
+
Yes. Go to VS Code Settings, search for `alucify.telemetry`, and uncheck it. See [Telemetry & Privacy](vscode/settings/telemetry.md).
|
|
126
|
+
|
|
127
|
+
### Is my API key stored securely?
|
|
128
|
+
Yes. API keys are stored in VS Code's built-in secret storage, which encrypts credentials at rest. Keys are never written to disk in plain text or included in project files.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{ "title": "Getting Started", "order": 1 }
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 4
|
|
3
|
+
title: "Choosing a UI"
|
|
4
|
+
description: "Decision guide for picking the Alucify UI that fits your workflow."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Choosing a UI
|
|
8
|
+
|
|
9
|
+
Alucify ships four equal UIs. Most people use one or two. Here's how to pick.
|
|
10
|
+
|
|
11
|
+
## Quick Decision
|
|
12
|
+
|
|
13
|
+
| If you... | Use |
|
|
14
|
+
|---|---|
|
|
15
|
+
| ...live in VS Code | **VS Code Extension** |
|
|
16
|
+
| ...run commands in a terminal or CI | **CLI** |
|
|
17
|
+
| ...want a browser dashboard | **Web UI** (launched via `alucify ui`) |
|
|
18
|
+
| ...want a native app without installing VS Code | **Desktop App** |
|
|
19
|
+
|
|
20
|
+
You can use any combination. Many teams use VS Code Extension day-to-day + CLI in CI.
|
|
21
|
+
|
|
22
|
+
## Detailed Comparison
|
|
23
|
+
|
|
24
|
+
### VS Code Extension
|
|
25
|
+
- **Best for:** developers who already work in VS Code
|
|
26
|
+
- **Install:** one extension from the marketplace
|
|
27
|
+
- **Pros:** tightly integrated (status bar, tree views, command palette, in-editor jumps); works inline with Claude Code
|
|
28
|
+
- **Cons:** requires VS Code
|
|
29
|
+
|
|
30
|
+
### CLI
|
|
31
|
+
- **Best for:** scripting, CI/CD, pre-commit hooks, headless environments
|
|
32
|
+
- **Install:** `npm install -g @alucify/cli`
|
|
33
|
+
- **Pros:** scriptable, `--json` output for all reports, zero-GUI
|
|
34
|
+
- **Cons:** not a visual dashboard (though `alucify ui` starts the Web UI for you)
|
|
35
|
+
|
|
36
|
+
### Web UI
|
|
37
|
+
- **Best for:** browser-based review, sharing across the team (via shared `.alucify/`), or when you want a dashboard but don't need a native app
|
|
38
|
+
- **Install:** comes with the CLI; launch via `alucify ui`
|
|
39
|
+
- **Pros:** rich dashboards, chat panel, artifact drag-drop, browser-native UX
|
|
40
|
+
- **Cons:** requires CLI installed (can't run standalone)
|
|
41
|
+
|
|
42
|
+
### Desktop App
|
|
43
|
+
- **Best for:** a standalone native app without installing VS Code or managing a CLI
|
|
44
|
+
- **Install:** download and install a .dmg / .exe / .AppImage
|
|
45
|
+
- **Pros:** native look-and-feel, workspace picker, OS notifications, one-click install
|
|
46
|
+
- **Cons:** separate install from VS Code; no `--json` scripting
|
|
47
|
+
|
|
48
|
+
## Combining UIs
|
|
49
|
+
|
|
50
|
+
- **VS Code + CLI** — common for developer workstations. Use VS Code interactively; CLI in pre-commit hooks.
|
|
51
|
+
- **Desktop + CLI** — for non-VS-Code users who still want scripting. Use Desktop interactively; CLI for CI.
|
|
52
|
+
- **Web UI (via CLI) + MCP in Claude Code** — no IDE dependency; browser + Claude Code agent in a terminal.
|
|
53
|
+
|
|
54
|
+
## Feature Parity
|
|
55
|
+
|
|
56
|
+
Most features exist everywhere. For a complete matrix of what's where, see [UI Parity Matrix](../reference/ui-parity-matrix.md).
|
|
57
|
+
|
|
58
|
+
## Data Is Portable
|
|
59
|
+
|
|
60
|
+
All four UIs read from the same `.alucify/` directory in your project. You can switch UIs (or mix them) without losing analysis data.
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 6
|
|
3
|
+
title: "Your First Analysis"
|
|
4
|
+
description: "End-to-end walkthrough: analyze code, add specs, review risks."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Your First Analysis
|
|
8
|
+
|
|
9
|
+
A 15-minute walkthrough of Alucify's five-step workflow, using whichever UI you prefer.
|
|
10
|
+
|
|
11
|
+
For the concept, see [Workflow Overview](../concepts/workflow-overview.md).
|
|
12
|
+
|
|
13
|
+
## Before You Start
|
|
14
|
+
|
|
15
|
+
- Alucify installed (see [Installation](installation.md))
|
|
16
|
+
- Authentication set up (see [Authentication Modes](../concepts/authentication-modes.md))
|
|
17
|
+
- A project folder with some code in it (even a small demo works)
|
|
18
|
+
|
|
19
|
+
## Step 1 — Analyze Code
|
|
20
|
+
|
|
21
|
+
Run baseline code analysis. This scans your codebase and builds an [AppGraph](../concepts/appgraph.md) of your project's structure.
|
|
22
|
+
|
|
23
|
+
| UI | How |
|
|
24
|
+
|---|---|
|
|
25
|
+
| CLI | `alucify analyze-code --mode catalog` |
|
|
26
|
+
| VS Code | Click **Analyze Code** in the Alucify sidebar → pick mode |
|
|
27
|
+
| Web / Desktop | Dashboard → **Analyze Code** → pick mode |
|
|
28
|
+
|
|
29
|
+
Start with **Speed (catalog) mode** on your first run — it's free and takes ~5 minutes. You can re-analyze in a deeper mode later.
|
|
30
|
+
|
|
31
|
+
Result: you'll see your project's structure (interfaces, logic, schemas) plus a tech stack summary.
|
|
32
|
+
|
|
33
|
+
## Step 2 — Add Specs
|
|
34
|
+
|
|
35
|
+
Import at least one spec — a PRD, architecture doc, feature epic, or even a README. Any [supported format](../reference/file-types-and-formats.md#input-spec-artifacts).
|
|
36
|
+
|
|
37
|
+
| UI | How |
|
|
38
|
+
|---|---|
|
|
39
|
+
| CLI | `alucify add-spec docs/my-prd.md` |
|
|
40
|
+
| VS Code | Specs sidebar → **Add Spec** |
|
|
41
|
+
| Web / Desktop | Artifacts sidebar → drag-drop or **Add** |
|
|
42
|
+
|
|
43
|
+
## Step 3 — Analyze Specs
|
|
44
|
+
|
|
45
|
+
Now analyze the specs against your code.
|
|
46
|
+
|
|
47
|
+
| UI | How |
|
|
48
|
+
|---|---|
|
|
49
|
+
| CLI | `alucify analyze-specs --mode catalog` |
|
|
50
|
+
| VS Code | Specs sidebar → **Analyze** |
|
|
51
|
+
| Web / Desktop | Dashboard → **Analyze Specs** |
|
|
52
|
+
|
|
53
|
+
Result: scores for [congruency, coverage, completeness](../concepts/congruency-coverage-completeness.md), plus [AI Coding Risks](../concepts/ai-coding-risks.md) and recommendations.
|
|
54
|
+
|
|
55
|
+
## Step 4 — Review Risks
|
|
56
|
+
|
|
57
|
+
Open the AI Coding Risks panel to see what Alucify found.
|
|
58
|
+
|
|
59
|
+
| UI | How |
|
|
60
|
+
|---|---|
|
|
61
|
+
| CLI | `alucify status --json | jq '.risks'` |
|
|
62
|
+
| VS Code | **Alucify: View AI Coding Risks** |
|
|
63
|
+
| Web / Desktop | AI Coding Risks tab |
|
|
64
|
+
|
|
65
|
+
For each risk, you can:
|
|
66
|
+
- Open it to see suggested solutions
|
|
67
|
+
- Resolve via chat (refine the relevant spec with Claude)
|
|
68
|
+
- Mark as ignored if it's not relevant
|
|
69
|
+
|
|
70
|
+
## Step 5 — Plan & Track
|
|
71
|
+
|
|
72
|
+
With risks reviewed, plan your next work and track progress as commits land.
|
|
73
|
+
|
|
74
|
+
| UI | How |
|
|
75
|
+
|---|---|
|
|
76
|
+
| CLI | `alucify plan` (launches Claude Code) |
|
|
77
|
+
| VS Code | **Alucify: Plan** / Dev Progress tab |
|
|
78
|
+
| Web / Desktop | Requirements Progress tab → **Plan** |
|
|
79
|
+
|
|
80
|
+
If you run [`alucify enable`](../cli/commands/enable-disable.md), git hooks automatically track progress on each commit.
|
|
81
|
+
|
|
82
|
+
## What's Next
|
|
83
|
+
|
|
84
|
+
- **Switch to Balanced or Quality mode** for deeper analysis: see [Analysis Modes](../concepts/analysis-modes.md)
|
|
85
|
+
- **Enable Claude Code integration**: `alucify enable` wires up MCP + hooks + `/alucify-plan`
|
|
86
|
+
- **Invite your team**: commit `.alucify/` to share analysis history
|