@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,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 11
|
|
3
|
+
title: "Chat Panel"
|
|
4
|
+
description: "The embedded chat panel in the web UI — ask questions, refine specs, generate artifacts."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Chat Panel
|
|
8
|
+
|
|
9
|
+
The Chat Panel is a collapsible right-side panel that hosts multi-turn conversations with Claude grounded in your project.
|
|
10
|
+
|
|
11
|
+
For what chat can do across all UIs, see [Chat Refinement](../../concepts/chat-refinement.md).
|
|
12
|
+
|
|
13
|
+
## Opening the Panel
|
|
14
|
+
|
|
15
|
+
The panel is hidden by default when no chat session is active. Several actions open it:
|
|
16
|
+
|
|
17
|
+
- **Ask about Project** button on the Dashboard header
|
|
18
|
+
- **Resolve via chat** on an AI Coding Risk
|
|
19
|
+
- **Refine Specs** in bulk from the Risks tab
|
|
20
|
+
- **Generate** from the Artifacts sidebar
|
|
21
|
+
|
|
22
|
+
You can also click the chat toggle in the top-right of the web UI.
|
|
23
|
+
|
|
24
|
+
## Three Modes
|
|
25
|
+
|
|
26
|
+
Each mode has a different system context pre-loaded:
|
|
27
|
+
|
|
28
|
+
### Ask About Your Project
|
|
29
|
+
Free-form Q&A. Claude sees the AppGraph summary and can answer questions about structure, coverage, risks, and progress.
|
|
30
|
+
|
|
31
|
+
### Refine Specs
|
|
32
|
+
Focused on resolving one or more risks. Claude sees the risk context, the relevant spec, and the code.
|
|
33
|
+
|
|
34
|
+
### Generate Artifact
|
|
35
|
+
Claude drafts a new spec from a template and your description. You iterate with follow-ups.
|
|
36
|
+
|
|
37
|
+
## Chat Input
|
|
38
|
+
|
|
39
|
+
- **Text field** — your message
|
|
40
|
+
- **Attach** — add a file or image for context (for Generate mode especially)
|
|
41
|
+
- **Send** — submit
|
|
42
|
+
|
|
43
|
+
## Chat Output
|
|
44
|
+
|
|
45
|
+
Claude's responses render with:
|
|
46
|
+
- Syntax-highlighted code blocks
|
|
47
|
+
- Clickable references to AppGraph nodes (hover for details)
|
|
48
|
+
- "Apply to spec" actions for suggested spec edits (in Refine mode)
|
|
49
|
+
|
|
50
|
+
## Sessions
|
|
51
|
+
|
|
52
|
+
Chat sessions are stored per-workspace. You can resume a previous session from the session switcher at the top of the panel. Sessions are gitignored by default (`.alucify/chats/`).
|
|
53
|
+
|
|
54
|
+
## Relation to Claude Code
|
|
55
|
+
|
|
56
|
+
This chat is separate from Claude Code. To hand off to Claude Code for actual code edits, use the **Plan** button which invokes `/alucify-plan` in Claude Code. See [Using MCP with Claude Code](../../mcp-server/using-with-claude-code.md).
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 3
|
|
3
|
+
title: "Code Analysis Tab"
|
|
4
|
+
description: "The Code Analysis tab in the web UI — baseline metrics and scan results."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Code Analysis Tab
|
|
8
|
+
|
|
9
|
+
The Code Analysis tab shows the results of your codebase scan — structure, tech stack, and architecture summary.
|
|
10
|
+
|
|
11
|
+
For what analysis produces and how it works, see [Workflow Overview](../../concepts/workflow-overview.md) and [Analysis Modes](../../concepts/analysis-modes.md).
|
|
12
|
+
|
|
13
|
+
## Sections
|
|
14
|
+
|
|
15
|
+
### Codebase Summary
|
|
16
|
+
- **Lines of Code** — total, with an abbreviated display (`1.2M`, `301k`)
|
|
17
|
+
- **Tech Stack** — detected frameworks and languages as tag pills
|
|
18
|
+
- **Analysis Date** — when the baseline was last generated
|
|
19
|
+
|
|
20
|
+
### Analysis Mode
|
|
21
|
+
Which [mode](../../concepts/analysis-modes.md) was used — Speed, Balanced, or Quality.
|
|
22
|
+
|
|
23
|
+
### Architecture Health
|
|
24
|
+
Summary score (0–100 + letter grade) with a **View Details** link to the Tech Debt tab for the full breakdown. See [Tech Debt Tab](tech-debt-tab.md) and [Tech Debt Analysis](../../concepts/tech-debt-analysis.md).
|
|
25
|
+
|
|
26
|
+
### AI Coding Risks Summary
|
|
27
|
+
Risk count with severity breakdown. **View Details** opens the [AI Coding Risks Tab](ai-coding-risks-tab.md).
|
|
28
|
+
|
|
29
|
+
## Actions
|
|
30
|
+
|
|
31
|
+
- **Analyze Code** — run or re-run the baseline scan with a mode selector
|
|
32
|
+
- **View Full AppGraph** — open the [AppGraph Visualizer Tab](appgraph-visualizer-tab.md)
|
|
33
|
+
|
|
34
|
+
## When Code Has Changed
|
|
35
|
+
|
|
36
|
+
If your code has changed since the last baseline, Alucify shows a yellow banner: "Code has changed since last analysis — re-run to update." Incremental re-analysis only processes what changed.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 2
|
|
3
|
+
title: "Dashboard"
|
|
4
|
+
description: "The home view of the web UI — workflow status and quick actions."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Dashboard
|
|
8
|
+
|
|
9
|
+
The Dashboard is the home view you land on when you open the web UI. It gives you a snapshot of your project's analysis state and quick access to the main actions.
|
|
10
|
+
|
|
11
|
+
## Sections
|
|
12
|
+
|
|
13
|
+
### Workflow Status
|
|
14
|
+
Shows any in-progress or recently-finished workflow (code analysis, spec analysis, progress analysis). If a workflow is running, you'll see its current phase, a progress bar, and pause/resume/cancel controls.
|
|
15
|
+
|
|
16
|
+
### Metric Cards
|
|
17
|
+
Once you've run at least one analysis, the Dashboard shows high-level metrics:
|
|
18
|
+
- Lines of code
|
|
19
|
+
- Tech stack (detected languages and frameworks)
|
|
20
|
+
- [Congruency, Coverage, AI Readiness](../../concepts/congruency-coverage-completeness.md)
|
|
21
|
+
- Architecture health score
|
|
22
|
+
|
|
23
|
+
### Quick Actions
|
|
24
|
+
- **Analyze Code** — run or re-run code analysis
|
|
25
|
+
- **Analyze Specs** — run spec analysis (enabled once you have specs imported)
|
|
26
|
+
- **Add Specs** — opens the Artifacts sidebar for upload
|
|
27
|
+
|
|
28
|
+
## Navigation
|
|
29
|
+
|
|
30
|
+
The left sidebar has entries for each major view: Dashboard, Code Analysis, Tech Debt, AI Coding Risks, Requirements Progress, AppGraph Visualizer, Token Usage, Settings, Help.
|
|
31
|
+
|
|
32
|
+
## Workflow Controls
|
|
33
|
+
|
|
34
|
+
When a workflow is running, pause/resume/cancel buttons appear on the Dashboard. Pausing lets a long Quality-mode analysis wait while you free up API capacity or step away. Resuming picks up exactly where it left off.
|
|
35
|
+
|
|
36
|
+
## Empty State
|
|
37
|
+
|
|
38
|
+
Before your first analysis, the Dashboard shows an onboarding walkthrough with four step panels:
|
|
39
|
+
1. Analyze Code
|
|
40
|
+
2. Add Specs
|
|
41
|
+
3. Review Risks
|
|
42
|
+
4. Refine & Plan
|
|
43
|
+
|
|
44
|
+
Click any step to jump to that action.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 1
|
|
3
|
+
title: "Launching the Web UI"
|
|
4
|
+
description: "How to open the Alucify web UI — via CLI or embedded in the desktop app."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Launching the Web UI
|
|
8
|
+
|
|
9
|
+
The Alucify web UI is a browser-based dashboard that ships with the CLI. You can launch it in two ways.
|
|
10
|
+
|
|
11
|
+
## From the CLI
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
alucify ui
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
This starts a local server (default port 3000, falling back to the next free port) and opens your default browser to the UI.
|
|
18
|
+
|
|
19
|
+
Options:
|
|
20
|
+
```bash
|
|
21
|
+
alucify ui --port 4000 # pick a specific port
|
|
22
|
+
alucify ui --no-open # start the server, don't auto-open the browser
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
See the full command reference: [`alucify ui`](../commands/ui.md).
|
|
26
|
+
|
|
27
|
+
## From the Desktop App
|
|
28
|
+
|
|
29
|
+
If you're using the Alucify Desktop app, it launches its own copy of the web UI automatically inside its native window. You don't need to run `alucify ui` separately. See [Desktop Quickstart](../../desktop/quickstart.md).
|
|
30
|
+
|
|
31
|
+
## What Runs Where
|
|
32
|
+
|
|
33
|
+
- **Server** — starts in-process (on `localhost:<port>`), serves the UI and exposes REST + WebSocket endpoints
|
|
34
|
+
- **Browser** — loads the UI, connects over WebSocket for real-time workflow events
|
|
35
|
+
- **Auth** — a session token is generated on server start and included in the URL the browser opens
|
|
36
|
+
|
|
37
|
+
Only processes on your machine can connect. The server binds to `127.0.0.1` by default.
|
|
38
|
+
|
|
39
|
+
## Sharing a Session
|
|
40
|
+
|
|
41
|
+
You can't share the session URL with someone on another machine — the token is machine-local and the server only listens locally. For team collaboration, share the workspace's `.alucify/` directory via git; each teammate runs their own local UI against their checkout.
|
|
42
|
+
|
|
43
|
+
## Stopping the Server
|
|
44
|
+
|
|
45
|
+
- **CLI-launched:** Ctrl+C in the terminal stops the server
|
|
46
|
+
- **Desktop-launched:** the server stops automatically when you quit the desktop app
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 6
|
|
3
|
+
title: "Requirements Progress Tab"
|
|
4
|
+
description: "The Requirements Progress tab in the web UI — implementation status per requirement."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Requirements Progress Tab
|
|
8
|
+
|
|
9
|
+
The Requirements Progress tab shows how much of your spec is actually built. Each requirement from your specs is listed with its current implementation status and validation coverage.
|
|
10
|
+
|
|
11
|
+
For how statuses are determined, see [Implementation Progress](../../concepts/implementation-progress.md).
|
|
12
|
+
|
|
13
|
+
## Overall Progress Metric
|
|
14
|
+
|
|
15
|
+
At the top, a percentage bar shows "X% of requirements implemented" — a weighted average across all requirement nodes. Hover the bar for the breakdown by status (Planned / In Progress / Implemented / Tested).
|
|
16
|
+
|
|
17
|
+
## Requirements List
|
|
18
|
+
|
|
19
|
+
Each requirement shows:
|
|
20
|
+
|
|
21
|
+
- **Name** — the FeatureSpec or AcceptanceCriterion label
|
|
22
|
+
- **Status badge** — Planned / In Progress / Implemented / Tested / Deprecated
|
|
23
|
+
- **Validation coverage** — "3 of 5 acceptance criteria validated"
|
|
24
|
+
- **Gap notes** (for In Progress) — what's missing
|
|
25
|
+
|
|
26
|
+
Click a requirement to expand and see:
|
|
27
|
+
|
|
28
|
+
- Source file(s) backing the implementation
|
|
29
|
+
- Which tests validate it
|
|
30
|
+
- Commits that touched it recently
|
|
31
|
+
|
|
32
|
+
## Filters
|
|
33
|
+
|
|
34
|
+
- **By status** — focus on Planned or In Progress to see what's next
|
|
35
|
+
- **By area** — group by FunctionalArea
|
|
36
|
+
- **New since last version** — items added since the previous version snapshot
|
|
37
|
+
|
|
38
|
+
## Trigger Progress Analysis
|
|
39
|
+
|
|
40
|
+
Progress updates automatically on each commit if you've run `alucify enable` (it installs a post-commit hook). To manually trigger:
|
|
41
|
+
|
|
42
|
+
- Use the **Analyze Progress** button on this tab, or
|
|
43
|
+
- Run [`alucify analyze-progress`](../commands/analyze-progress.md) from the terminal
|
|
44
|
+
|
|
45
|
+
See [Integrations → Git Hooks](../../integrations/git-hooks.md).
|
|
46
|
+
|
|
47
|
+
## Planning Against Gaps
|
|
48
|
+
|
|
49
|
+
The top of the tab shows a **Plan** button that launches Claude Code with `/alucify-plan` — ready to plan work against currently-open requirements. See [`alucify plan`](../commands/plan.md).
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 9
|
|
3
|
+
title: "Settings Tab"
|
|
4
|
+
description: "The Settings tab in the web UI — authentication, notifications, telemetry."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Settings Tab
|
|
8
|
+
|
|
9
|
+
The Settings tab is where you manage authentication, notification preferences, telemetry, and other options that apply to the web UI and the desktop app.
|
|
10
|
+
|
|
11
|
+
## Authentication
|
|
12
|
+
|
|
13
|
+
- **Current mode** — Claude Code subscription or API Key (see [Authentication Modes](../../concepts/authentication-modes.md))
|
|
14
|
+
- **Switch mode** — change between them
|
|
15
|
+
- **Sign in / Sign out** (OAuth mode) — manage your session
|
|
16
|
+
- **API key** (API Key mode) — paste, update, or clear your key
|
|
17
|
+
|
|
18
|
+
## Workspace (Desktop only)
|
|
19
|
+
|
|
20
|
+
- **Current workspace** — path to the project folder
|
|
21
|
+
- **Switch workspace** — opens the file picker
|
|
22
|
+
- **Reset workspace** — archive analysis and start fresh
|
|
23
|
+
|
|
24
|
+
## Notifications
|
|
25
|
+
|
|
26
|
+
- **OS notifications** — toggle native notifications on/off (see [Notifications](../../desktop/notifications.md))
|
|
27
|
+
- **Sound** (if OS-supported) — play a sound on completion
|
|
28
|
+
|
|
29
|
+
## Analysis Preferences
|
|
30
|
+
|
|
31
|
+
- **Default analysis mode** — Speed / Balanced / Quality ([Analysis Modes](../../concepts/analysis-modes.md))
|
|
32
|
+
- **Auto-trigger spec analysis on artifact upload** — when you add a spec, analyze immediately
|
|
33
|
+
|
|
34
|
+
## Integrations
|
|
35
|
+
|
|
36
|
+
- **MCP Server** — enable or disable the Claude Code integration. See [Claude Code Integration](../../integrations/claude-code.md).
|
|
37
|
+
- **Git hooks** — status of pre-commit and post-commit hooks. See [Git Hooks](../../integrations/git-hooks.md).
|
|
38
|
+
|
|
39
|
+
## Telemetry
|
|
40
|
+
|
|
41
|
+
- **Anonymous usage telemetry** — toggle on/off. When on, Alucify sends anonymous usage events (no code, no specs, no credentials). See [Telemetry](../../vscode/settings/telemetry.md) for what's collected.
|
|
42
|
+
|
|
43
|
+
## Advanced
|
|
44
|
+
|
|
45
|
+
- **Show advanced features** — reveal hidden options (version switching, reset analysis, etc.)
|
|
46
|
+
- **Developer mode** — enables developer panels and detailed logs
|
|
47
|
+
|
|
48
|
+
## About
|
|
49
|
+
|
|
50
|
+
- Alucify version
|
|
51
|
+
- Server status
|
|
52
|
+
- Link to send feedback
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 4
|
|
3
|
+
title: "Tech Debt Tab"
|
|
4
|
+
description: "The Tech Debt Analysis tab in the web UI — structural health details."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Tech Debt Tab
|
|
8
|
+
|
|
9
|
+
The Tech Debt tab surfaces architectural health signals: how coupled your code is, where complexity lives, and which packages are outdated.
|
|
10
|
+
|
|
11
|
+
For what each metric means, see [Tech Debt Analysis](../../concepts/tech-debt-analysis.md).
|
|
12
|
+
|
|
13
|
+
## Layout
|
|
14
|
+
|
|
15
|
+
- **Architecture Health Score** at the top (0–100 with letter grade)
|
|
16
|
+
- **Four banner metrics**: Change Scope, Structural Risk, Debt Trend, plus a summary card
|
|
17
|
+
- **Six detail tabs**: Remediation, Change Scope, Structural Risk, Debt Trend, Complexity, Outdated Packages
|
|
18
|
+
|
|
19
|
+
## Interacting with Hotspots
|
|
20
|
+
|
|
21
|
+
Click any component or file name in the tab to open it in your editor (browser limits this to opening a local file URL — your OS handles the handoff). In the Desktop app, clicking opens the file in your default editor.
|
|
22
|
+
|
|
23
|
+
## Generating Tech Debt Analysis
|
|
24
|
+
|
|
25
|
+
Tech Debt Analysis runs automatically during code analysis in Balanced and Quality modes. Speed mode doesn't produce tech debt data — if you only ran Speed, this tab will be empty until you re-run in a deeper mode.
|
|
26
|
+
|
|
27
|
+
## Refreshing
|
|
28
|
+
|
|
29
|
+
The data on this tab comes from the most recent code analysis. To refresh, re-run Analyze Code from the [Dashboard](dashboard.md) or the [Code Analysis Tab](code-analysis-tab.md).
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 8
|
|
3
|
+
title: "Token Usage Tab"
|
|
4
|
+
description: "The Token Usage tab in the web UI — spend tracking by source, model, and session."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Token Usage Tab
|
|
8
|
+
|
|
9
|
+
The Token Usage tab shows your Claude token consumption across Alucify workflows and Claude Code sessions.
|
|
10
|
+
|
|
11
|
+
For what the different token types mean, see [Token Usage](../../concepts/token-usage.md).
|
|
12
|
+
|
|
13
|
+
## Header Strip
|
|
14
|
+
|
|
15
|
+
A compact strip at the top of the tab (and visible on every page header in the web UI) shows:
|
|
16
|
+
|
|
17
|
+
- **Total tokens** — lifetime consumption
|
|
18
|
+
- **This week** — last 7 days, with a delta vs. your daily average
|
|
19
|
+
- **Today** — today's usage, with a delta vs. average
|
|
20
|
+
- **Sessions** — number of distinct Claude Code or Alucify sessions
|
|
21
|
+
|
|
22
|
+
## Three Sub-Tabs
|
|
23
|
+
|
|
24
|
+
### Overview
|
|
25
|
+
A daily chart of token consumption over time. Hover any bar for that day's detail.
|
|
26
|
+
|
|
27
|
+
### Breakdowns
|
|
28
|
+
Token usage split by different dimensions:
|
|
29
|
+
- **By source** — Alucify workflows vs. Claude Code sessions
|
|
30
|
+
- **By model** — Opus vs. Sonnet vs. Haiku
|
|
31
|
+
- **By workflow** — Code analysis vs. Spec analysis vs. etc.
|
|
32
|
+
- **By agent** — which extractor/analyzer consumed the tokens
|
|
33
|
+
- **By user** — git user emails, if you're on a team
|
|
34
|
+
- **By artifact** — which specs drove the most usage
|
|
35
|
+
- **By phase** — workflow phases
|
|
36
|
+
|
|
37
|
+
### Activity
|
|
38
|
+
Chronological table of every LLM call. Filter by source, model, date range, or user. Click a row for the full record.
|
|
39
|
+
|
|
40
|
+
## Data Storage
|
|
41
|
+
|
|
42
|
+
Token usage is stored as an append-only JSONL log at `.alucify/token-usage/usage.jsonl`. It's safe to commit for team visibility or gitignore for privacy. See [Alucify Directory Structure](../../reference/alucify-directory.md).
|
|
43
|
+
|
|
44
|
+
## Export
|
|
45
|
+
|
|
46
|
+
Use the **Export** button to download filtered usage data as CSV or JSON for external analysis or billing reconciliation.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{ "title": "Concepts", "order": 2 }
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 6
|
|
3
|
+
title: "AI Coding Risks"
|
|
4
|
+
description: "What AI Coding Risks are — risk types, severity levels, and what each category means."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# AI Coding Risks
|
|
8
|
+
|
|
9
|
+
AI Coding Risks are issues Alucify identifies that could cause problems when AI coding agents work on your project. Resolving these risks before handing work to an AI agent helps ensure better, more aligned implementations.
|
|
10
|
+
|
|
11
|
+
For UI-specific instructions on viewing and resolving risks, see:
|
|
12
|
+
- VS Code: [AI Coding Risks Panel](../vscode/code-analysis/ai-coding-risks-panel.md)
|
|
13
|
+
- Web UI: [AI Coding Risks Tab](../cli/ui/ai-coding-risks-tab.md)
|
|
14
|
+
|
|
15
|
+
## Severity Levels
|
|
16
|
+
|
|
17
|
+
Each risk has a severity level:
|
|
18
|
+
|
|
19
|
+
- **Critical** (red) — Issues that will very likely cause incorrect AI implementations
|
|
20
|
+
- **High** (orange) — Significant issues that frequently lead to problems
|
|
21
|
+
- **Medium** (yellow) — Moderate issues that may cause occasional problems
|
|
22
|
+
- **Low** (blue) — Minor issues worth addressing when convenient
|
|
23
|
+
|
|
24
|
+
## Risk Types
|
|
25
|
+
|
|
26
|
+
Alucify identifies several categories of risk:
|
|
27
|
+
|
|
28
|
+
- **Missing UX Spec** — A screen or UI component exists in code but has no corresponding specification
|
|
29
|
+
- **Missing Data Spec** — A data model exists in code but has no corresponding specification
|
|
30
|
+
- **Missing Logic Spec** — Business logic exists in code but has no corresponding specification
|
|
31
|
+
- **Missing Acceptance Criteria** — Requirements exist without clear criteria for what "done" looks like
|
|
32
|
+
- **Requirements Gap** — Specs reference functionality that doesn't exist in code
|
|
33
|
+
- **Conflict** — Contradictions between different specs, or between specs and code
|
|
34
|
+
- **Naming Issue** — Inconsistent terminology between specs and code
|
|
35
|
+
- **Structural Issue** — Architectural problems that could confuse AI agents
|
|
36
|
+
- **High Blast Radius** — Changes to this area affect many other parts of the system. See [Blast Radius](blast-radius.md).
|
|
37
|
+
- **Domain Gap** — Missing domain knowledge that an AI agent would need
|
|
38
|
+
- **Duplicate** — The same concept is defined in multiple places
|
|
39
|
+
|
|
40
|
+
## Risk Status
|
|
41
|
+
|
|
42
|
+
Risks can have three statuses:
|
|
43
|
+
|
|
44
|
+
- **Open** — Not yet addressed
|
|
45
|
+
- **Fixed** — Resolved, with details about what was changed and when
|
|
46
|
+
- **Ignored** — Marked as not relevant
|
|
47
|
+
|
|
48
|
+
## How Risks Are Generated
|
|
49
|
+
|
|
50
|
+
Risks are produced during spec analysis as the final synthesis step after congruency, coverage, and completeness checks. See [Congruency, Coverage & Completeness](congruency-coverage-completeness.md).
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 8
|
|
3
|
+
title: "AI Readiness"
|
|
4
|
+
description: "The composite score that tells you how prepared your project is for AI coding agents."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# AI Readiness
|
|
8
|
+
|
|
9
|
+
AI Readiness is a 0–100% composite score that tells you how well-prepared your project is for an AI coding agent to work on it effectively. Higher readiness means an AI agent (or a human using one) will make fewer mistakes, need less back-and-forth, and produce implementations that match intent.
|
|
10
|
+
|
|
11
|
+
## What Goes Into the Score
|
|
12
|
+
|
|
13
|
+
AI Readiness combines:
|
|
14
|
+
|
|
15
|
+
- [**Congruency**](congruency-coverage-completeness.md#congruency) — Do specs and code agree?
|
|
16
|
+
- [**Coverage**](congruency-coverage-completeness.md#coverage) — Is most of the code backed by specs?
|
|
17
|
+
- [**Completeness**](congruency-coverage-completeness.md#completeness) — Are specs thorough enough to act on?
|
|
18
|
+
- **Risk density** — How many [AI Coding Risks](ai-coding-risks.md) remain open, weighted by severity?
|
|
19
|
+
- **Architectural health** — Structural debt signals from [Tech Debt Analysis](tech-debt-analysis.md)
|
|
20
|
+
|
|
21
|
+
## How to Improve Your Score
|
|
22
|
+
|
|
23
|
+
The single best lever depends on where you're weakest. Each UI shows recommendations ranked by expected impact:
|
|
24
|
+
|
|
25
|
+
- **Low Coverage** → Add specs for the code areas that have none. Alucify tells you which ones.
|
|
26
|
+
- **Low Congruency** → Resolve conflicts and naming issues between specs and code.
|
|
27
|
+
- **Low Completeness** → Fill out acceptance criteria and data model details in your specs.
|
|
28
|
+
- **High Risk Density** → Work through the AI Coding Risks panel, highest severity first.
|
|
29
|
+
|
|
30
|
+
## Trend Tracking
|
|
31
|
+
|
|
32
|
+
Every version snapshot records your AI Readiness score. The sparkline next to the score shows your trend across recent analyses — a quick signal of whether your project is getting more or less ready over time.
|
|
33
|
+
|
|
34
|
+
See [Versions & Snapshots](versions-and-snapshots.md).
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 2
|
|
3
|
+
title: "Analysis Modes"
|
|
4
|
+
description: "The three analysis depth modes — when to use each and what they produce."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Analysis Modes
|
|
8
|
+
|
|
9
|
+
Alucify offers three analysis modes that trade off speed, cost, and depth. You pick a mode each time you run code analysis or spec analysis, regardless of which UI you're using — CLI (`--mode`), VS Code extension (dropdown), or web app (selector).
|
|
10
|
+
|
|
11
|
+
## Speed (Catalog Mode)
|
|
12
|
+
|
|
13
|
+
- **Time:** Usually 5–10 minutes
|
|
14
|
+
- **Cost:** Free — no AI calls
|
|
15
|
+
- **How it works:** Uses mechanical analysis (AST parsing and static analysis) to extract your project's structure. No AI model is involved.
|
|
16
|
+
- **Best for:** Getting a quick overview, initial exploration, or when you want to minimize costs
|
|
17
|
+
|
|
18
|
+
**What you get:**
|
|
19
|
+
- Project structure (interfaces, logic, schemas)
|
|
20
|
+
- Tech stack detection
|
|
21
|
+
- Lines of code count
|
|
22
|
+
- Basic dependency mapping
|
|
23
|
+
|
|
24
|
+
## Balanced (Fast Mode)
|
|
25
|
+
|
|
26
|
+
- **Time:** Usually 15–60 minutes
|
|
27
|
+
- **Cost:** Moderate (uses Claude Sonnet)
|
|
28
|
+
- **How it works:** Combines mechanical analysis with AI-powered extraction for deeper understanding. Uses Claude Sonnet for cost-efficient analysis.
|
|
29
|
+
- **Best for:** Most projects — the recommended default for a good balance of insight and cost
|
|
30
|
+
|
|
31
|
+
**What you get:**
|
|
32
|
+
- Everything in Speed mode, plus:
|
|
33
|
+
- AI-powered classification of components
|
|
34
|
+
- Congruency analysis (when running spec analysis)
|
|
35
|
+
- Richer dependency understanding
|
|
36
|
+
|
|
37
|
+
## Quality (Full Mode)
|
|
38
|
+
|
|
39
|
+
- **Time:** Usually 45–90 minutes
|
|
40
|
+
- **Cost:** Higher (uses Claude Opus for comprehensive analysis)
|
|
41
|
+
- **How it works:** Full multi-pass AI analysis with all checks enabled. Uses Claude Opus for maximum accuracy and depth.
|
|
42
|
+
- **Best for:** Important analyses where thoroughness matters, such as before a major release or when onboarding a new AI coding agent to a complex project
|
|
43
|
+
|
|
44
|
+
**What you get:**
|
|
45
|
+
- Everything in Balanced mode, plus:
|
|
46
|
+
- Semantic extraction with deeper understanding
|
|
47
|
+
- Comprehensive relationship mapping
|
|
48
|
+
- Holistic congruency analysis across all specs
|
|
49
|
+
|
|
50
|
+
## Choosing a Mode
|
|
51
|
+
|
|
52
|
+
| Consideration | Speed | Balanced | Quality |
|
|
53
|
+
|---------------|-------|----------|---------|
|
|
54
|
+
| Time | 5–10 min | 15–60 min | 45–90 min |
|
|
55
|
+
| AI Cost | Free | Moderate | Higher |
|
|
56
|
+
| Depth | Surface-level | Good | Comprehensive |
|
|
57
|
+
| Best for | Quick overview | Day-to-day use | Critical analysis |
|
|
58
|
+
|
|
59
|
+
**Tip:** You can start with Speed mode to get quick results, then re-analyze in Balanced or Quality mode when you need deeper insights. Each analysis creates a new version, so you don't lose previous results.
|
|
60
|
+
|
|
61
|
+
## Selecting a Mode
|
|
62
|
+
|
|
63
|
+
See your UI's docs for where the mode selector lives:
|
|
64
|
+
- **CLI:** [`alucify analyze-code --mode`](../cli/commands/analyze-code.md)
|
|
65
|
+
- **VS Code:** [Running Code Analysis](../vscode/code-analysis/running-code-analysis.md)
|
|
66
|
+
- **Web UI:** [Code Analysis Tab](../cli/ui/code-analysis-tab.md)
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 3
|
|
3
|
+
title: "The AppGraph"
|
|
4
|
+
description: "The structured model of your project that Alucify builds and queries."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# The AppGraph
|
|
8
|
+
|
|
9
|
+
The AppGraph is Alucify's structured model of your project. It's a graph of **nodes** (things in your project) and **edges** (relationships between them). Everything Alucify does — congruency scoring, coverage analysis, progress tracking, risk detection — operates on the AppGraph.
|
|
10
|
+
|
|
11
|
+
## Nodes
|
|
12
|
+
|
|
13
|
+
Each node represents one distinct thing in your project. Common node types:
|
|
14
|
+
|
|
15
|
+
- **FunctionalArea** — A top-level feature area (e.g., "Authentication", "Payments")
|
|
16
|
+
- **FeatureSpec** — A specific feature or user-facing capability
|
|
17
|
+
- **AcceptanceCriterion** — A testable condition for a feature
|
|
18
|
+
- **Interface** — A UI screen or view
|
|
19
|
+
- **Logic** — Business logic (function, class, or module)
|
|
20
|
+
- **Schema** — Data model (table, type, entity)
|
|
21
|
+
- **Validation** — A test or verification
|
|
22
|
+
|
|
23
|
+
Each node carries metadata (name, description, source files, status) and grounding evidence that points back to where it came from.
|
|
24
|
+
|
|
25
|
+
## Edges
|
|
26
|
+
|
|
27
|
+
Edges describe how nodes relate:
|
|
28
|
+
|
|
29
|
+
- **parent_of** — Hierarchy (FunctionalArea → FeatureSpec)
|
|
30
|
+
- **implements** — A Logic node implements a FeatureSpec
|
|
31
|
+
- **validates** — A Validation verifies an AcceptanceCriterion
|
|
32
|
+
- **depends_on** — Runtime or code dependency
|
|
33
|
+
- **affects** — Change impact (used for [blast radius](blast-radius.md))
|
|
34
|
+
|
|
35
|
+
## Baseline vs. Project
|
|
36
|
+
|
|
37
|
+
Alucify maintains two AppGraphs:
|
|
38
|
+
|
|
39
|
+
- **Baseline AppGraph** — Built from code analysis alone. Reflects what exists in the codebase.
|
|
40
|
+
- **Project AppGraph** — Built by integrating specs into the baseline. Reflects what *should* exist according to your specs, with implementation status tracked per node.
|
|
41
|
+
|
|
42
|
+
## Versions
|
|
43
|
+
|
|
44
|
+
Every analysis creates a new versioned snapshot. You can diff two versions to see what changed, or switch back to a previous version. See [Versions & Snapshots](versions-and-snapshots.md).
|
|
45
|
+
|
|
46
|
+
## Where It Lives
|
|
47
|
+
|
|
48
|
+
AppGraph data is stored as JSON in `.alucify/` within your project. See [Alucify Directory Structure](../reference/alucify-directory.md).
|
|
49
|
+
|
|
50
|
+
## Viewing the Graph
|
|
51
|
+
|
|
52
|
+
The AppGraph can be browsed visually in the AppGraph Visualizer:
|
|
53
|
+
- VS Code: [AppGraph Visualizer](../vscode/appgraph-visualizer/opening-the-visualizer.md)
|
|
54
|
+
- Web UI: [AppGraph Visualizer Tab](../cli/ui/appgraph-visualizer-tab.md)
|
|
55
|
+
|
|
56
|
+
Or queried programmatically via the [MCP Server tools](../mcp-server/tools/query.md).
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 4
|
|
3
|
+
title: "Artifacts & Specs"
|
|
4
|
+
description: "What counts as a spec artifact, what formats are supported, and how artifacts flow through analysis."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Artifacts & Specs
|
|
8
|
+
|
|
9
|
+
A **spec** (or **artifact**) is any document that describes what your project should do: a PRD, architecture doc, design spec, feature epic, acceptance criteria, or even a design screenshot. Alucify reads these and maps them against your code.
|
|
10
|
+
|
|
11
|
+
## Supported Formats
|
|
12
|
+
|
|
13
|
+
- **PDF** — Multi-page specs; Alucify extracts relevant pages per analysis chunk
|
|
14
|
+
- **Markdown** (.md) — PRDs, READMEs, design docs
|
|
15
|
+
- **JSON / YAML** — Structured specs, API contracts, config
|
|
16
|
+
- **Images** (.png, .jpg, .gif) — Wireframes, mockups, screenshots (require vision-capable models)
|
|
17
|
+
- **Source files** (.ts, .py, etc.) — Reference implementations used as specifications
|
|
18
|
+
- **Plain text** (.txt)
|
|
19
|
+
|
|
20
|
+
See [Supported Project Types](../getting-started/supported-project-types.md) for language coverage.
|
|
21
|
+
|
|
22
|
+
## Artifact Lifecycle
|
|
23
|
+
|
|
24
|
+
Each artifact moves through three statuses:
|
|
25
|
+
|
|
26
|
+
1. **Pending** — Added to the project but not yet analyzed
|
|
27
|
+
2. **Preview** — Partial analysis available (mini-AppGraph extracted, not yet integrated)
|
|
28
|
+
3. **Analyzed** (integrated) — Fully merged into the project AppGraph
|
|
29
|
+
|
|
30
|
+
You can filter your artifact list by status in any UI.
|
|
31
|
+
|
|
32
|
+
## Where Artifacts Live
|
|
33
|
+
|
|
34
|
+
Artifacts are stored in `.alucify/artifacts/` in your project. Their extracted AppGraph fragments live in `.alucify/extractions/`. See [Alucify Directory Structure](../reference/alucify-directory.md).
|
|
35
|
+
|
|
36
|
+
## Generating Specs
|
|
37
|
+
|
|
38
|
+
You can also have Alucify generate specs for you when you know what you want but need help producing a formal artifact. Generation launches a Claude Code session with project context. See:
|
|
39
|
+
- VS Code: [Generating Specs](../vscode/spec-analysis/generating-specs.md)
|
|
40
|
+
- Web UI: [Artifacts Sidebar](../cli/ui/artifacts-sidebar.md) → Generate
|
|
41
|
+
|
|
42
|
+
## Adding Artifacts
|
|
43
|
+
|
|
44
|
+
- CLI: [`alucify add-spec <file>`](../cli/commands/add-spec.md)
|
|
45
|
+
- VS Code: [Adding Specs](../vscode/spec-analysis/adding-specs.md)
|
|
46
|
+
- Web UI: [Artifacts Sidebar](../cli/ui/artifacts-sidebar.md)
|