@nerviq/cli 1.0.0 → 1.0.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nerviq/cli",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "The intelligent nervous system for AI coding agents — 673 checks across 8 platforms. Audit, align, and amplify.",
5
5
  "main": "src/index.js",
6
6
  "bin": {
@@ -9,10 +9,8 @@
9
9
  },
10
10
  "files": [
11
11
  "bin",
12
- "content",
13
12
  "src",
14
- "README.md",
15
- "CHANGELOG.md"
13
+ "README.md"
16
14
  ],
17
15
  "scripts": {
18
16
  "start": "node bin/cli.js",
@@ -20,7 +18,7 @@
20
18
  "test": "node test/run.js",
21
19
  "test:jest": "jest",
22
20
  "test:coverage": "jest --coverage",
23
- "test:all": "node test/run.js && node test/check-matrix.js && node test/codex-check-matrix.js && node test/golden-matrix.js && node test/codex-golden-matrix.js && node test/gemini-check-matrix.js && node test/gemini-golden-matrix.js && node test/copilot-check-matrix.js && node test/copilot-golden-matrix.js && node test/cursor-check-matrix.js && node test/cursor-golden-matrix.js && node test/security-tests.js && jest",
21
+ "test:all": "npm test && npx jest && node test/check-matrix.js && node test/codex-check-matrix.js && node test/gemini-check-matrix.js && node test/copilot-check-matrix.js && node test/cursor-check-matrix.js && node test/golden-matrix.js && node test/codex-golden-matrix.js && node test/gemini-golden-matrix.js && node test/copilot-golden-matrix.js && node test/cursor-golden-matrix.js",
24
22
  "benchmark:perf": "node tools/benchmark.js",
25
23
  "catalog": "node -e \"const {generateCatalog}=require('./src/catalog');console.log(JSON.stringify(generateCatalog(),null,2))\""
26
24
  },
package/src/audit.js CHANGED
@@ -25,6 +25,7 @@ const { OpenCodeProjectContext } = require('./opencode/context');
25
25
  const { getBadgeMarkdown } = require('./badge');
26
26
  const { sendInsights, getLocalInsights } = require('./insights');
27
27
  const { getRecommendationOutcomeSummary, getRecommendationAdjustment } = require('./activity');
28
+ const { getFeedbackSummary } = require('./feedback');
28
29
  const { formatSarif } = require('./formatters/sarif');
29
30
  const { loadPlugins, mergePluginChecks } = require('./plugins');
30
31
 
@@ -441,24 +442,48 @@ function getQuickWins(failed, options = {}) {
441
442
  .slice(0, 3);
442
443
  }
443
444
 
444
- function getRecommendationPriorityScore(item, outcomeSummaryByKey = {}) {
445
+ /**
446
+ * Compute a multiplier based on FP (helpful/not-helpful) feedback for a check key.
447
+ * - >50% "not helpful" feedback: lower priority by 30% (multiplier 0.7)
448
+ * - >80% "helpful" feedback: boost priority by 20% (multiplier 1.2)
449
+ * - Otherwise: no change (multiplier 1.0)
450
+ * @param {Object} fpFeedbackByKey - Keyed feedback summary from getFeedbackSummary().byKey
451
+ * @param {string} key - The check key to look up
452
+ * @returns {number} Multiplier to apply to priority score
453
+ */
454
+ function getFpFeedbackMultiplier(fpFeedbackByKey, key) {
455
+ if (!fpFeedbackByKey) return 1.0;
456
+ const bucket = fpFeedbackByKey[key];
457
+ if (!bucket || bucket.total === 0) return 1.0;
458
+
459
+ const unhelpfulRate = bucket.unhelpful / bucket.total;
460
+ const helpfulRate = bucket.helpful / bucket.total;
461
+
462
+ if (unhelpfulRate > 0.5) return 0.7;
463
+ if (helpfulRate > 0.8) return 1.2;
464
+ return 1.0;
465
+ }
466
+
467
+ function getRecommendationPriorityScore(item, outcomeSummaryByKey = {}, fpFeedbackByKey = null) {
445
468
  const impactScore = (IMPACT_ORDER[item.impact] ?? 0) * 100;
446
469
  const feedbackAdjustment = getRecommendationAdjustment(outcomeSummaryByKey, item.key);
447
470
  const brevityPenalty = Math.min((item.fix || '').length, 240) / 20;
448
- return impactScore + (feedbackAdjustment * 10) - brevityPenalty;
471
+ const raw = impactScore + (feedbackAdjustment * 10) - brevityPenalty;
472
+ return raw * getFpFeedbackMultiplier(fpFeedbackByKey, item.key);
449
473
  }
450
474
 
451
475
  function buildTopNextActions(failed, limit = 5, outcomeSummaryByKey = {}, options = {}) {
452
476
  const pool = getPrioritizedFailed(failed);
477
+ const fpByKey = options.fpFeedbackByKey || null;
453
478
 
454
479
  return [...pool]
455
480
  .sort((a, b) => {
456
481
  const scoreB = options.platform === 'codex'
457
482
  ? codexPriorityScore(b, outcomeSummaryByKey)
458
- : getRecommendationPriorityScore(b, outcomeSummaryByKey);
483
+ : getRecommendationPriorityScore(b, outcomeSummaryByKey, fpByKey);
459
484
  const scoreA = options.platform === 'codex'
460
485
  ? codexPriorityScore(a, outcomeSummaryByKey)
461
- : getRecommendationPriorityScore(a, outcomeSummaryByKey);
486
+ : getRecommendationPriorityScore(a, outcomeSummaryByKey, fpByKey);
462
487
  return scoreB - scoreA;
463
488
  })
464
489
  .slice(0, limit)
@@ -479,7 +504,7 @@ function buildTopNextActions(failed, limit = 5, outcomeSummaryByKey = {}, option
479
504
  const evidenceClass = options.platform === 'codex' ? codexEvidenceClass(fullItem) : (feedback ? 'measured' : 'estimated');
480
505
  const priorityScore = options.platform === 'codex'
481
506
  ? codexPriorityScore(fullItem, outcomeSummaryByKey)
482
- : Math.max(0, Math.min(100, Math.round(getRecommendationPriorityScore(fullItem, outcomeSummaryByKey) / 3)));
507
+ : Math.max(0, Math.min(100, Math.round(getRecommendationPriorityScore(fullItem, outcomeSummaryByKey, fpByKey) / 3)));
483
508
 
484
509
  signals.push(`evidence:${evidenceClass}`);
485
510
  if (options.platform === 'codex' && CODEX_HARD_FAIL_KEYS.has(key)) {
@@ -728,6 +753,7 @@ async function audit(options) {
728
753
  const stacks = ctx.detectStacks(STACKS);
729
754
  const results = [];
730
755
  const outcomeSummary = getRecommendationOutcomeSummary(options.dir);
756
+ const fpFeedback = getFeedbackSummary(options.dir);
731
757
 
732
758
  // Load and merge plugin checks
733
759
  const plugins = loadPlugins(options.dir);
@@ -795,7 +821,7 @@ async function audit(options) {
795
821
  const organicEarned = organicPassed.reduce((sum, r) => sum + (WEIGHTS[r.impact] || 5), 0);
796
822
  const organicScore = maxScore > 0 ? Math.round((organicEarned / maxScore) * 100) : 0;
797
823
  const quickWins = getQuickWins(failed, { platform: spec.platform });
798
- const topNextActions = buildTopNextActions(failed, 5, outcomeSummary.byKey, { platform: spec.platform });
824
+ const topNextActions = buildTopNextActions(failed, 5, outcomeSummary.byKey, { platform: spec.platform, fpFeedbackByKey: fpFeedback.byKey });
799
825
  const categoryScores = computeCategoryScores(applicable, passed);
800
826
  const platformScopeNote = getPlatformScopeNote(spec, ctx);
801
827
  const platformCaveats = getPlatformCaveats(spec, ctx);
@@ -1008,4 +1034,4 @@ async function audit(options) {
1008
1034
  return result;
1009
1035
  }
1010
1036
 
1011
- module.exports = { audit, buildTopNextActions };
1037
+ module.exports = { audit, buildTopNextActions, getFpFeedbackMultiplier, getRecommendationPriorityScore };
package/CHANGELOG.md DELETED
@@ -1,198 +0,0 @@
1
- # Changelog
2
-
3
- ## 1.0.0 — 2026-04-05
4
- ### 🎉 First Stable Release
5
- - 8 platforms: Claude Code, Codex, Gemini CLI, GitHub Copilot, Cursor, Windsurf, Aider, OpenCode
6
- - 673 checks with sourceUrl and confidence on every check
7
- - Harmony: cross-platform drift detection and alignment
8
- - Synergy: multi-agent amplification and task routing
9
- - Plugin system: custom checks via nerviq.config.js
10
- - SDK: @nerviq/sdk with TypeScript types
11
- - REST API: nerviq serve --port 3000
12
- - MCP Server: nerviq as MCP tool provider
13
- - VS Code Extension
14
- - GitHub Action with SARIF support
15
- - Performance: 226ms total audit across 8 platforms
16
- - CLI commands: audit, setup, plan, apply, governance, benchmark, harmony-audit, synergy-report, deep-review, interactive, watch, history, compare, trend, feedback, catalog, certify, doctor, convert, migrate, serve
17
- - 213 tests across 21 test suites
18
- - AGPL-3.0 license
19
-
20
- ## [1.16.2] - 2026-04-03
21
-
22
- ### Changed
23
- - bumped the local release line to `1.16.2` so the next publish does not overwrite the already-live `1.16.1` npm release
24
- - synchronized README, docs, launch copy, and proof-facing state to distinguish clearly between public npm latest (`1.16.1`) and local release prep (`1.16.2`)
25
-
26
- ### Fixed
27
- - release-truth drift across package metadata, docs, and public-facing proof references
28
-
29
- ## [1.16.1] - 2026-04-03
30
-
31
- ### Added
32
- - `feedback` command validation on the public npm package line
33
- - stronger secret detection coverage for Anthropic-style keys
34
- - deep-review sanitization and secret redaction hardening
35
- - watch-mode resilience improvements across recursive and non-recursive platforms
36
-
37
- ### Changed
38
- - increased verified check count from `84` to `85`
39
- - proof-backed product copy and case-study traceability improvements
40
-
41
- ## [1.10.3] - 2026-04-02
42
-
43
- ### Added
44
- - `--snapshot` support for `audit`, `augment`, `suggest-only`, `benchmark`, and `governance`, writing normalized evidence artifacts under `.claude/claudex-setup/snapshots/`
45
- - shared snapshot history via `index.json` so before/after work can accumulate into a single local evidence spine
46
- - `governance --out governance.md` for a shareable governance / pilot-readiness artifact
47
- - packaged Claude-native `audit-repo` skill template under `content/claude-code/audit-repo/`
48
- - lightweight release checklist in `content/release-checklist.md`
49
-
50
- ### Changed
51
- - default audit now surfaces `Top 5 Next Actions` with rationale, traceability, risk, confidence, and a suggested next command
52
- - `--lite` now gives a shorter beginner-first top-3 quick scan
53
- - README and docs now reflect snapshot artifacts, governance export, and the Claude-native skill path
54
- - packaged content and public-facing counts are now aligned with the current CLAUDEX state
55
-
56
- ## [1.14.0] - 2026-04-03
57
-
58
- ### Added
59
- - Check-level test matrix: 327 verified scenarios across all 84 checks
60
- - Golden matrix: 12 repo profile tests with expected results
61
-
62
- ### Fixed
63
- - `hooks` check now detects hooks in settings.json (not only .claude/hooks/ dir)
64
- - `context7Mcp` check now reads .mcp.json
65
- - `skillUsesPaths` now traverses skill subdirectories (skills/name/SKILL.md)
66
- - `lintCommand` now matches npm/yarn/pnpm/bun lint commands
67
-
68
- ## [1.13.0] - 2026-04-03
69
-
70
- ### Added
71
- - 10 new checks (74→84): project description, directory structure, multiple hook types, stop-failure hook, skill paths, MCP env config, gitignore local settings, .env.example, package scripts, type checking
72
- - 15 new tests (58→73): history/compare/trend, new checks structure, CLI commands, deny depth, negative instructions, --require flag
73
- - All references updated to 74→84 checks
74
-
75
- ## [1.12.0] - 2026-04-03
76
-
77
- ### Added
78
- - 12 new checks (62→74): test coverage, agent tool restrictions, auto-memory, sandbox, deny rule depth, git attribution, effort level, snapshot history, worktree, negative instructions, output style, CI variants
79
- - 8 new stacks (22→30): Deno, Bun, Elixir, Astro, Remix, NestJS, Laravel, .NET
80
- - Deeper domain detection: llamaindex, crewai, autogen, ollama for AI/ML; paypal, square, adyen, medusa for ecommerce; chromatic, style-dictionary for design; capacitor, ionic for mobile
81
-
82
- ### Fixed
83
- - `githubActionsOrCI` check used non-existent `ctx.hasFile()` — now uses `ctx.fileContent()`
84
- - `.NET` stack detection no longer uses glob patterns
85
-
86
- ## [1.11.0] - 2026-04-03
87
-
88
- ### Added
89
- - `history` command — show score timeline from saved snapshots
90
- - `compare` command — diff latest vs previous snapshot with delta, regressions, improvements
91
- - `trend --out report.md` — export trend report as shareable markdown
92
- - `--require A,B` CI flag — exit code 1 if named checks fail (policy guardrails)
93
- - Agentic DX positioning in README
94
- - Real results table (4 case studies) in README
95
- - Claude-native integration guide (skill, hook, agent examples)
96
- - Trust-first help text reordering
97
-
98
- ### Fixed
99
- - Hook checks (hooksInSettings, preToolUse, postToolUse, sessionStart) now OR across settings.json and settings.local.json
100
-
101
- ## [1.10.2] - 2026-04-02
102
-
103
- ### Fixed
104
- - MCP recommendations are now less speculative: `postgres-mcp` requires explicit Postgres signals, `figma-mcp` only appears for design-system repos, and `mcp-security` is no longer auto-added just because multiple packs were suggested
105
- - `sentry-mcp` now requires real observability signals or stricter operational domains instead of appearing for every frontend/backend repo
106
- - design-system detection now respects `.storybook/` directories directly, improving frontend pack accuracy
107
-
108
- ### Added
109
- - MCP preflight warnings for `setup`, `plan`, and `apply` when selected packs require missing environment variables
110
- - user-facing docs now reflect the actual 22 detected stacks
111
-
112
- ## [1.10.1] - 2026-04-02
113
-
114
- ### Fixed
115
- - corrected MCP pack package names to verified npm packages
116
- - aligned settings hierarchy checks with shared settings precedence
117
-
118
- ## [1.10.0] - 2026-04-01
119
-
120
- ### Added
121
- - 11 new MCP packs (15→26): sequential-thinking, jira-confluence, ga4-analytics, search-console, n8n-workflows, zendesk, infisical-secrets, shopify, huggingface, blender, wordpress
122
- - 7 new domain packs (10→17→16 final): ecommerce, ai-ml, devops-cicd, design-system, docs-content, security-focused
123
- - Smart recommendation for all new packs based on detected stack and domain
124
- - Detection logic: Storybook, Docusaurus, Stripe, LangChain, GitHub Actions, auth deps
125
-
126
- ## [1.9.0] - 2026-03-31
127
-
128
- ### Added
129
- - 3 new domain packs: `monorepo`, `mobile`, `regulated-lite` (7→10 total)
130
- - 3 new MCP packs: `github-mcp`, `postgres-mcp`, `memory-mcp` (2→5 total)
131
- - smart MCP pack recommendation based on detected domain packs
132
- - `suggest-only --out report.md` exports full analysis as shareable markdown
133
- - `why` explanations for all strengths preserved (20+ specific reasons)
134
- - `why` explanations for all gap findings (12+ specific reasons)
135
- - 5 new hooks in governance registry: duplicate-id-check, injection-defense, trust-drift-check, session-init, protect-catalog
136
- - case study template in `content/case-study-template.md`
137
- - hook risk level display in governance output (color-coded low/medium/high)
138
-
139
- ### Fixed
140
- - **Settings hierarchy bug**: `noBypassPermissions` and `secretsProtection` checks now correctly read `.claude/settings.json` before `.claude/settings.local.json`, so personal maintainer overrides no longer fail the shared audit
141
- - domain pack detection now handles monorepo (nx.json, turbo.json, lerna.json, workspaces), mobile (React Native, Flutter, iOS/Android dirs), and regulated repos (SECURITY.md, compliance dirs)
142
-
143
- ### Changed
144
- - strengths preserved section now shows 8 items (was 6) with specific value explanations
145
- - claudex-sync.json updated with domain pack, MCP pack, and anti-pattern counts
146
-
147
- ## [1.8.0] - 2026-03-31
148
-
149
- ### Added
150
- - domain pack recommendations for backend, frontend, data, infra, OSS, and enterprise-governed repos
151
- - MCP pack recommendations and merge support for `context7-docs` and `next-devtools`
152
- - workflow-evidence coverage in benchmark reports
153
- - runtime settings overlays so `apply --plan` still respects current `--profile` and `--mcp-pack` flags
154
-
155
- ### Changed
156
- - benchmark now respects the selected profile and MCP pack options during isolated-copy runs
157
- - governance and suggest-only outputs now expose domain packs and MCP packs directly
158
- - README and docs clarify the local-vs-opt-in-network boundary for core flows vs `deep-review`
159
- - audit output now frames `setup` as starter-safe generation instead of an automatic full fix
160
-
161
- ## [1.7.0] - 2026-03-31
162
-
163
- ### Added
164
- - `augment` / `suggest-only` repo-aware analysis with strengths, gaps, top actions, risk notes, and rollout order
165
- - `plan` command for exportable proposal bundles with file previews and diff-style output
166
- - `apply` command for selective starter-safe apply flows with rollback manifests and activity artifacts
167
- - `governance` command with permission profiles, hook registry, policy packs, and pilot rollout guidance
168
- - `benchmark` command that measures before/after impact in an isolated temp copy and exports evidence reports
169
- - claims governance and pilot rollout docs in `content/`
170
-
171
- ### Changed
172
- - `setup` now exposes reusable planning primitives and returns written/preserved file summaries
173
- - CLI now supports `--out`, `--plan`, `--only`, and `--dry-run`
174
- - README and docs now reflect the actual product surface instead of only audit/setup flows
175
- - benchmark and proposal workflows now preserve existing files by default and treat mature repos as review-first
176
-
177
- ## [0.2.0] - 2026-03-31
178
-
179
- ### Added
180
- - 50+ audit checks (up from 16)
181
- - 8 new categories: Design, DevOps, Hygiene, Performance, MCP, Prompting, Git Safety, Automation
182
- - 6 new stack detections: Svelte, Flutter, Ruby, Java, Kotlin, Swift
183
- - Improved CLAUDE.md template with Mermaid diagrams and XML constraints
184
- - Auto-sync with CLAUDEX research catalog (1,107 items)
185
- - Copy-paste config snippets in fix suggestions
186
-
187
- ### Changed
188
- - Knowledge base upgraded from 972 to 1,107 verified techniques
189
- - Better scoring weights per category
190
-
191
- ## [0.1.0] - 2026-03-30
192
-
193
- ### Added
194
- - Initial release
195
- - 16 audit checks
196
- - Automatic setup with CLAUDE.md, hooks, commands, skills, rules, agents
197
- - Stack detection for 12 frameworks
198
- - JSON output mode
@@ -1,91 +0,0 @@
1
- # Case Study: [Project Name]
2
-
3
- ## Overview
4
-
5
- | Field | Value |
6
- |-------|-------|
7
- | Project | [name] |
8
- | Repo type | [e.g., backend API, frontend SPA, monorepo, data pipeline] |
9
- | Team size | [e.g., solo, 3 developers, 15-person team] |
10
- | Prior Claude setup | [none / basic CLAUDE.md / mature .claude/ config] |
11
- | Claudex Setup version | [e.g., 1.9.0] |
12
- | Date | [YYYY-MM-DD] |
13
-
14
- ## Before State
15
-
16
- **Audit score:** [X/100]
17
- **Organic score:** [X/100]
18
-
19
- What existed before running claudex-setup:
20
- - [ ] CLAUDE.md
21
- - [ ] .claude/settings.json
22
- - [ ] Custom commands
23
- - [ ] Rules
24
- - [ ] Hooks
25
- - [ ] Agents
26
- - [ ] MCP servers
27
-
28
- Key observations:
29
- - [What was good already]
30
- - [What was missing]
31
- - [What was risky or misconfigured]
32
-
33
- ## What We Did
34
-
35
- **Mode used:** [discover / starter / augment / plan+apply / suggest-only]
36
-
37
- **Steps:**
38
- 1. Ran `npx claudex-setup discover` to understand current state
39
- 2. [Next step]
40
- 3. [Next step]
41
-
42
- **Domain pack matched:** [e.g., backend-api]
43
- **MCP packs recommended:** [e.g., context7-docs, postgres-mcp]
44
-
45
- ## Changes Applied
46
-
47
- | Change | Type | Risk | Applied? |
48
- |--------|------|------|----------|
49
- | [e.g., Created CLAUDE.md with architecture] | new file | low | yes |
50
- | [e.g., Added hooks for auto-lint] | new config | medium | yes |
51
- | [e.g., Added permission deny rules] | security | low | yes |
52
-
53
- **Strengths preserved:**
54
- - [What we explicitly kept unchanged]
55
-
56
- ## After State
57
-
58
- **Audit score:** [X/100] (was [X/100])
59
- **Organic score:** [X/100] (was [X/100])
60
- **Score improvement:** +[X] points
61
-
62
- ## Measured Impact
63
-
64
- | Metric | Before | After | Change |
65
- |--------|--------|-------|--------|
66
- | Audit score | X | X | +X |
67
- | Checks passing | X/84 | X/84 | +X |
68
- | Time to first productive session | Xm | Xm | -Xm |
69
- | [Other metric] | | | |
70
-
71
- ## What Worked Well
72
-
73
- - [Specific thing that added clear value]
74
- - [Another]
75
-
76
- ## What Could Be Better
77
-
78
- - [Specific improvement suggestion for the tool]
79
- - [Another]
80
-
81
- ## Verdict
82
-
83
- **Would recommend:** [Yes / Yes with caveats / Not yet]
84
-
85
- **Best for:** [Who should try this based on our experience]
86
-
87
- **One-line summary:** [e.g., "Took our Claude setup from basic to production-ready in 15 minutes with zero breakage."]
88
-
89
- ---
90
-
91
- *Generated with claudex-setup v[version]. Case study template from CLAUDEX.*
@@ -1,37 +0,0 @@
1
- # Claims Governance
2
-
3
- Use this checklist before publishing product-facing claims about Claudex Setup.
4
-
5
- ## Allowed only with evidence
6
-
7
- - score delta claims
8
- - organic score delta claims
9
- - time-to-value claims
10
- - recommendation acceptance rate claims
11
- - reduction in manual corrections
12
- - benchmark outcomes on named repo types
13
-
14
- ## Evidence standard
15
-
16
- Every claim should have:
17
-
18
- - a benchmark run or pilot report
19
- - the repo type or cohort it applies to
20
- - the date the evidence was collected
21
- - the exact metric definition
22
- - the comparison method (`before/after`, `control/pilot`, or `observed over time`)
23
-
24
- ## Avoid
25
-
26
- - universal productivity multipliers
27
- - unsupported token savings claims
28
- - “works for every repo” language
29
- - suspiciously precise numbers without a method section
30
- - implying quality scores are objective truth rather than framework coverage
31
-
32
- ## Safer phrasing
33
-
34
- - "In benchmark mode, this repo improved from 41/100 to 60/100."
35
- - "Starter-safe artifacts improved readiness on an isolated temp copy."
36
- - "Suggest-only mode gives mature teams a zero-write review path."
37
- - "Use governance mode to select permission profiles and inspect shipped hooks."
@@ -1,20 +0,0 @@
1
- ---
2
- name: audit-repo
3
- description: Run claudex-setup on the current repo and summarize the score, top gaps, and next command
4
- ---
5
-
6
- Run `npx claudex-setup --json` in the current project directory and summarize the result.
7
-
8
- Your output should include:
9
-
10
- 1. The overall score and organic score
11
- 2. The top 3 next actions from `topNextActions`
12
- 3. The suggested next command from `suggestedNextCommand`
13
- 4. A short explanation of what the repo already does well if there are notable strengths
14
-
15
- Behavior rules:
16
-
17
- - If the user asks for the shortest version, run `npx claudex-setup --lite`
18
- - If the user wants deeper no-write analysis, run `npx claudex-setup augment --json`
19
- - If the score is below 50, explicitly recommend `npx claudex-setup setup`
20
- - Never apply changes automatically from this skill
@@ -1,60 +0,0 @@
1
- # Using claudex-setup from inside Claude Code
2
-
3
- ## Skill: Audit Repo
4
-
5
- Add this to `.claude/skills/audit-repo.md` in any project:
6
-
7
- ```markdown
8
- ---
9
- name: audit-repo
10
- description: Run claudex-setup audit on the current project and show score + top gaps
11
- ---
12
-
13
- Run `npx claudex-setup --json` on the current project directory.
14
- Parse the JSON output and present:
15
- 1. Score X/100
16
- 2. Top 3 critical/high gaps with fix descriptions
17
- 3. Suggest next command based on score
18
-
19
- $ARGUMENTS — optional: --lite for quick scan
20
- ```
21
-
22
- ## Hook: Auto-audit on SessionStart
23
-
24
- Add to `.claude/settings.json`:
25
-
26
- ```json
27
- {
28
- "hooks": {
29
- "SessionStart": [
30
- {
31
- "type": "command",
32
- "command": "node -e \"try{const r=require('child_process').execSync('npx claudex-setup --json 2>/dev/null',{timeout:15000}).toString();const d=JSON.parse(r);if(d.score<50)console.log(JSON.stringify({systemMessage:'⚠️ Claude Code setup score: '+d.score+'/100. Consider running: npx claudex-setup --lite'}))}catch(e){console.log('{}')}\"",
33
- "timeout": 20,
34
- "statusMessage": "Checking Claude Code setup..."
35
- }
36
- ]
37
- }
38
- }
39
- ```
40
-
41
- ## Agent: Setup Advisor
42
-
43
- Add to `.claude/agents/setup-advisor.md`:
44
-
45
- ```markdown
46
- ---
47
- name: setup-advisor
48
- description: Analyzes Claude Code setup and recommends improvements
49
- tools: [Bash, Read, Glob, Grep]
50
- model: haiku
51
- maxTurns: 10
52
- ---
53
-
54
- You are a Claude Code setup advisor.
55
-
56
- 1. Run `npx claudex-setup augment --json` on the current project
57
- 2. Analyze gaps and strengths
58
- 3. Recommend top 5 improvements with rationale
59
- 4. If user approves, guide them through applying changes
60
- ```
@@ -1,9 +0,0 @@
1
- {
2
- "article": {
3
- "title": "Your Claude Code project scores 10/100. Here's how to fix it in 60 seconds.",
4
- "published": false,
5
- "tags": ["claude", "ai", "productivity", "devtools"],
6
- "series": "Claude Code Optimization",
7
- "body_markdown": "After cataloging **1,107 Claude Code entries** and verifying **948 with real evidence**, I found that most projects use barely 10% of what's available.\n\nI built a CLI that scores your project:\n\n```bash\nnpx claudex-setup\n```\n\nMost projects score **10-20 out of 100**. After running setup, they jump to **70+**.\n\n## The Top 10 Things You're Missing\n\n### 1. CLAUDE.md (Critical)\n\nClaude reads this file at the start of every session. Without it, Claude doesn't know your build commands, code style, or project rules.\n\nOur tool generates a smart CLAUDE.md that detects your framework, TypeScript config, and creates a Mermaid architecture diagram automatically.\n\n### 2. Mermaid Architecture Diagrams (73% Token Savings)\n\nA Mermaid diagram in CLAUDE.md gives Claude your project structure in a fraction of the tokens that prose requires.\n\n### 3. Hooks > CLAUDE.md Rules (100% vs 80%)\n\nCLAUDE.md instructions are advisory (~80% compliance). Hooks are deterministic (100%). Auto-lint after every edit. Every time.\n\n### 4. Custom Commands\n\nStop typing the same prompts. Create `/test`, `/deploy`, `/review` in `.claude/commands/`.\n\n### 5. Verification Loops (The #1 Best Practice)\n\n> *This is the single highest-leverage thing you can do.* — Anthropic Best Practices\n\nClaude performs dramatically better when it can verify its own work.\n\n### 6. XML Tags (30% Quality Boost)\n\nUse `<constraints>`, `<validation>` in CLAUDE.md for unambiguous instructions.\n\n### 7. Secrets Protection\n\nClaude Code loads `.env` automatically. Add deny rules to prevent reading sensitive files.\n\n### 8. /security-review\n\nBuilt-in OWASP Top 10 scanning. Most people don't know this command exists.\n\n### 9. Custom Agents\n\nSpecialized subagents: security-reviewer, test-writer in `.claude/agents/`.\n\n### 10. Skills (On-Demand Knowledge)\n\nReusable skills package expertise that Claude can load on demand.\n\n## Try It Now\n\n```bash\nnpx claudex-setup --lite # Quick scan\nnpx claudex-setup # Full audit\nnpx claudex-setup --snapshot # Save evidence artifact\nnpx claudex-setup governance --out governance.md\n```\n\nFree, open source, zero dependencies.\n\n**GitHub:** [github.com/DnaFin/claudex-setup](https://github.com/DnaFin/claudex-setup)\n**npm:** [npmjs.com/package/claudex-setup](https://www.npmjs.com/package/claudex-setup)\n\n---\n\n*Built from a research catalog of 1,107 Claude Code entries, 948 verified with evidence.*"
8
- }
9
- }
@@ -1,226 +0,0 @@
1
- # Launch Posts — Proof-Backed Distribution Assets
2
-
3
- **Status:** Complete — every asset below is anchored in measured proof, a canonical artifact, or a verified runtime surface
4
- **Date:** 2026-04-03
5
-
6
- ## Shared Proof Anchors
7
-
8
- Use these links as the canonical sources behind public claims:
9
-
10
- - Proof artifact index: https://github.com/DnaFin/claudex/blob/main/research/proof-artifacts/README.md
11
- - CLAUDEX self-dogfood trace: https://github.com/DnaFin/claudex/blob/main/research/proof-artifacts/claudex-self-dogfood-proof-trace-2026-04-03.md
12
- - VTCLE case study: https://github.com/DnaFin/claudex/blob/main/research/case-study-vtcle-2026-04-03.md
13
- - Social case study: https://github.com/DnaFin/claudex/blob/main/research/case-study-social-2026-04-03.md
14
- - Polymiro case study: https://github.com/DnaFin/claudex/blob/main/research/case-study-polymiro-2026-04-03.md
15
- - Public proof metrics source: https://github.com/DnaFin/claudex/blob/main/research/claudex-proof-metrics-source-2026-04-03.md
16
-
17
- Measured-result boundary to preserve:
18
-
19
- - before/after scores were measured with `claudex-setup@1.10.3` on `2026-04-03`
20
- - current npm latest is `1.16.1`
21
- - current product surface is `85 checks`
22
-
23
- ## Post 1: Reddit r/ClaudeAI
24
-
25
- **Title:** I built a CLI that audits your Claude Code setup — 85 checks, measured on 4 real repos
26
-
27
- **Body:**
28
- I built a zero-dependency CLI that audits how well a repo is set up for Claude Code.
29
-
30
- It checks `85` things across `CLAUDE.md`, hooks, commands, agents, skills, MCP config, permissions, diagrams, and verification loops.
31
-
32
- Measured on `2026-04-03` with `claudex-setup@1.10.3`:
33
- - CLAUDEX: `62 -> 90`
34
- - VTCLE: `46 -> 64`
35
- - Social: `40 -> 48`
36
- - Polymiro: `35 -> 48`
37
-
38
- ```bash
39
- npx claudex-setup
40
- ```
41
-
42
- It starts trust-first:
43
- - audit first
44
- - plan / suggest-only before writes
45
- - apply only what you approve
46
- - rollback artifacts for every applied batch
47
-
48
- Zero dependencies. No API keys. Runs local.
49
-
50
- GitHub: https://github.com/DnaFin/claudex-setup
51
-
52
- Proof and case studies:
53
- - https://github.com/DnaFin/claudex/blob/main/research/proof-artifacts/README.md
54
- - https://github.com/DnaFin/claudex/blob/main/research/case-study-vtcle-2026-04-03.md
55
- - https://github.com/DnaFin/claudex/blob/main/research/case-study-social-2026-04-03.md
56
- - https://github.com/DnaFin/claudex/blob/main/research/case-study-polymiro-2026-04-03.md
57
-
58
- Would love feedback on what checks or rollout surfaces are still missing.
59
-
60
- **Evidence anchor:** proof artifact index + 3 external case studies + current proof source
61
-
62
- ---
63
-
64
- ## Post 2: Reddit r/ChatGPTCoding
65
-
66
- **Title:** Most Claude Code repos are missing the safety layer, not the model
67
-
68
- **Body:**
69
- The interesting problem with Claude Code is not "can it write code?".
70
- It's "is the repo actually set up so Claude can work safely and predictably?".
71
-
72
- I built `claudex-setup` to audit that surface:
73
- - `85` checks
74
- - zero dependencies
75
- - local-only by default
76
- - trust-first flow: audit -> plan -> apply -> rollback
77
-
78
- Measured on 4 real repos:
79
- - FastAPI repo: `46 -> 64`
80
- - React Native repo: `40 -> 48`
81
- - Python/Docker repo: `35 -> 48`
82
- - research engine repo: `62 -> 90`
83
-
84
- ```bash
85
- npx claudex-setup
86
- ```
87
-
88
- The most common misses were not exotic:
89
- - no deny rules
90
- - no secrets protection
91
- - no mermaid architecture
92
- - no hooks registered in settings
93
-
94
- Proof:
95
- https://github.com/DnaFin/claudex/blob/main/research/proof-artifacts/README.md
96
-
97
- **Evidence anchor:** measured before/after traces + common gap summary from public proof set
98
-
99
- ---
100
-
101
- ## Post 3: Dev.to Article
102
-
103
- **Title:** What 4 Real Repos Taught Me About Claude Code Readiness
104
-
105
- **Body (excerpt):**
106
- I tested `claudex-setup` on 4 real repos and the pattern was clear:
107
-
108
- - the best teams still miss permission deny rules
109
- - mature repos often have hooks in files but not actually registered
110
- - non-standard settings formats are a real adoption trap
111
- - shared `settings.json` matters more than personal local overrides
112
-
113
- Measured on `2026-04-03` with `claudex-setup@1.10.3`:
114
- - CLAUDEX: `62 -> 90`
115
- - VTCLE: `46 -> 64`
116
- - Social: `40 -> 48`
117
- - Polymiro: `35 -> 48`
118
-
119
- The product today is strongest as:
120
-
121
- `audit -> plan -> safe apply -> governance -> benchmark`
122
-
123
- Not a code generator. Not an MCP installer. A trust layer for Claude Code repos.
124
-
125
- Proof packet:
126
- https://github.com/DnaFin/claudex/blob/main/research/proof-artifacts/README.md
127
-
128
- **Evidence anchor:** proof artifact index + case-study docs + current proof source
129
-
130
- ---
131
-
132
- ## Post 4: Twitter/X Thread
133
-
134
- **Tweet 1:**
135
- I built a zero-dependency CLI that audits Claude Code readiness across `85` checks.
136
-
137
- Measured on 4 real repos:
138
- - `62 -> 90`
139
- - `46 -> 64`
140
- - `40 -> 48`
141
- - `35 -> 48`
142
-
143
- `npx claudex-setup`
144
-
145
- Proof: github.com/DnaFin/claudex/blob/main/research/proof-artifacts/README.md
146
-
147
- **Tweet 2:**
148
- The most common misses were boring and important:
149
- - no deny rules
150
- - no secrets protection
151
- - no mermaid diagram
152
- - no hooks registered in settings
153
-
154
- It is much more "trust layer" than "AI magic".
155
-
156
- **Tweet 3:**
157
- What it does well today:
158
- - audit first
159
- - suggest / plan before writes
160
- - apply selectively
161
- - emit rollback artifacts
162
- - benchmark on isolated copy
163
-
164
- **Tweet 4:**
165
- Best result so far:
166
- - CLAUDEX self-dogfood: `62 -> 90`
167
-
168
- Best external proof:
169
- - VTCLE: `46 -> 64`
170
-
171
- Case studies:
172
- - github.com/DnaFin/claudex/blob/main/research/case-study-vtcle-2026-04-03.md
173
- - github.com/DnaFin/claudex/blob/main/research/case-study-social-2026-04-03.md
174
- - github.com/DnaFin/claudex/blob/main/research/case-study-polymiro-2026-04-03.md
175
-
176
- **Tweet 5:**
177
- Measured results were captured on `claudex-setup@1.10.3` on `2026-04-03`.
178
- Current npm latest is `1.16.1`, so exact scores can move slightly, but the proof packet is explicit about that boundary.
179
-
180
- **Evidence anchor:** proof artifact index + per-repo traces
181
-
182
- ---
183
-
184
- ## Post 5: Hacker News (Show HN)
185
-
186
- **Title:** Show HN: claudex-setup — audit Claude Code readiness with 85 checks
187
-
188
- **Body:**
189
- I built a CLI that audits how well a repo is set up for Claude Code.
190
-
191
- This is not a code-quality linter and not an MCP installer.
192
- It focuses on Claude workflow quality:
193
- - `CLAUDE.md`
194
- - hooks
195
- - commands
196
- - agents
197
- - skills
198
- - MCP config
199
- - permissions / deny rules
200
- - diagrams
201
- - verification loops
202
-
203
- Core workflow:
204
- - `npx claudex-setup`
205
- - `npx claudex-setup suggest-only`
206
- - `npx claudex-setup plan`
207
- - `npx claudex-setup apply`
208
- - `npx claudex-setup benchmark`
209
-
210
- Measured on 4 real repos on `2026-04-03` with `claudex-setup@1.10.3`:
211
- - CLAUDEX: `62 -> 90`
212
- - VTCLE: `46 -> 64`
213
- - Social: `40 -> 48`
214
- - Polymiro: `35 -> 48`
215
-
216
- Trust decisions that mattered:
217
- - zero dependencies
218
- - audit before write
219
- - rollback artifacts
220
- - cross-platform Node hooks
221
- - explicit proof packets instead of vague claims
222
-
223
- Proof packet:
224
- https://github.com/DnaFin/claudex/blob/main/research/proof-artifacts/README.md
225
-
226
- **Evidence anchor:** proof artifact index + current npm proof source
@@ -1,30 +0,0 @@
1
- # Pilot Rollout Kit
2
-
3
- ## Suggested pilot shape
4
-
5
- 1. Choose 1-2 repos with active owners and low blast radius.
6
- 2. Run `discover`, `suggest-only`, and `governance` before any write flow.
7
- 3. Pick one permission profile and document why it fits the pilot.
8
- 4. Run `benchmark` to capture a baseline and expected value.
9
- 5. Use `plan` and selective `apply` for the first write batch.
10
-
11
- ## Approval checklist
12
-
13
- - Engineering owner approves scope.
14
- - Security owner approves permission profile and hooks.
15
- - Pilot owner records success metrics.
16
- - Rollback expectations are documented before apply.
17
-
18
- ## Success metrics
19
-
20
- - readiness score delta
21
- - organic score delta
22
- - number of proposal bundles accepted
23
- - rollback-free apply rate
24
- - time to first useful Claude workflow
25
-
26
- ## Rollback expectations
27
-
28
- - every apply run must produce a rollback artifact
29
- - rejected starter artifacts are deleted using the rollback manifest
30
- - rollback decisions are logged in the activity trail
@@ -1,31 +0,0 @@
1
- # claudex-setup Release Checklist
2
-
3
- Use this before tagging or publishing a release.
4
-
5
- ## Code And Packaging
6
-
7
- - bump `package.json` version intentionally
8
- - update `CHANGELOG.md` with the shipped changes
9
- - run `npm test`
10
- - run `npm pack --dry-run`
11
-
12
- ## Product Surface Consistency
13
-
14
- - verify `README.md` reflects the current CLI surface
15
- - verify `docs/index.html` reflects the current CLI surface
16
- - verify new flags and commands appear in `--help`
17
- - verify proof numbers and public claims match the current state
18
-
19
- ## Trust And Governance
20
-
21
- - run `npx claudex-setup --snapshot` on the repo itself
22
- - run `npx claudex-setup governance --out governance.md`
23
- - verify MCP package names and env preflight behavior for changed packs
24
- - verify no recommendation regressions on known scenarios
25
-
26
- ## Release Readiness
27
-
28
- - confirm npm publish target and account are correct
29
- - confirm git branch / commit matches the intended release
30
- - confirm any new templates or content files are included in the package
31
- - capture one final note about what changed and what still remains intentionally deferred