@alucify/cli 0.6.4 → 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 +1828 -1089
- 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 +31 -30
- 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,82 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 6
|
|
3
|
+
title: "Verifying a Plan"
|
|
4
|
+
description: "How the verify_plan tool mechanically checks a plan's appgraph references."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Verifying a Plan
|
|
8
|
+
|
|
9
|
+
The `verify_plan` tool checks a planning document against the appgraph to catch invented IDs, off-by-one drift, and silent omissions before the plan is presented or executed.
|
|
10
|
+
|
|
11
|
+
## What It Does
|
|
12
|
+
|
|
13
|
+
Runs three deterministic checks against the plan text:
|
|
14
|
+
|
|
15
|
+
1. **Invalid IDs** — Extracts every appgraph ID (`nv*`, `nl*`, `ni*`, `nr*`, `ns*`) from the plan and confirms each exists in the current appgraph. Catches hallucinations.
|
|
16
|
+
2. **Name mismatches** — Compares the plan's description near each ID against the actual node's name and description using token overlap. Catches off-by-one drift where the plan cites the wrong ID for a described task.
|
|
17
|
+
3. **Missing coverage** — Lists untested validations and in-progress components that need work but aren't referenced anywhere in the plan. Catches silent omissions.
|
|
18
|
+
|
|
19
|
+
No LLM calls — all checks are mechanical.
|
|
20
|
+
|
|
21
|
+
## Parameters
|
|
22
|
+
|
|
23
|
+
| Parameter | Type | Required | Description |
|
|
24
|
+
|-----------|------|----------|-------------|
|
|
25
|
+
| `plan_text` | string | Yes | The full plan text including task descriptions and any `link_context` references |
|
|
26
|
+
| `require_coverage_for` | enum | No | `"all"` (default): flag every untested/in-progress item not in the plan. `"requirements"`: only flag entirely absent requirements. `"none"`: skip coverage check. |
|
|
27
|
+
|
|
28
|
+
## What It Returns
|
|
29
|
+
|
|
30
|
+
```json
|
|
31
|
+
{
|
|
32
|
+
"valid": false,
|
|
33
|
+
"summary": "Found 44 IDs in plan | 11 INVALID (do not exist in appgraph) | 7 likely mismatched | 22 missing coverage",
|
|
34
|
+
"invalidIds": [
|
|
35
|
+
{ "id": "nv00057", "nearbyText": "Task 5.1: TestAC_AgentAccountFieldSync (nv00057) ..." }
|
|
36
|
+
],
|
|
37
|
+
"nameMismatches": [
|
|
38
|
+
{
|
|
39
|
+
"id": "nv00042",
|
|
40
|
+
"actualName": "Orphaned quota entry is warned and excluded",
|
|
41
|
+
"actualDescription": "...",
|
|
42
|
+
"planContext": "Task 2.7: TestLoadState_Corrupted (nv00042) — test malformed JSON...",
|
|
43
|
+
"similarity": 0.04
|
|
44
|
+
}
|
|
45
|
+
],
|
|
46
|
+
"missingIds": [
|
|
47
|
+
{
|
|
48
|
+
"id": "nv00001",
|
|
49
|
+
"type": "validation",
|
|
50
|
+
"name": "Registering a new account and marking default",
|
|
51
|
+
"requirement": "nr00001: Register Multiple Provider Accounts",
|
|
52
|
+
"reason": "untested validation"
|
|
53
|
+
}
|
|
54
|
+
],
|
|
55
|
+
"guidance": "Fix invalid IDs: these do not exist in the appgraph..."
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## How It's Used
|
|
60
|
+
|
|
61
|
+
The `/alucify-plan` skill calls this tool as the final step before presenting a plan. If verification fails, the planning agent fixes the flagged issues and re-runs verification until `valid: true`.
|
|
62
|
+
|
|
63
|
+
## Example Workflow
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
1. Plan agent writes plan referencing nv00057-nv00067
|
|
67
|
+
2. verify_plan returns invalidIds: ["nv00057", ...] because IDs only go up to nv00055
|
|
68
|
+
3. Plan agent removes invented IDs, replaces with real ones from get_implementation_tasks
|
|
69
|
+
4. verify_plan re-runs — this time nameMismatches flags nv00042 because the plan's
|
|
70
|
+
description ("TestLoadState_Corrupted") doesn't match nv00042's actual name
|
|
71
|
+
("Orphaned quota entry warning")
|
|
72
|
+
5. Plan agent corrects the ID mapping
|
|
73
|
+
6. verify_plan re-runs and returns valid: true
|
|
74
|
+
7. Plan is presented to the user
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Notes
|
|
78
|
+
|
|
79
|
+
- Name mismatches use a conservative similarity threshold — only obvious mismatches are flagged
|
|
80
|
+
- The tool does not check the quality of the plan's tasks — only whether IDs are real and coverage is complete
|
|
81
|
+
- `missingIds` is capped at 100 results to keep the response bounded
|
|
82
|
+
- Safe to call repeatedly — verification is cheap and has no side effects
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 6
|
|
3
|
+
title: "Comparing Analysis Versions"
|
|
4
|
+
description: "How to use the diff tool to compare two analysis versions and see what changed."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Comparing Analysis Versions
|
|
8
|
+
|
|
9
|
+
The `diff_context` tool compares two versions of your project analysis to show what was added, removed, or changed.
|
|
10
|
+
|
|
11
|
+
## What It Does
|
|
12
|
+
|
|
13
|
+
Takes two version numbers and returns a structured diff showing how your project evolved between them.
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Required | Description |
|
|
18
|
+
|-----------|------|----------|-------------|
|
|
19
|
+
| `from_version` | string | Yes | Starting version (e.g., `v3` or `3`) |
|
|
20
|
+
| `to_version` | string | Yes | Ending version (e.g., `v5` or `5`) |
|
|
21
|
+
|
|
22
|
+
Both `v3` and `3` formats are accepted.
|
|
23
|
+
|
|
24
|
+
## What It Returns
|
|
25
|
+
|
|
26
|
+
- **Components added** — New components that appear in the later version (with ID, type, and name)
|
|
27
|
+
- **Components removed** — Components that no longer exist in the later version
|
|
28
|
+
- **Status changes** — Components whose implementation status changed (e.g., `planned` → `implemented`)
|
|
29
|
+
- **Connection count change** — Net change in the number of connections between versions
|
|
30
|
+
|
|
31
|
+
## Example Use Cases
|
|
32
|
+
|
|
33
|
+
| Question | Parameters |
|
|
34
|
+
|----------|------------|
|
|
35
|
+
| "What changed since our baseline?" | `from_version: "v1", to_version: "v3"` |
|
|
36
|
+
| "What did the last spec analysis add?" | Compare the two most recent versions |
|
|
37
|
+
| "How has implementation progressed?" | Compare an early and late version to see status changes |
|
|
38
|
+
|
|
39
|
+
## Notes
|
|
40
|
+
|
|
41
|
+
- Each code analysis, spec analysis, and progress analysis creates a new version automatically
|
|
42
|
+
- Use `alucify version` in the CLI to list all available versions
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 4
|
|
3
|
+
title: "Using MCP with Claude Code"
|
|
4
|
+
description: "How the /alucify-plan and /alucify-continue skills use MCP tools in practice."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Using MCP with Claude Code
|
|
8
|
+
|
|
9
|
+
Once the MCP server is installed (via [`alucify enable`](../cli/commands/enable-disable.md) or [`alucify mcp-install`](../cli/commands/mcp-install.md)), Claude Code sessions in your project get access to every [MCP tool](tools/tools-reference.md) and the [Terminology Resource](resources/terminology-resource.md).
|
|
10
|
+
|
|
11
|
+
## Installed Skills
|
|
12
|
+
|
|
13
|
+
`alucify enable` also installs two slash commands:
|
|
14
|
+
|
|
15
|
+
### `/alucify-plan`
|
|
16
|
+
|
|
17
|
+
Launches a Claude Code session focused on planning work. The skill:
|
|
18
|
+
1. Calls `get_remaining_work` to see what's open
|
|
19
|
+
2. Calls `get_implementation_tasks` for each target requirement
|
|
20
|
+
3. Composes a plan with concrete implementation steps
|
|
21
|
+
4. Calls `verify_plan` to mechanically check the plan (valid IDs, coverage, no drift)
|
|
22
|
+
5. Presents the verified plan to you for approval
|
|
23
|
+
|
|
24
|
+
Use when: you want to plan the next chunk of work with AppGraph awareness.
|
|
25
|
+
|
|
26
|
+
### `/alucify-continue`
|
|
27
|
+
|
|
28
|
+
Launches a Claude Code session focused on closing gaps. The skill:
|
|
29
|
+
1. Reads the most recent progress analysis
|
|
30
|
+
2. Identifies in-progress nodes with gap notes
|
|
31
|
+
3. Picks the next logical one to close
|
|
32
|
+
4. Plans and (with your approval) implements the fix
|
|
33
|
+
|
|
34
|
+
Use when: you want to keep momentum — there's work in progress and you want it finished.
|
|
35
|
+
|
|
36
|
+
## Manual Tool Use
|
|
37
|
+
|
|
38
|
+
You can always call MCP tools directly in any Claude Code session. Typical patterns:
|
|
39
|
+
|
|
40
|
+
**"What's left to build?"**
|
|
41
|
+
- Claude calls `get_remaining_work`
|
|
42
|
+
- You get a prioritized list of open requirements
|
|
43
|
+
|
|
44
|
+
**"What's the blast radius of changing `UserAccount`?"**
|
|
45
|
+
- Claude calls `trace_dependencies` with the file path
|
|
46
|
+
- You get direct + transitive impacts up to 3 hops
|
|
47
|
+
|
|
48
|
+
**"Don't name a new field — use the existing one."**
|
|
49
|
+
- Claude calls `find_similar_context` before creating nodes
|
|
50
|
+
- The terminology resource (always loaded) prevents most drift without an explicit tool call
|
|
51
|
+
|
|
52
|
+
## Verifying Plans
|
|
53
|
+
|
|
54
|
+
`verify_plan` is meant to catch common mistakes in LLM-generated plans:
|
|
55
|
+
- Hallucinated node IDs that don't exist
|
|
56
|
+
- Name drift (slight variations of real names)
|
|
57
|
+
- Plans that claim to implement X but don't touch X's acceptance criteria
|
|
58
|
+
|
|
59
|
+
If a plan fails verification, the skill tells Claude Code to fix it before presenting to you.
|
|
60
|
+
|
|
61
|
+
## Troubleshooting
|
|
62
|
+
|
|
63
|
+
**MCP server not appearing in Claude Code:**
|
|
64
|
+
1. Check `.mcp.json` exists in your project root
|
|
65
|
+
2. Restart Claude Code
|
|
66
|
+
3. Run `alucify mcp-install --with-rules` to reinstall
|
|
67
|
+
|
|
68
|
+
**Tools time out:**
|
|
69
|
+
The server caches for 5 seconds; very large AppGraphs may need longer on the first call. Re-run the tool; subsequent calls are fast.
|
|
70
|
+
|
|
71
|
+
**Stale data:**
|
|
72
|
+
MCP serves the current version of the AppGraph. Run `alucify analyze-progress` (or just commit — the hook fires) to refresh.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{ "title": "Reference", "order": 8 }
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 1
|
|
3
|
+
title: "The .alucify Directory Structure"
|
|
4
|
+
description: "What's inside the .alucify directory — versions, analysis reports, and configuration files."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# The .alucify Directory Structure
|
|
8
|
+
|
|
9
|
+
Alucify stores all analysis data in a `.alucify/` directory at the root of your project. This directory is created automatically when you first run an analysis.
|
|
10
|
+
|
|
11
|
+
## Directory Layout
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
.alucify/
|
|
15
|
+
├── appgraph-baseline.json # Code analysis baseline
|
|
16
|
+
├── appgraph-project.json # Combined code + spec analysis
|
|
17
|
+
├── artifact-manifest.json # Spec import tracking
|
|
18
|
+
├── artifacts/ # Imported spec documents
|
|
19
|
+
│ ├── requirements.pdf
|
|
20
|
+
│ ├── api-spec.md
|
|
21
|
+
│ └── ...
|
|
22
|
+
├── versions/ # Versioned snapshots
|
|
23
|
+
│ ├── v1/
|
|
24
|
+
│ ├── v2/
|
|
25
|
+
│ └── ...
|
|
26
|
+
├── analysis/ # Analysis reports
|
|
27
|
+
│ └── [date]/
|
|
28
|
+
│ ├── congruency/
|
|
29
|
+
│ ├── coverage-report.md
|
|
30
|
+
│ └── quality-synthesis-report.md
|
|
31
|
+
├── progress/ # Progress tracking data
|
|
32
|
+
│ ├── checkpoint.json
|
|
33
|
+
│ └── gaps.json
|
|
34
|
+
├── token-usage/ # Token consumption logs
|
|
35
|
+
│ └── usage.jsonl # All-time usage records (Alucify + Claude Code sessions)
|
|
36
|
+
├── extractions/
|
|
37
|
+
│ └── intents/ # Intent capture output (requires intentCapture.enabled)
|
|
38
|
+
│ └── *.json # Extracted intent files pending AppGraph integration
|
|
39
|
+
├── archived/ # Data from previous resets
|
|
40
|
+
│ └── [timestamp]/
|
|
41
|
+
├── mcp-server.js # Vendored MCP server (if installed)
|
|
42
|
+
└── debug-logs/ # Debug logs (if enabled)
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Key Files
|
|
46
|
+
|
|
47
|
+
### appgraph-baseline.json
|
|
48
|
+
The result of code analysis — a structured model of your codebase's architecture. Created by `Analyze Code` or `alucify analyze-code`.
|
|
49
|
+
|
|
50
|
+
### appgraph-project.json
|
|
51
|
+
The combined model after spec analysis — includes both your code baseline and spec analysis results. Created by `Analyze Specs` or `alucify analyze-specs`.
|
|
52
|
+
|
|
53
|
+
### artifact-manifest.json
|
|
54
|
+
Tracks which spec files have been imported and their analysis status (pending, analyzed).
|
|
55
|
+
|
|
56
|
+
### artifacts/
|
|
57
|
+
Contains copies of all imported specification documents. Files are copied here when you use **Add Spec** or `alucify add-spec`.
|
|
58
|
+
|
|
59
|
+
### versions/
|
|
60
|
+
Each analysis run creates a versioned snapshot. These allow you to compare how your project evolves over time.
|
|
61
|
+
|
|
62
|
+
### analysis/
|
|
63
|
+
Reports generated during spec analysis — congruency reports per artifact, coverage reports, and quality synthesis reports.
|
|
64
|
+
|
|
65
|
+
### progress/
|
|
66
|
+
Progress tracking data from commit analysis:
|
|
67
|
+
- `checkpoint.json` — Records the last analyzed commit hash and timestamp
|
|
68
|
+
- `gaps.json` — Gap report from the most recent progress analysis
|
|
69
|
+
|
|
70
|
+
### token-usage/
|
|
71
|
+
Token consumption records across all Alucify workflows and Claude Code sessions. `usage.jsonl` is an append-only log — you can commit it for team visibility or add it to `.gitignore` to keep it local.
|
|
72
|
+
|
|
73
|
+
### extractions/intents/
|
|
74
|
+
Intent capture output, created when `alucify.intentCapture.enabled` is on. Contains extracted intent files waiting to be integrated into the AppGraph. See [Intent Capture](../vscode/intent-capture/enabling-intent-capture.md).
|
|
75
|
+
|
|
76
|
+
### archived/
|
|
77
|
+
When you reset your analysis, all existing data is moved here with a timestamp. See [Resetting Your Analysis](../vscode/resetting-analysis.md).
|
|
78
|
+
|
|
79
|
+
## Version Control
|
|
80
|
+
|
|
81
|
+
You can choose whether to commit `.alucify/` to your repository:
|
|
82
|
+
|
|
83
|
+
- **Commit it** — Team members can use the MCP server and view analysis results without re-running analysis
|
|
84
|
+
- **Gitignore it** — Each developer runs their own analysis locally
|
|
85
|
+
|
|
86
|
+
If committing, consider adding `debug-logs/` to your `.gitignore`.
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 4
|
|
3
|
+
title: "File Types & Formats"
|
|
4
|
+
description: "What file types Alucify can ingest, and what formats its outputs use."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# File Types & Formats
|
|
8
|
+
|
|
9
|
+
## Input: Spec Artifacts
|
|
10
|
+
|
|
11
|
+
Formats you can add as specs:
|
|
12
|
+
|
|
13
|
+
| Format | Extension | Notes |
|
|
14
|
+
|---|---|---|
|
|
15
|
+
| PDF | `.pdf` | Multi-page; Alucify slices pages per analysis chunk |
|
|
16
|
+
| Markdown | `.md`, `.markdown` | PRDs, READMEs, design docs |
|
|
17
|
+
| JSON | `.json` | Structured specs, OpenAPI, schemas |
|
|
18
|
+
| YAML | `.yaml`, `.yml` | Config, schemas |
|
|
19
|
+
| HTML | `.html`, `.htm` | Exported docs, web-published specs |
|
|
20
|
+
| Plain text | `.txt` | Free-form |
|
|
21
|
+
| Images | `.png`, `.jpg`, `.jpeg`, `.gif`, `.webp` | Wireframes, mockups; requires vision-capable model |
|
|
22
|
+
| Source files | `.ts`, `.js`, `.py`, `.go`, `.java`, `.rs`, `.rb`, `.cs`, `.cpp`, `.c`, `.swift`, `.kt` | Used as reference implementations; languages = same as code analysis |
|
|
23
|
+
|
|
24
|
+
See [Supported Project Types](../getting-started/supported-project-types.md) for the full code-side language list.
|
|
25
|
+
|
|
26
|
+
## Input: Source Code
|
|
27
|
+
|
|
28
|
+
Alucify detects languages automatically during code analysis. See [Supported Project Types](../getting-started/supported-project-types.md).
|
|
29
|
+
|
|
30
|
+
## Output Formats
|
|
31
|
+
|
|
32
|
+
### AppGraph (JSON)
|
|
33
|
+
`.alucify/appgraph-baseline.json` and `.alucify/appgraph-project.json` are the canonical AppGraph files. JSON is pretty-printed and versioned via `.alucify/versions/`.
|
|
34
|
+
|
|
35
|
+
### Analysis Reports
|
|
36
|
+
- Congruency: `.alucify/analysis/congruency.json`
|
|
37
|
+
- Coverage: `.alucify/analysis/coverage.json`
|
|
38
|
+
- Impact: `.alucify/analysis/impact.json`
|
|
39
|
+
- Findings: `.alucify/analysis/findings.json`
|
|
40
|
+
- Tech debt: `.alucify/analysis/tech-debt.json`
|
|
41
|
+
|
|
42
|
+
### Progress
|
|
43
|
+
- `.alucify/progress/checkpoint.json` — current progress state
|
|
44
|
+
- `.alucify/progress/log.jsonl` — append-only commit log
|
|
45
|
+
|
|
46
|
+
### Token Usage
|
|
47
|
+
- `.alucify/token-usage/usage.jsonl` — append-only log of every LLM call
|
|
48
|
+
- `.alucify/token-usage/state.*.json` — per-user session reader state (gitignored)
|
|
49
|
+
|
|
50
|
+
### Intent Capture
|
|
51
|
+
- `.alucify/extractions/intents/*.json` — staged intent, pending integration
|
|
52
|
+
|
|
53
|
+
### Exports
|
|
54
|
+
|
|
55
|
+
| From UI | Format |
|
|
56
|
+
|---|---|
|
|
57
|
+
| CLI `--json` | JSON (single object or line-delimited) |
|
|
58
|
+
| Web UI → Export | CSV (usage data), Markdown (reports), JSON (raw data) |
|
|
59
|
+
| VS Code → Compare Versions → Export | Markdown or JSON |
|
|
60
|
+
|
|
61
|
+
## Machine-Readable API
|
|
62
|
+
|
|
63
|
+
For programmatic access, use:
|
|
64
|
+
- **MCP server** — [tools](../mcp-server/tools/tools-reference.md) return structured JSON
|
|
65
|
+
- **CLI `--json`** — every reporting command
|
|
66
|
+
- **Web REST API** — `/api/artifacts`, `/api/usage`, etc. (same session-token auth as the web UI)
|
|
67
|
+
|
|
68
|
+
## Internal-Use Only
|
|
69
|
+
|
|
70
|
+
Some files in `.alucify/` are internal to Alucify's workflow engine and shouldn't be edited directly:
|
|
71
|
+
|
|
72
|
+
- `*.lock` — concurrency locks
|
|
73
|
+
- `*.partial` — in-flight analysis state
|
|
74
|
+
- `debug-logs/` — verbose logs (for troubleshooting)
|
|
75
|
+
|
|
76
|
+
If you see these, leave them alone. They're cleaned up automatically.
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 2
|
|
3
|
+
title: "Glossary of Terms"
|
|
4
|
+
description: "Definitions of key terms used throughout Alucify: congruency, coverage, grounding, and more."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Glossary of Terms
|
|
8
|
+
|
|
9
|
+
## AI Coding Risks
|
|
10
|
+
Issues identified by Alucify that could cause problems when AI coding agents work on your project. Examples include missing specs, conflicting requirements, and high blast radius areas.
|
|
11
|
+
|
|
12
|
+
## AI Readiness
|
|
13
|
+
A composite score (0–100%) summarizing how prepared your project is for AI coding. Factors in congruency, coverage, completeness, and other metrics. Higher is better.
|
|
14
|
+
|
|
15
|
+
## Analysis Mode
|
|
16
|
+
The depth level for analysis. Three options:
|
|
17
|
+
- **Speed** (catalog) — Mechanical analysis, no AI cost
|
|
18
|
+
- **Balanced** (fast) — AI-powered with moderate depth
|
|
19
|
+
- **Quality** (full) — Comprehensive AI analysis
|
|
20
|
+
|
|
21
|
+
## Baseline
|
|
22
|
+
The structured model of your codebase created by code analysis. This is the foundation that spec analysis builds on.
|
|
23
|
+
|
|
24
|
+
## Blast Radius
|
|
25
|
+
The percentage of your project that could be affected by a change in a specific area. A high blast radius means changes ripple across many components.
|
|
26
|
+
|
|
27
|
+
## Claude Code
|
|
28
|
+
Anthropic's AI coding assistant that runs in the terminal. Alucify can integrate with Claude Code via the MCP server to provide project context.
|
|
29
|
+
|
|
30
|
+
## Completeness
|
|
31
|
+
How thoroughly your specifications cover all necessary dimensions. High completeness means your specs address requirements, designs, data models, and acceptance criteria.
|
|
32
|
+
|
|
33
|
+
## Congruency
|
|
34
|
+
How well your specifications align with your codebase. High congruency means specs and code tell the same story with few contradictions or mismatches.
|
|
35
|
+
|
|
36
|
+
## Coverage
|
|
37
|
+
The proportion of your codebase that has corresponding specifications. High coverage means most components have requirements or specs backing them.
|
|
38
|
+
|
|
39
|
+
## Grounding
|
|
40
|
+
How well a component is anchored in your specifications. Strong grounding means clear spec references and well-defined requirements. Weak grounding suggests the component needs better documentation.
|
|
41
|
+
|
|
42
|
+
## Health Score
|
|
43
|
+
A 0–100 rating of your architecture's structural health from the Technical Debt Analysis. Considers coupling, complexity, dependency cycles, and other structural factors.
|
|
44
|
+
|
|
45
|
+
## Implementation Status
|
|
46
|
+
The development stage of a component:
|
|
47
|
+
- **Planned** — Specified but not started
|
|
48
|
+
- **In Progress** — Currently being worked on
|
|
49
|
+
- **Implemented** — Code written
|
|
50
|
+
- **Tested** — Tests exist and pass
|
|
51
|
+
- **Deprecated** — No longer active
|
|
52
|
+
|
|
53
|
+
## MCP (Model Context Protocol)
|
|
54
|
+
A protocol that lets AI tools like Claude Code communicate with external data sources. Alucify's MCP server gives Claude Code access to your project analysis.
|
|
55
|
+
|
|
56
|
+
## Spec (Specification)
|
|
57
|
+
A document describing what your project should do — PRDs, requirements documents, design files, API specifications, and other project documentation.
|
|
58
|
+
|
|
59
|
+
## Version
|
|
60
|
+
A numbered snapshot of your analysis at a point in time (v1, v2, v3, etc.). Created automatically each time you run code analysis, spec analysis, or progress analysis.
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 3
|
|
3
|
+
title: "How Claude Code Integration Works"
|
|
4
|
+
description: "What Alucify installs into your Claude Code environment, how the pieces fit together, and what each one does."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# How Claude Code Integration Works
|
|
8
|
+
|
|
9
|
+
When you run `alucify enable` (or toggle the integration in VS Code), Alucify installs four components that give Claude Code structured awareness of your project. Each serves a distinct purpose — together they form a feedback loop that helps Claude plan with real architecture context, implement against actual requirements, and track progress automatically.
|
|
10
|
+
|
|
11
|
+
## What Gets Installed
|
|
12
|
+
|
|
13
|
+
| Component | File | Purpose |
|
|
14
|
+
|-----------|------|---------|
|
|
15
|
+
| CLAUDE.md instructions | `CLAUDE.md` | Teaches Claude what the appgraph is and when to use it |
|
|
16
|
+
| Hooks | `.claude/settings.json` | Injects context at key moments (planning, task creation, subagent start) |
|
|
17
|
+
| MCP server | `.mcp.json` | Gives Claude tools to query your project's architecture on demand |
|
|
18
|
+
| Git hooks | `.git/hooks/pre-commit` + `post-commit` | Analyzes commits against the appgraph for progress tracking |
|
|
19
|
+
|
|
20
|
+
All installations are marker-based and idempotent — running `enable` multiple times is safe, and `disable` cleanly removes everything while preserving your analysis data.
|
|
21
|
+
|
|
22
|
+
## CLAUDE.md Instructions
|
|
23
|
+
|
|
24
|
+
**What it is:** A small section (~200 tokens) added to your project's `CLAUDE.md` file, delimited by `<!-- alucify:appgraph:start -->` / `<!-- alucify:appgraph:end -->` markers.
|
|
25
|
+
|
|
26
|
+
**What it does:** Teaches Claude the mental model of your project's appgraph — the node type system (requirements, interfaces, schemas, logic, validations), how they connect via edges, and rules for when to query the architecture. For example: "Before planning features, call `query_context()` to find existing components" and "Call `trace_dependencies()` before cross-cutting changes to check blast radius."
|
|
27
|
+
|
|
28
|
+
**Why it matters:** Without these instructions, Claude has MCP tools available but doesn't know *when* to use them. The instructions bridge that gap — they're always loaded, never go stale (they contain rules, not data), and work regardless of how large your project is.
|
|
29
|
+
|
|
30
|
+
## Hooks
|
|
31
|
+
|
|
32
|
+
**What they are:** Entries in `.claude/settings.json` that run automatically when Claude Code reaches specific moments in its workflow.
|
|
33
|
+
|
|
34
|
+
**What they do:** Each hook injects a small, targeted piece of context:
|
|
35
|
+
|
|
36
|
+
| Hook | When it fires | What it injects |
|
|
37
|
+
|------|---------------|-----------------|
|
|
38
|
+
| **EnterPlanMode** | When Claude enters formal planning | Unimplemented requirements with validation status, plus a step-by-step exploration workflow |
|
|
39
|
+
| **ExitPlanMode** | When Claude finishes a plan, before presenting it | Validation warnings — missing dependencies, uncovered acceptance criteria, nodes referenced but not addressed |
|
|
40
|
+
| **TodoWrite** | When Claude creates or updates tasks | Per-task context — related appgraph nodes, blast radius, acceptance criteria from validation nodes |
|
|
41
|
+
|
|
42
|
+
**Why they matter:** Hooks deliver the right context at the right time without dumping your entire architecture into every conversation. The planning hooks ensure Claude's plans account for real dependencies and requirements. Task hooks give each implementation step the specific context it needs.
|
|
43
|
+
|
|
44
|
+
**Note:** Not every Claude Code interaction uses all hooks. For simple tasks like bug fixes, only CLAUDE.md rules are active — Claude won't enter plan mode for a one-line fix, and that's the right behavior. The planning and task hooks activate naturally when Claude tackles more complex work.
|
|
45
|
+
|
|
46
|
+
## MCP Server
|
|
47
|
+
|
|
48
|
+
**What it is:** A lightweight server that starts as a subprocess when Claude Code connects. It reads your `.alucify/` analysis data and exposes it through tools and resources.
|
|
49
|
+
|
|
50
|
+
**What it does:** Gives Claude on-demand access to your project's architecture:
|
|
51
|
+
|
|
52
|
+
| Tool | What it answers |
|
|
53
|
+
|------|-----------------|
|
|
54
|
+
| `query_context` | "What screens exist?" "Find anything related to auth" "What's still planned?" |
|
|
55
|
+
| `get_context` | Full detail on a specific node — UI structure, data model, state machines, connected nodes |
|
|
56
|
+
| `trace_dependencies` | "If I change this file, what else is affected?" — blast radius analysis |
|
|
57
|
+
| `get_remaining_work` | Unimplemented requirements, untested validations, orphaned nodes |
|
|
58
|
+
| `get_implementation_tasks` | Per-requirement task list with gap notes and untested validations — used by `/alucify-plan` |
|
|
59
|
+
| `link_context` | Link a node to its implementation file so progress tracking can find it |
|
|
60
|
+
| `verify_plan` | Mechanically validate a plan's appgraph references before presenting it |
|
|
61
|
+
| `find_similar_context` | "Is there already a concept called X?" — terminology grounding for artifact drafting |
|
|
62
|
+
| `diff_context` | What changed between two analysis versions |
|
|
63
|
+
| `get_analysis` | Congruency, coverage, or quality report summaries |
|
|
64
|
+
|
|
65
|
+
**Why it matters:** The MCP server is the primary data source — it's where the actual architecture knowledge lives. The CLAUDE.md instructions teach Claude *when* to query, the hooks *nudge* Claude with summaries, but the MCP tools *provide the data*. This keeps the design scale-independent: a 50-node project and a 5,000-node project work identically because Claude queries what it needs rather than receiving everything upfront.
|
|
66
|
+
|
|
67
|
+
All tools are read-only except `link_context`, which updates a node's file reference for progress tracking.
|
|
68
|
+
|
|
69
|
+
## Git Hooks (Pre-Commit + Post-Commit)
|
|
70
|
+
|
|
71
|
+
**What they are:** Two hooks in `.git/hooks/` that work together to analyze every commit.
|
|
72
|
+
|
|
73
|
+
**How they work:**
|
|
74
|
+
|
|
75
|
+
1. **Pre-commit hook** (synchronous, ≤15s timeout): Runs `alucify analyze-progress --pre-commit` to classify staged files against the appgraph using a single LLM call. On success, the analysis output (updated appgraph, version snapshot) is staged into the same commit — so everything lands in a single atomic commit with zero leftover files.
|
|
76
|
+
|
|
77
|
+
2. **Post-commit hook** (async fallback): Only runs if the pre-commit analysis timed out or failed. In that case, it runs the full async analysis in the background, and the results are auto-staged into the *next* commit by the pre-commit hook.
|
|
78
|
+
|
|
79
|
+
**Why they matter:** This closes the loop. The other three components help Claude *plan and write* code with architecture awareness. The git hooks track *what was actually built*, so you can see progress against your requirements without manual bookkeeping — and without requiring a second commit.
|
|
80
|
+
|
|
81
|
+
## How They Work Together
|
|
82
|
+
|
|
83
|
+
Here's the flow across a typical development session:
|
|
84
|
+
|
|
85
|
+
```
|
|
86
|
+
Session starts
|
|
87
|
+
└─ CLAUDE.md loaded → Claude knows the node types and when to query
|
|
88
|
+
|
|
89
|
+
You ask Claude to plan a feature
|
|
90
|
+
└─ EnterPlanMode hook → "Here's what's unfinished: nr00045 (0/3 tested)..."
|
|
91
|
+
└─ Claude calls MCP tools → query_context, get_context, trace_dependencies
|
|
92
|
+
└─ ExitPlanMode hook → "⚠ ProjectDetail also depends on this schema"
|
|
93
|
+
└─ Claude presents plan with node IDs and dependency warnings
|
|
94
|
+
|
|
95
|
+
You approve, Claude implements
|
|
96
|
+
└─ TodoWrite hook → per-task blast radius + acceptance criteria
|
|
97
|
+
└─ Claude calls link_context → links nodes to implementation files
|
|
98
|
+
└─ Claude edits files
|
|
99
|
+
|
|
100
|
+
You commit
|
|
101
|
+
└─ Git hook captures changed files
|
|
102
|
+
└─ analyze-progress matches commits to nodes → statuses update
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
For simpler tasks (bug fixes, refactors), Claude skips the planning hooks entirely and works with just the baseline — CLAUDE.md rules and MCP tools available if needed.
|
|
106
|
+
|
|
107
|
+
## `enable` vs `mcp-install`
|
|
108
|
+
|
|
109
|
+
If you don't need the full integration — for example, you're consuming an appgraph a teammate built and just want Claude to be able to query it — you can install only the MCP server:
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
alucify mcp-install --with-rules
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
This gives you the MCP server and CLAUDE.md instructions but skips hooks and commit tracking. See [MCP Server Setup](../mcp-server/setup.md) for details.
|
|
116
|
+
|
|
117
|
+
| | `enable` | `mcp-install --with-rules` |
|
|
118
|
+
|---|---|---|
|
|
119
|
+
| MCP server (query tools) | Yes | Yes |
|
|
120
|
+
| CLAUDE.md instructions | Yes | Yes |
|
|
121
|
+
| Hooks (session, planning, tasks) | Yes | No |
|
|
122
|
+
| Git hook (commit tracking) | Yes | No |
|
|
123
|
+
| Best for | Running analysis + developing | Consuming a teammate's analysis |
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
---
|
|
2
|
+
order: 3
|
|
3
|
+
title: "UI Parity Matrix"
|
|
4
|
+
description: "What features are available in each of Alucify's four UIs."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# UI Parity Matrix
|
|
8
|
+
|
|
9
|
+
Alucify's four UIs — CLI, VS Code Extension, Web UI, and Desktop App — share a single core server. Most features are available in all four. This page lists what's where.
|
|
10
|
+
|
|
11
|
+
## Legend
|
|
12
|
+
|
|
13
|
+
- ✅ Available
|
|
14
|
+
- ⚠️ Limited / read-only
|
|
15
|
+
- ❌ Not available (by design or not yet)
|
|
16
|
+
|
|
17
|
+
## Analysis
|
|
18
|
+
|
|
19
|
+
| Feature | CLI | VS Code | Web UI | Desktop |
|
|
20
|
+
|---|---|---|---|---|
|
|
21
|
+
| Analyze code | ✅ | ✅ | ✅ | ✅ |
|
|
22
|
+
| Analyze specs | ✅ | ✅ | ✅ | ✅ |
|
|
23
|
+
| Analyze progress | ✅ | ✅ | ✅ | ✅ |
|
|
24
|
+
| Congruency / coverage / impact / findings (standalone) | ⚠️ (via composition) | ✅ (Advanced Mode) | ❌ | ❌ |
|
|
25
|
+
| Analysis modes (Speed/Balanced/Quality) | ✅ | ✅ | ✅ | ✅ |
|
|
26
|
+
|
|
27
|
+
## Artifacts
|
|
28
|
+
|
|
29
|
+
| Feature | CLI | VS Code | Web UI | Desktop |
|
|
30
|
+
|---|---|---|---|---|
|
|
31
|
+
| Add artifact | ✅ `add-spec` | ✅ | ✅ (drag+drop) | ✅ (drag+drop) |
|
|
32
|
+
| Filter by status | ⚠️ (via `status`) | ✅ | ✅ | ✅ |
|
|
33
|
+
| Generate artifact (AI) | ❌ | ✅ | ✅ | ✅ |
|
|
34
|
+
| Audit artifact | ❌ | ✅ | ❌ | ❌ |
|
|
35
|
+
|
|
36
|
+
## AI Coding Risks
|
|
37
|
+
|
|
38
|
+
| Feature | CLI | VS Code | Web UI | Desktop |
|
|
39
|
+
|---|---|---|---|---|
|
|
40
|
+
| View risks | ⚠️ (via `status --json`) | ✅ | ✅ | ✅ |
|
|
41
|
+
| Resolve via chat | ❌ | ✅ | ✅ | ✅ |
|
|
42
|
+
| Bulk refine | ❌ | ✅ | ✅ | ✅ |
|
|
43
|
+
| Ignore risk | ❌ | ✅ | ✅ | ✅ |
|
|
44
|
+
|
|
45
|
+
## AppGraph Visualizer
|
|
46
|
+
|
|
47
|
+
| Feature | CLI | VS Code | Web UI | Desktop |
|
|
48
|
+
|---|---|---|---|---|
|
|
49
|
+
| Interactive graph | ❌ | ✅ | ✅ | ✅ |
|
|
50
|
+
| Filter by type/status/origin | ❌ | ✅ | ✅ | ✅ |
|
|
51
|
+
| Node details | ⚠️ (via MCP) | ✅ | ✅ | ✅ |
|
|
52
|
+
|
|
53
|
+
## Chat
|
|
54
|
+
|
|
55
|
+
| Feature | CLI | VS Code | Web UI | Desktop |
|
|
56
|
+
|---|---|---|---|---|
|
|
57
|
+
| Ask about project | ❌ | ✅ | ✅ | ✅ |
|
|
58
|
+
| Refine specs | ❌ | ✅ | ✅ | ✅ |
|
|
59
|
+
| Generate artifact | ❌ | ✅ | ✅ | ✅ |
|
|
60
|
+
|
|
61
|
+
## Progress Tracking
|
|
62
|
+
|
|
63
|
+
| Feature | CLI | VS Code | Web UI | Desktop |
|
|
64
|
+
|---|---|---|---|---|
|
|
65
|
+
| Progress dashboard | ⚠️ (via `progress --json`) | ✅ | ✅ | ✅ |
|
|
66
|
+
| Trigger progress analysis | ✅ | ✅ | ✅ | ✅ |
|
|
67
|
+
| Reset progress | ❌ | ✅ (Advanced) | ❌ | ❌ |
|
|
68
|
+
|
|
69
|
+
## Versions
|
|
70
|
+
|
|
71
|
+
| Feature | CLI | VS Code | Web UI | Desktop |
|
|
72
|
+
|---|---|---|---|---|
|
|
73
|
+
| List versions | ✅ `version` | ✅ (Advanced) | ❌ | ❌ |
|
|
74
|
+
| Diff versions | ✅ `version --diff` | ✅ (Advanced) | ❌ | ❌ |
|
|
75
|
+
| Switch version | ❌ | ✅ (Advanced) | ❌ | ❌ |
|
|
76
|
+
| Delete version | ❌ | ✅ (Advanced) | ❌ | ❌ |
|
|
77
|
+
|
|
78
|
+
## Intent Capture
|
|
79
|
+
|
|
80
|
+
| Feature | CLI | VS Code | Web UI | Desktop |
|
|
81
|
+
|---|---|---|---|---|
|
|
82
|
+
| Automatic polling | ❌ | ✅ (`alucify.intentCapture.enabled`) | ❌ | ❌ |
|
|
83
|
+
| Manual capture | ✅ `capture-intent` | ✅ | ❌ | ❌ |
|
|
84
|
+
| Capture + integrate in one step | ❌ | ✅ | ❌ | ❌ |
|
|
85
|
+
|
|
86
|
+
"Automatic polling" is a persistent background process in the VS Code extension that checks for new Claude Code sessions. The CLI has no persistent state — you invoke capture manually or via cron.
|
|
87
|
+
|
|
88
|
+
## Token Usage
|
|
89
|
+
|
|
90
|
+
| Feature | CLI | VS Code | Web UI | Desktop |
|
|
91
|
+
|---|---|---|---|---|
|
|
92
|
+
| Summary | ✅ `usage` | ✅ | ✅ | ✅ |
|
|
93
|
+
| Daily chart | ❌ | ✅ | ✅ | ✅ |
|
|
94
|
+
| Per-user / per-model / per-workflow breakdowns | ⚠️ (via `--json`) | ✅ | ✅ | ✅ |
|
|
95
|
+
| Export CSV | ❌ | ❌ | ✅ | ✅ |
|
|
96
|
+
|
|
97
|
+
## Authentication
|
|
98
|
+
|
|
99
|
+
| Feature | CLI | VS Code | Web UI | Desktop |
|
|
100
|
+
|---|---|---|---|---|
|
|
101
|
+
| API key mode | ✅ | ✅ | ✅ | ✅ |
|
|
102
|
+
| Claude Code subscription mode | ✅ | ✅ | ✅ | ✅ |
|
|
103
|
+
| Switch auth mode | ✅ (re-run with flag) | ✅ | ✅ | ✅ |
|
|
104
|
+
|
|
105
|
+
## Integrations
|
|
106
|
+
|
|
107
|
+
| Feature | CLI | VS Code | Web UI | Desktop |
|
|
108
|
+
|---|---|---|---|---|
|
|
109
|
+
| `alucify enable` (full install) | ✅ | ✅ (via command) | ❌ | ❌ |
|
|
110
|
+
| `alucify mcp-install` (lightweight) | ✅ | ❌ | ❌ | ❌ |
|
|
111
|
+
| MCP server management | ✅ | ✅ | ⚠️ (settings toggle) | ⚠️ (settings toggle) |
|
|
112
|
+
| Git hooks management | ✅ | ✅ | ❌ | ❌ |
|
|
113
|
+
|
|
114
|
+
## UI-Native Only Features
|
|
115
|
+
|
|
116
|
+
Some features exist only in their native UI because they'd make no sense elsewhere:
|
|
117
|
+
|
|
118
|
+
- **CLI-only:** `--json` output, scripting-friendly exit codes, pre-commit hook
|
|
119
|
+
- **VS Code-only:** status bar item, tree view sidebars, command palette integration, in-editor file jump
|
|
120
|
+
- **Web-only:** drag-and-drop file upload, browser-native URLs for share/bookmark
|
|
121
|
+
- **Desktop-only:** native file picker, OS menu bar, native notifications, workspace switcher
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{ "title": "VS Code Extension", "order": 4 }
|