create-universal-ai-context 2.0.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/LICENSE +21 -0
- package/README.md +171 -0
- package/bin/create-ai-context.js +337 -0
- package/lib/adapters/antigravity.js +160 -0
- package/lib/adapters/claude.js +122 -0
- package/lib/adapters/cline.js +111 -0
- package/lib/adapters/copilot.js +117 -0
- package/lib/adapters/index.js +69 -0
- package/lib/ai-context-generator.js +234 -0
- package/lib/ai-orchestrator.js +431 -0
- package/lib/call-tracer.js +444 -0
- package/lib/detector.js +726 -0
- package/lib/environment-detector.js +239 -0
- package/lib/index.js +310 -0
- package/lib/installer.js +418 -0
- package/lib/migrate.js +319 -0
- package/lib/placeholder.js +541 -0
- package/lib/prompts.js +287 -0
- package/lib/spinner.js +60 -0
- package/lib/static-analyzer.js +729 -0
- package/lib/template-populator.js +843 -0
- package/lib/template-renderer.js +382 -0
- package/lib/validate.js +155 -0
- package/package.json +70 -0
- package/templates/AI_CONTEXT.md.template +245 -0
- package/templates/base/README.md +257 -0
- package/templates/base/RPI_WORKFLOW_PLAN.md +320 -0
- package/templates/base/agents/api-developer.md +76 -0
- package/templates/base/agents/context-engineer.md +525 -0
- package/templates/base/agents/core-architect.md +76 -0
- package/templates/base/agents/database-ops.md +76 -0
- package/templates/base/agents/deployment-ops.md +76 -0
- package/templates/base/agents/integration-hub.md +76 -0
- package/templates/base/analytics/README.md +114 -0
- package/templates/base/automation/config.json +58 -0
- package/templates/base/automation/generators/code-mapper.js +308 -0
- package/templates/base/automation/generators/index-builder.js +321 -0
- package/templates/base/automation/hooks/post-commit.sh +83 -0
- package/templates/base/automation/hooks/pre-commit.sh +103 -0
- package/templates/base/ci-templates/README.md +108 -0
- package/templates/base/ci-templates/github-actions/context-check.yml +144 -0
- package/templates/base/ci-templates/github-actions/validate-docs.yml +105 -0
- package/templates/base/commands/analytics.md +238 -0
- package/templates/base/commands/auto-sync.md +172 -0
- package/templates/base/commands/collab.md +194 -0
- package/templates/base/commands/help.md +450 -0
- package/templates/base/commands/rpi-implement.md +115 -0
- package/templates/base/commands/rpi-plan.md +93 -0
- package/templates/base/commands/rpi-research.md +88 -0
- package/templates/base/commands/session-resume.md +144 -0
- package/templates/base/commands/session-save.md +112 -0
- package/templates/base/commands/validate-all.md +77 -0
- package/templates/base/commands/verify-docs-current.md +86 -0
- package/templates/base/config/base.json +57 -0
- package/templates/base/config/environments/development.json +13 -0
- package/templates/base/config/environments/production.json +17 -0
- package/templates/base/config/environments/staging.json +13 -0
- package/templates/base/config/local.json.example +21 -0
- package/templates/base/context/.meta/generated-at.json +18 -0
- package/templates/base/context/ARCHITECTURE_SNAPSHOT.md +156 -0
- package/templates/base/context/CODE_TO_WORKFLOW_MAP.md +94 -0
- package/templates/base/context/FILE_OWNERSHIP.md +57 -0
- package/templates/base/context/INTEGRATION_POINTS.md +92 -0
- package/templates/base/context/KNOWN_GOTCHAS.md +195 -0
- package/templates/base/context/TESTING_MAP.md +95 -0
- package/templates/base/context/WORKFLOW_INDEX.md +129 -0
- package/templates/base/context/workflows/WORKFLOW_TEMPLATE.md +294 -0
- package/templates/base/indexes/agents/CAPABILITY_MATRIX.md +255 -0
- package/templates/base/indexes/agents/CATEGORY_INDEX.md +44 -0
- package/templates/base/indexes/code/CATEGORY_INDEX.md +38 -0
- package/templates/base/indexes/routing/CATEGORY_INDEX.md +39 -0
- package/templates/base/indexes/search/CATEGORY_INDEX.md +39 -0
- package/templates/base/indexes/workflows/CATEGORY_INDEX.md +38 -0
- package/templates/base/knowledge/README.md +98 -0
- package/templates/base/knowledge/sessions/README.md +88 -0
- package/templates/base/knowledge/sessions/TEMPLATE.md +150 -0
- package/templates/base/knowledge/shared/decisions/0001-adopt-context-engineering.md +144 -0
- package/templates/base/knowledge/shared/decisions/README.md +49 -0
- package/templates/base/knowledge/shared/decisions/TEMPLATE.md +123 -0
- package/templates/base/knowledge/shared/patterns/README.md +62 -0
- package/templates/base/knowledge/shared/patterns/TEMPLATE.md +120 -0
- package/templates/base/plans/PLAN_TEMPLATE.md +250 -0
- package/templates/base/plans/active/.gitkeep +0 -0
- package/templates/base/plans/completed/.gitkeep +0 -0
- package/templates/base/research/RESEARCH_TEMPLATE.md +153 -0
- package/templates/base/research/active/.gitkeep +0 -0
- package/templates/base/research/completed/.gitkeep +0 -0
- package/templates/base/schemas/agent.schema.json +141 -0
- package/templates/base/schemas/anchors.schema.json +54 -0
- package/templates/base/schemas/automation.schema.json +93 -0
- package/templates/base/schemas/command.schema.json +134 -0
- package/templates/base/schemas/hashes.schema.json +40 -0
- package/templates/base/schemas/manifest.schema.json +117 -0
- package/templates/base/schemas/plan.schema.json +136 -0
- package/templates/base/schemas/research.schema.json +115 -0
- package/templates/base/schemas/roles.schema.json +34 -0
- package/templates/base/schemas/session.schema.json +77 -0
- package/templates/base/schemas/settings.schema.json +244 -0
- package/templates/base/schemas/staleness.schema.json +53 -0
- package/templates/base/schemas/team-config.schema.json +42 -0
- package/templates/base/schemas/workflow.schema.json +126 -0
- package/templates/base/session/checkpoints/.gitkeep +2 -0
- package/templates/base/session/current/state.json +20 -0
- package/templates/base/session/history/.gitkeep +2 -0
- package/templates/base/settings.json +3 -0
- package/templates/base/standards/COMPATIBILITY.md +219 -0
- package/templates/base/standards/EXTENSION_GUIDELINES.md +280 -0
- package/templates/base/standards/QUALITY_CHECKLIST.md +211 -0
- package/templates/base/standards/README.md +66 -0
- package/templates/base/sync/anchors.json +6 -0
- package/templates/base/sync/hashes.json +6 -0
- package/templates/base/sync/staleness.json +10 -0
- package/templates/base/team/README.md +168 -0
- package/templates/base/team/config.json +79 -0
- package/templates/base/team/roles.json +145 -0
- package/templates/base/tools/bin/claude-context.js +151 -0
- package/templates/base/tools/lib/anchor-resolver.js +276 -0
- package/templates/base/tools/lib/config-loader.js +363 -0
- package/templates/base/tools/lib/detector.js +350 -0
- package/templates/base/tools/lib/diagnose.js +206 -0
- package/templates/base/tools/lib/drift-detector.js +373 -0
- package/templates/base/tools/lib/errors.js +199 -0
- package/templates/base/tools/lib/index.js +36 -0
- package/templates/base/tools/lib/init.js +192 -0
- package/templates/base/tools/lib/logger.js +230 -0
- package/templates/base/tools/lib/placeholder.js +201 -0
- package/templates/base/tools/lib/session-manager.js +354 -0
- package/templates/base/tools/lib/validate.js +521 -0
- package/templates/base/tools/package.json +49 -0
- package/templates/handlebars/antigravity.hbs +337 -0
- package/templates/handlebars/claude.hbs +184 -0
- package/templates/handlebars/cline.hbs +63 -0
- package/templates/handlebars/copilot.hbs +131 -0
- package/templates/handlebars/partials/gotcha-list.hbs +11 -0
- package/templates/handlebars/partials/header.hbs +3 -0
- package/templates/handlebars/partials/workflow-summary.hbs +16 -0
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
# Claude Context Engineering - Context Budget Check
|
|
2
|
+
#
|
|
3
|
+
# This workflow monitors context budget and documentation health.
|
|
4
|
+
# Copy this file to .github/workflows/context-check.yml to enable.
|
|
5
|
+
#
|
|
6
|
+
# Runs on:
|
|
7
|
+
# - Push to main/master branches
|
|
8
|
+
# - Weekly schedule
|
|
9
|
+
# - Manual trigger
|
|
10
|
+
|
|
11
|
+
name: Context Budget Check
|
|
12
|
+
|
|
13
|
+
on:
|
|
14
|
+
push:
|
|
15
|
+
branches:
|
|
16
|
+
- main
|
|
17
|
+
- master
|
|
18
|
+
paths:
|
|
19
|
+
- '.ai-context/**'
|
|
20
|
+
schedule:
|
|
21
|
+
# Run weekly on Monday at 9am UTC
|
|
22
|
+
- cron: '0 9 * * 1'
|
|
23
|
+
workflow_dispatch:
|
|
24
|
+
|
|
25
|
+
jobs:
|
|
26
|
+
context-health:
|
|
27
|
+
name: Check Context Engineering Health
|
|
28
|
+
runs-on: ubuntu-latest
|
|
29
|
+
|
|
30
|
+
steps:
|
|
31
|
+
- name: Checkout repository
|
|
32
|
+
uses: actions/checkout@v4
|
|
33
|
+
|
|
34
|
+
- name: Setup Node.js
|
|
35
|
+
uses: actions/setup-node@v4
|
|
36
|
+
with:
|
|
37
|
+
node-version: '18'
|
|
38
|
+
cache: 'npm'
|
|
39
|
+
cache-dependency-path: '.ai-context/tools/package-lock.json'
|
|
40
|
+
|
|
41
|
+
- name: Install CLI tools
|
|
42
|
+
run: |
|
|
43
|
+
cd .ai-context/tools
|
|
44
|
+
npm ci
|
|
45
|
+
|
|
46
|
+
- name: Run Full Diagnostics
|
|
47
|
+
id: diagnose
|
|
48
|
+
run: |
|
|
49
|
+
echo "🔬 Running diagnostics..."
|
|
50
|
+
npx .ai-context/tools/bin/claude-context.js diagnose --verbose > diagnostics.txt 2>&1
|
|
51
|
+
cat diagnostics.txt
|
|
52
|
+
continue-on-error: true
|
|
53
|
+
|
|
54
|
+
- name: Calculate Documentation Metrics
|
|
55
|
+
run: |
|
|
56
|
+
echo "📊 Calculating metrics..."
|
|
57
|
+
|
|
58
|
+
# Count workflow files
|
|
59
|
+
WORKFLOW_COUNT=$(find .ai-context/context/workflows -name "*.md" 2>/dev/null | wc -l || echo "0")
|
|
60
|
+
echo "Workflow files: $WORKFLOW_COUNT"
|
|
61
|
+
|
|
62
|
+
# Count agent files
|
|
63
|
+
AGENT_COUNT=$(find .ai-context/agents -name "*.md" 2>/dev/null | wc -l || echo "0")
|
|
64
|
+
echo "Agent files: $AGENT_COUNT"
|
|
65
|
+
|
|
66
|
+
# Count command files
|
|
67
|
+
COMMAND_COUNT=$(find .ai-context/commands -name "*.md" 2>/dev/null | wc -l || echo "0")
|
|
68
|
+
echo "Command files: $COMMAND_COUNT"
|
|
69
|
+
|
|
70
|
+
# Estimate total documentation tokens (rough: 1 token ≈ 4 chars)
|
|
71
|
+
TOTAL_CHARS=$(find .claude -name "*.md" -exec cat {} \; 2>/dev/null | wc -c || echo "0")
|
|
72
|
+
ESTIMATED_TOKENS=$((TOTAL_CHARS / 4))
|
|
73
|
+
echo "Estimated documentation tokens: $ESTIMATED_TOKENS"
|
|
74
|
+
|
|
75
|
+
# Calculate as percentage of budget
|
|
76
|
+
MAX_TOKENS=200000
|
|
77
|
+
PERCENTAGE=$((ESTIMATED_TOKENS * 100 / MAX_TOKENS))
|
|
78
|
+
echo "Context budget usage: ${PERCENTAGE}%"
|
|
79
|
+
|
|
80
|
+
# Save metrics
|
|
81
|
+
cat > metrics.json << EOF
|
|
82
|
+
{
|
|
83
|
+
"workflow_count": $WORKFLOW_COUNT,
|
|
84
|
+
"agent_count": $AGENT_COUNT,
|
|
85
|
+
"command_count": $COMMAND_COUNT,
|
|
86
|
+
"estimated_tokens": $ESTIMATED_TOKENS,
|
|
87
|
+
"budget_percentage": $PERCENTAGE,
|
|
88
|
+
"timestamp": "$(date -u +%Y-%m-%dT%H:%M:%SZ)"
|
|
89
|
+
}
|
|
90
|
+
EOF
|
|
91
|
+
|
|
92
|
+
cat metrics.json
|
|
93
|
+
|
|
94
|
+
- name: Check Budget Threshold
|
|
95
|
+
run: |
|
|
96
|
+
PERCENTAGE=$(jq '.budget_percentage' metrics.json)
|
|
97
|
+
echo "Current usage: ${PERCENTAGE}%"
|
|
98
|
+
|
|
99
|
+
if [ "$PERCENTAGE" -gt 60 ]; then
|
|
100
|
+
echo "⚠️ WARNING: Documentation exceeds 60% of context budget!"
|
|
101
|
+
echo "Consider compacting or splitting documentation."
|
|
102
|
+
exit 1
|
|
103
|
+
elif [ "$PERCENTAGE" -gt 40 ]; then
|
|
104
|
+
echo "📊 Documentation is at ${PERCENTAGE}% - approaching target limit"
|
|
105
|
+
else
|
|
106
|
+
echo "✅ Documentation is within healthy range (${PERCENTAGE}%)"
|
|
107
|
+
fi
|
|
108
|
+
|
|
109
|
+
- name: Run Validation Suite
|
|
110
|
+
run: |
|
|
111
|
+
echo "🔍 Running validation..."
|
|
112
|
+
npx .ai-context/tools/bin/claude-context.js validate --all > validation.txt 2>&1 || true
|
|
113
|
+
cat validation.txt
|
|
114
|
+
|
|
115
|
+
- name: Upload Metrics
|
|
116
|
+
uses: actions/upload-artifact@v4
|
|
117
|
+
with:
|
|
118
|
+
name: context-metrics
|
|
119
|
+
path: |
|
|
120
|
+
metrics.json
|
|
121
|
+
diagnostics.txt
|
|
122
|
+
validation.txt
|
|
123
|
+
retention-days: 30
|
|
124
|
+
|
|
125
|
+
- name: Create Issue on Failure
|
|
126
|
+
if: failure() && github.event_name == 'schedule'
|
|
127
|
+
uses: actions/github-script@v7
|
|
128
|
+
with:
|
|
129
|
+
script: |
|
|
130
|
+
const fs = require('fs');
|
|
131
|
+
let metrics = {};
|
|
132
|
+
try {
|
|
133
|
+
metrics = JSON.parse(fs.readFileSync('metrics.json', 'utf8'));
|
|
134
|
+
} catch (e) {
|
|
135
|
+
metrics = { error: 'Could not read metrics' };
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
github.rest.issues.create({
|
|
139
|
+
owner: context.repo.owner,
|
|
140
|
+
repo: context.repo.repo,
|
|
141
|
+
title: '⚠️ Claude Context Engineering Health Check Failed',
|
|
142
|
+
body: `## Weekly Health Check Failed\n\n**Metrics:**\n\`\`\`json\n${JSON.stringify(metrics, null, 2)}\n\`\`\`\n\n**Action Required:**\n- Review documentation health\n- Run \`npx claude-context diagnose\` locally\n- Consider documentation compaction if over budget\n\n---\n*Generated by Claude Context Engineering CI*`,
|
|
143
|
+
labels: ['documentation', 'maintenance']
|
|
144
|
+
});
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# Claude Context Engineering - Documentation Validation
|
|
2
|
+
#
|
|
3
|
+
# This workflow validates that documentation is accurate and up-to-date.
|
|
4
|
+
# Copy this file to .github/workflows/validate-docs.yml to enable.
|
|
5
|
+
#
|
|
6
|
+
# Runs on:
|
|
7
|
+
# - Pull requests that modify .ai-context/ or source files
|
|
8
|
+
# - Manual trigger
|
|
9
|
+
|
|
10
|
+
name: Validate Documentation
|
|
11
|
+
|
|
12
|
+
on:
|
|
13
|
+
pull_request:
|
|
14
|
+
paths:
|
|
15
|
+
- '.ai-context/**'
|
|
16
|
+
- 'src/**'
|
|
17
|
+
- 'lib/**'
|
|
18
|
+
- 'app/**'
|
|
19
|
+
workflow_dispatch:
|
|
20
|
+
|
|
21
|
+
jobs:
|
|
22
|
+
validate:
|
|
23
|
+
name: Validate Claude Context Documentation
|
|
24
|
+
runs-on: ubuntu-latest
|
|
25
|
+
|
|
26
|
+
steps:
|
|
27
|
+
- name: Checkout repository
|
|
28
|
+
uses: actions/checkout@v4
|
|
29
|
+
|
|
30
|
+
- name: Setup Node.js
|
|
31
|
+
uses: actions/setup-node@v4
|
|
32
|
+
with:
|
|
33
|
+
node-version: '18'
|
|
34
|
+
cache: 'npm'
|
|
35
|
+
cache-dependency-path: '.ai-context/tools/package-lock.json'
|
|
36
|
+
|
|
37
|
+
- name: Install CLI tools
|
|
38
|
+
run: |
|
|
39
|
+
cd .ai-context/tools
|
|
40
|
+
npm ci
|
|
41
|
+
|
|
42
|
+
- name: Validate JSON Schemas
|
|
43
|
+
run: |
|
|
44
|
+
echo "🔍 Validating JSON schemas..."
|
|
45
|
+
npx .ai-context/tools/bin/claude-context.js validate --schema
|
|
46
|
+
continue-on-error: false
|
|
47
|
+
|
|
48
|
+
- name: Validate Markdown Links
|
|
49
|
+
run: |
|
|
50
|
+
echo "🔗 Checking markdown links..."
|
|
51
|
+
npx .ai-context/tools/bin/claude-context.js validate --links
|
|
52
|
+
continue-on-error: false
|
|
53
|
+
|
|
54
|
+
- name: Check for Unresolved Placeholders
|
|
55
|
+
run: |
|
|
56
|
+
echo "📝 Checking for placeholders..."
|
|
57
|
+
npx .ai-context/tools/bin/claude-context.js validate --placeholders
|
|
58
|
+
continue-on-error: true # Warning only
|
|
59
|
+
|
|
60
|
+
- name: Validate Directory Structure
|
|
61
|
+
run: |
|
|
62
|
+
echo "📁 Validating structure..."
|
|
63
|
+
npx .ai-context/tools/bin/claude-context.js validate --structure
|
|
64
|
+
continue-on-error: false
|
|
65
|
+
|
|
66
|
+
- name: Check Line Number Accuracy
|
|
67
|
+
run: |
|
|
68
|
+
echo "📍 Checking line number accuracy..."
|
|
69
|
+
npx .ai-context/tools/bin/claude-context.js validate --lines --threshold 60
|
|
70
|
+
continue-on-error: true # Warning only for line drift
|
|
71
|
+
|
|
72
|
+
- name: Generate Validation Report
|
|
73
|
+
if: always()
|
|
74
|
+
run: |
|
|
75
|
+
echo "📊 Generating full validation report..."
|
|
76
|
+
npx .ai-context/tools/bin/claude-context.js validate --all --output markdown > validation-report.md
|
|
77
|
+
cat validation-report.md
|
|
78
|
+
|
|
79
|
+
- name: Upload Validation Report
|
|
80
|
+
if: always()
|
|
81
|
+
uses: actions/upload-artifact@v4
|
|
82
|
+
with:
|
|
83
|
+
name: validation-report
|
|
84
|
+
path: validation-report.md
|
|
85
|
+
retention-days: 7
|
|
86
|
+
|
|
87
|
+
- name: Comment on PR
|
|
88
|
+
if: github.event_name == 'pull_request' && failure()
|
|
89
|
+
uses: actions/github-script@v7
|
|
90
|
+
with:
|
|
91
|
+
script: |
|
|
92
|
+
const fs = require('fs');
|
|
93
|
+
let report = '';
|
|
94
|
+
try {
|
|
95
|
+
report = fs.readFileSync('validation-report.md', 'utf8');
|
|
96
|
+
} catch (e) {
|
|
97
|
+
report = 'Validation report not available.';
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
github.rest.issues.createComment({
|
|
101
|
+
issue_number: context.issue.number,
|
|
102
|
+
owner: context.repo.owner,
|
|
103
|
+
repo: context.repo.repo,
|
|
104
|
+
body: `## 🔍 Documentation Validation Failed\n\n${report}\n\n---\n*Generated by Claude Context Engineering CI*`
|
|
105
|
+
});
|
|
@@ -0,0 +1,238 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: analytics
|
|
3
|
+
version: "1.0.0"
|
|
4
|
+
displayName: "Usage Analytics"
|
|
5
|
+
description: "View local usage statistics and context metrics"
|
|
6
|
+
category: "system"
|
|
7
|
+
complexity: "low"
|
|
8
|
+
context_budget: "~5K tokens"
|
|
9
|
+
typical_context_usage: "2%"
|
|
10
|
+
prerequisites:
|
|
11
|
+
- "Analytics enabled in settings (optional)"
|
|
12
|
+
outputs:
|
|
13
|
+
- "Usage statistics report"
|
|
14
|
+
- "Context metrics summary"
|
|
15
|
+
- "Exported metrics file (with --export)"
|
|
16
|
+
related_agents: []
|
|
17
|
+
examples:
|
|
18
|
+
- command: "/analytics"
|
|
19
|
+
description: "View local usage statistics"
|
|
20
|
+
- command: "/analytics context"
|
|
21
|
+
description: "Show context budget metrics"
|
|
22
|
+
- command: "/analytics export"
|
|
23
|
+
description: "Export metrics to JSON file"
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
# /analytics - Usage Analytics Command
|
|
27
|
+
|
|
28
|
+
View local usage statistics, context metrics, and export data for analysis.
|
|
29
|
+
|
|
30
|
+
## Privacy First
|
|
31
|
+
|
|
32
|
+
**All analytics are local by default.** No data is sent externally unless explicitly configured in `.ai-context/settings.json`:
|
|
33
|
+
|
|
34
|
+
```json
|
|
35
|
+
{
|
|
36
|
+
"telemetry": {
|
|
37
|
+
"enabled": false
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Subcommands
|
|
43
|
+
|
|
44
|
+
### `/analytics` (default)
|
|
45
|
+
|
|
46
|
+
Display summary of local usage statistics.
|
|
47
|
+
|
|
48
|
+
**Metrics Shown:**
|
|
49
|
+
- Session count (last 7/30 days)
|
|
50
|
+
- Command usage frequency
|
|
51
|
+
- Agent invocation counts
|
|
52
|
+
- Average session duration
|
|
53
|
+
- Files modified per session
|
|
54
|
+
|
|
55
|
+
### `/analytics context`
|
|
56
|
+
|
|
57
|
+
Show context budget metrics and trends.
|
|
58
|
+
|
|
59
|
+
**Metrics Shown:**
|
|
60
|
+
- Current documentation size (tokens)
|
|
61
|
+
- Budget utilization percentage
|
|
62
|
+
- Largest context consumers
|
|
63
|
+
- Token trend over time
|
|
64
|
+
- Recommendations for optimization
|
|
65
|
+
|
|
66
|
+
### `/analytics commands`
|
|
67
|
+
|
|
68
|
+
Show command usage breakdown.
|
|
69
|
+
|
|
70
|
+
**Metrics Shown:**
|
|
71
|
+
- Most used commands
|
|
72
|
+
- Command success/failure rates
|
|
73
|
+
- Average command duration
|
|
74
|
+
- Command usage by day/week
|
|
75
|
+
|
|
76
|
+
### `/analytics agents`
|
|
77
|
+
|
|
78
|
+
Show agent utilization breakdown.
|
|
79
|
+
|
|
80
|
+
**Metrics Shown:**
|
|
81
|
+
- Most invoked agents
|
|
82
|
+
- Agent task completion rates
|
|
83
|
+
- Average context per agent
|
|
84
|
+
- Agent usage patterns
|
|
85
|
+
|
|
86
|
+
### `/analytics export`
|
|
87
|
+
|
|
88
|
+
Export metrics to JSON file.
|
|
89
|
+
|
|
90
|
+
**Output:** `.ai-context/analytics/export-YYYY-MM-DD.json`
|
|
91
|
+
|
|
92
|
+
### `/analytics clear`
|
|
93
|
+
|
|
94
|
+
Clear local analytics data.
|
|
95
|
+
|
|
96
|
+
**Confirmation required** before clearing.
|
|
97
|
+
|
|
98
|
+
## Usage Examples
|
|
99
|
+
|
|
100
|
+
### View Summary Statistics
|
|
101
|
+
|
|
102
|
+
```
|
|
103
|
+
User: /analytics
|
|
104
|
+
|
|
105
|
+
Claude: ## Usage Analytics (Local)
|
|
106
|
+
|
|
107
|
+
### Session Summary (Last 30 Days)
|
|
108
|
+
| Metric | Value |
|
|
109
|
+
|--------|-------|
|
|
110
|
+
| Total Sessions | 42 |
|
|
111
|
+
| Avg Duration | 45 min |
|
|
112
|
+
| Files Modified | 312 |
|
|
113
|
+
| Commits Made | 87 |
|
|
114
|
+
|
|
115
|
+
### Top Commands
|
|
116
|
+
1. /rpi-research (23 uses)
|
|
117
|
+
2. /rpi-implement (19 uses)
|
|
118
|
+
3. /verify-docs-current (15 uses)
|
|
119
|
+
4. /rpi-plan (12 uses)
|
|
120
|
+
5. /help (8 uses)
|
|
121
|
+
|
|
122
|
+
### Top Agents
|
|
123
|
+
1. @core-architect (18 invocations)
|
|
124
|
+
2. @api-developer (14 invocations)
|
|
125
|
+
3. @database-ops (9 invocations)
|
|
126
|
+
|
|
127
|
+
### Context Health
|
|
128
|
+
- Documentation: 45K tokens (23% of budget)
|
|
129
|
+
- Status: Healthy ✓
|
|
130
|
+
|
|
131
|
+
Data stored locally in .ai-context/analytics/
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### View Context Metrics
|
|
135
|
+
|
|
136
|
+
```
|
|
137
|
+
User: /analytics context
|
|
138
|
+
|
|
139
|
+
Claude: ## Context Budget Analysis
|
|
140
|
+
|
|
141
|
+
### Current State
|
|
142
|
+
| Category | Tokens | % Budget |
|
|
143
|
+
|----------|--------|----------|
|
|
144
|
+
| Indexes | 12,400 | 6.2% |
|
|
145
|
+
| Workflows | 18,200 | 9.1% |
|
|
146
|
+
| Agents | 8,600 | 4.3% |
|
|
147
|
+
| Commands | 5,800 | 2.9% |
|
|
148
|
+
| **Total** | **45,000** | **22.5%** |
|
|
149
|
+
|
|
150
|
+
### Budget Status
|
|
151
|
+
✓ Under 40% target (healthy)
|
|
152
|
+
|
|
153
|
+
### Largest Files
|
|
154
|
+
1. context/workflows/authentication.md (4,200 tokens)
|
|
155
|
+
2. context/ARCHITECTURE_SNAPSHOT.md (3,800 tokens)
|
|
156
|
+
3. agents/core-architect.md (2,100 tokens)
|
|
157
|
+
|
|
158
|
+
### Trend (Last 4 Weeks)
|
|
159
|
+
Week 1: 42K tokens
|
|
160
|
+
Week 2: 43K tokens
|
|
161
|
+
Week 3: 44K tokens
|
|
162
|
+
Week 4: 45K tokens (+7% growth)
|
|
163
|
+
|
|
164
|
+
### Recommendations
|
|
165
|
+
- Growth rate sustainable
|
|
166
|
+
- No immediate action needed
|
|
167
|
+
- Review if exceeds 50K tokens
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### Export Metrics
|
|
171
|
+
|
|
172
|
+
```
|
|
173
|
+
User: /analytics export
|
|
174
|
+
|
|
175
|
+
Claude: Exporting analytics data...
|
|
176
|
+
|
|
177
|
+
Exported to: .ai-context/analytics/export-2024-01-15.json
|
|
178
|
+
|
|
179
|
+
Contents:
|
|
180
|
+
- Session history (42 sessions)
|
|
181
|
+
- Command usage (156 invocations)
|
|
182
|
+
- Agent usage (41 invocations)
|
|
183
|
+
- Context metrics (4 weekly snapshots)
|
|
184
|
+
|
|
185
|
+
File size: 24 KB
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
## Data Storage
|
|
189
|
+
|
|
190
|
+
Analytics data is stored locally in `.ai-context/analytics/`:
|
|
191
|
+
|
|
192
|
+
```
|
|
193
|
+
.ai-context/analytics/
|
|
194
|
+
├── sessions.json # Session history
|
|
195
|
+
├── commands.json # Command usage
|
|
196
|
+
├── agents.json # Agent invocations
|
|
197
|
+
├── context.json # Context metrics
|
|
198
|
+
└── exports/ # Exported files
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
## Configuration
|
|
202
|
+
|
|
203
|
+
Configure analytics behavior in `.ai-context/settings.json`:
|
|
204
|
+
|
|
205
|
+
```json
|
|
206
|
+
{
|
|
207
|
+
"telemetry": {
|
|
208
|
+
"enabled": false,
|
|
209
|
+
"events": {
|
|
210
|
+
"command_usage": true,
|
|
211
|
+
"context_metrics": true,
|
|
212
|
+
"error_reports": false
|
|
213
|
+
},
|
|
214
|
+
"retention_days": 90
|
|
215
|
+
}
|
|
216
|
+
}
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
| Setting | Default | Description |
|
|
220
|
+
|---------|---------|-------------|
|
|
221
|
+
| `enabled` | false | Enable/disable all tracking |
|
|
222
|
+
| `command_usage` | true | Track command invocations |
|
|
223
|
+
| `context_metrics` | true | Track context budget |
|
|
224
|
+
| `error_reports` | false | Track errors (local only) |
|
|
225
|
+
| `retention_days` | 90 | Days to retain data |
|
|
226
|
+
|
|
227
|
+
## Privacy Notes
|
|
228
|
+
|
|
229
|
+
1. **Local Only**: All data stays on your machine
|
|
230
|
+
2. **No External Calls**: Nothing sent to external services
|
|
231
|
+
3. **User Control**: Clear data anytime with `/analytics clear`
|
|
232
|
+
4. **Opt-in**: Tracking disabled by default
|
|
233
|
+
5. **Transparent**: All data in readable JSON files
|
|
234
|
+
|
|
235
|
+
## Related
|
|
236
|
+
|
|
237
|
+
- [Settings Configuration](./../settings.json)
|
|
238
|
+
- [Context Budget Guidelines](./../README.md#context-budget)
|
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: auto-sync
|
|
3
|
+
description: Automatically synchronize documentation with code
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
category: sync
|
|
6
|
+
context_budget: 15000
|
|
7
|
+
outputs:
|
|
8
|
+
- context/CODE_TO_WORKFLOW_MAP.md (regenerated)
|
|
9
|
+
- sync/anchors.json (updated)
|
|
10
|
+
- sync/hashes.json (updated)
|
|
11
|
+
- sync/staleness.json (updated)
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# /auto-sync
|
|
15
|
+
|
|
16
|
+
Automatically synchronize all documentation with the current code state.
|
|
17
|
+
|
|
18
|
+
## Syntax
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
/auto-sync [options]
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Options
|
|
25
|
+
|
|
26
|
+
| Option | Description |
|
|
27
|
+
|--------|-------------|
|
|
28
|
+
| `--check` | Check for drift without making changes |
|
|
29
|
+
| `--fix` | Auto-fix shifted line numbers and anchors |
|
|
30
|
+
| `--rebuild-map` | Force rebuild CODE_TO_WORKFLOW_MAP |
|
|
31
|
+
| `--update-hashes` | Update file content hashes |
|
|
32
|
+
| `--report` | Generate detailed drift report |
|
|
33
|
+
| `--dry-run` | Preview changes without writing |
|
|
34
|
+
|
|
35
|
+
## What It Does
|
|
36
|
+
|
|
37
|
+
1. **Scans Workflows** - Extracts all file:line references from documentation
|
|
38
|
+
2. **Resolves Anchors** - Converts semantic anchors to current line numbers
|
|
39
|
+
3. **Detects Drift** - Compares documented references with actual code
|
|
40
|
+
4. **Updates Tracking** - Refreshes hashes and staleness timestamps
|
|
41
|
+
5. **Regenerates Map** - Rebuilds CODE_TO_WORKFLOW_MAP.md
|
|
42
|
+
|
|
43
|
+
## Examples
|
|
44
|
+
|
|
45
|
+
### Check for Drift
|
|
46
|
+
```
|
|
47
|
+
/auto-sync --check
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Output:
|
|
51
|
+
```
|
|
52
|
+
DRIFT CHECK REPORT
|
|
53
|
+
|
|
54
|
+
Workflows Checked: 8
|
|
55
|
+
✓ authentication.md - HEALTHY
|
|
56
|
+
⚠ user-management.md - NEEDS UPDATE (3 line shifts)
|
|
57
|
+
✗ payment.md - STALE (file deleted)
|
|
58
|
+
|
|
59
|
+
Summary:
|
|
60
|
+
Healthy: 6
|
|
61
|
+
Needs Update: 1
|
|
62
|
+
Stale: 1
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Auto-Fix Issues
|
|
66
|
+
```
|
|
67
|
+
/auto-sync --fix
|
|
68
|
+
```
|
|
69
|
+
Automatically updates line numbers that have shifted.
|
|
70
|
+
|
|
71
|
+
### Full Rebuild
|
|
72
|
+
```
|
|
73
|
+
/auto-sync --rebuild-map
|
|
74
|
+
```
|
|
75
|
+
Regenerates CODE_TO_WORKFLOW_MAP.md from scratch.
|
|
76
|
+
|
|
77
|
+
## Drift Levels
|
|
78
|
+
|
|
79
|
+
| Level | Meaning | Action |
|
|
80
|
+
|-------|---------|--------|
|
|
81
|
+
| HEALTHY | Documentation matches code | None needed |
|
|
82
|
+
| LOW | Line numbers shifted slightly | Auto-fixable |
|
|
83
|
+
| MEDIUM | Function moved or renamed | Review required |
|
|
84
|
+
| HIGH | Logic changed significantly | Manual update needed |
|
|
85
|
+
| CRITICAL | File deleted or major restructure | Full re-documentation |
|
|
86
|
+
|
|
87
|
+
## Integration
|
|
88
|
+
|
|
89
|
+
### With Git Hooks
|
|
90
|
+
The pre-commit hook can run `--check` automatically:
|
|
91
|
+
```bash
|
|
92
|
+
npx claude-context hooks install
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### With CI/CD
|
|
96
|
+
Add to your pipeline:
|
|
97
|
+
```yaml
|
|
98
|
+
- name: Check documentation drift
|
|
99
|
+
run: npx claude-context sync --check --strict
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## Process
|
|
103
|
+
|
|
104
|
+
```
|
|
105
|
+
1. Load workflow files from context/workflows/
|
|
106
|
+
|
|
107
|
+
2. For each workflow:
|
|
108
|
+
a. Extract file:line references
|
|
109
|
+
b. Extract semantic anchors (file::function())
|
|
110
|
+
c. Resolve current locations
|
|
111
|
+
d. Compare with documented locations
|
|
112
|
+
|
|
113
|
+
3. Generate drift report
|
|
114
|
+
|
|
115
|
+
4. If --fix:
|
|
116
|
+
a. Update shifted line numbers
|
|
117
|
+
b. Update broken anchors where possible
|
|
118
|
+
c. Flag unfixable issues
|
|
119
|
+
|
|
120
|
+
5. If --rebuild-map:
|
|
121
|
+
a. Scan all workflows for references
|
|
122
|
+
b. Build reverse index
|
|
123
|
+
c. Write CODE_TO_WORKFLOW_MAP.md
|
|
124
|
+
|
|
125
|
+
6. Update tracking files:
|
|
126
|
+
- sync/hashes.json
|
|
127
|
+
- sync/staleness.json
|
|
128
|
+
- sync/anchors.json
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
## Output Files
|
|
132
|
+
|
|
133
|
+
### CODE_TO_WORKFLOW_MAP.md
|
|
134
|
+
```markdown
|
|
135
|
+
## File Mappings
|
|
136
|
+
|
|
137
|
+
### src/auth.py
|
|
138
|
+
|
|
139
|
+
**Documented In:**
|
|
140
|
+
- workflows/authentication.md
|
|
141
|
+
- workflows/session.md
|
|
142
|
+
|
|
143
|
+
**Update After Changing:**
|
|
144
|
+
- [ ] authentication.md (lines 45, 78, 120)
|
|
145
|
+
- [ ] session.md (line 33)
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### sync/staleness.json
|
|
149
|
+
```json
|
|
150
|
+
{
|
|
151
|
+
"workflows": {
|
|
152
|
+
"authentication.md": {
|
|
153
|
+
"lastVerified": "2025-01-24T10:30:00Z",
|
|
154
|
+
"status": "verified"
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
## Related Commands
|
|
161
|
+
|
|
162
|
+
- `/verify-docs-current [file]` - Check specific file
|
|
163
|
+
- `/validate-all` - Full validation suite
|
|
164
|
+
- `/session-save` - Save session state
|
|
165
|
+
|
|
166
|
+
## CLI Equivalent
|
|
167
|
+
|
|
168
|
+
```bash
|
|
169
|
+
npx claude-context sync --check
|
|
170
|
+
npx claude-context sync --fix
|
|
171
|
+
npx claude-context generate --code-map
|
|
172
|
+
```
|