claudex-setup 1.10.1 → 1.10.3
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/CHANGELOG.md +32 -0
- package/README.md +72 -8
- package/bin/cli.js +56 -1
- package/content/case-study-template.md +91 -0
- package/content/claims-governance.md +37 -0
- package/content/claude-code/audit-repo/SKILL.md +20 -0
- package/content/devto-article.json +9 -0
- package/content/launch-posts.md +160 -0
- package/content/pilot-rollout-kit.md +30 -0
- package/content/release-checklist.md +31 -0
- package/package.json +3 -2
- package/src/activity.js +112 -1
- package/src/analyze.js +19 -4
- package/src/audit.js +157 -10
- package/src/claudex-sync.json +2 -6
- package/src/domain-packs.js +5 -5
- package/src/governance.js +69 -0
- package/src/index.js +2 -1
- package/src/insights.js +3 -2
- package/src/mcp-packs.js +132 -25
- package/src/plans.js +21 -0
- package/src/setup.js +13 -0
- package/src/techniques.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,37 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [1.10.3] - 2026-04-02
|
|
4
|
+
|
|
5
|
+
### Added
|
|
6
|
+
- `--snapshot` support for `audit`, `augment`, `suggest-only`, `benchmark`, and `governance`, writing normalized evidence artifacts under `.claude/claudex-setup/snapshots/`
|
|
7
|
+
- shared snapshot history via `index.json` so before/after work can accumulate into a single local evidence spine
|
|
8
|
+
- `governance --out governance.md` for a shareable governance / pilot-readiness artifact
|
|
9
|
+
- packaged Claude-native `audit-repo` skill template under `content/claude-code/audit-repo/`
|
|
10
|
+
- lightweight release checklist in `content/release-checklist.md`
|
|
11
|
+
|
|
12
|
+
### Changed
|
|
13
|
+
- default audit now surfaces `Top 5 Next Actions` with rationale, traceability, risk, confidence, and a suggested next command
|
|
14
|
+
- `--lite` now gives a shorter beginner-first top-3 quick scan
|
|
15
|
+
- README and docs now reflect snapshot artifacts, governance export, and the Claude-native skill path
|
|
16
|
+
- packaged content and public-facing counts are now aligned with the current CLAUDEX state
|
|
17
|
+
|
|
18
|
+
## [1.10.2] - 2026-04-02
|
|
19
|
+
|
|
20
|
+
### Fixed
|
|
21
|
+
- 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
|
|
22
|
+
- `sentry-mcp` now requires real observability signals or stricter operational domains instead of appearing for every frontend/backend repo
|
|
23
|
+
- design-system detection now respects `.storybook/` directories directly, improving frontend pack accuracy
|
|
24
|
+
|
|
25
|
+
### Added
|
|
26
|
+
- MCP preflight warnings for `setup`, `plan`, and `apply` when selected packs require missing environment variables
|
|
27
|
+
- user-facing docs now reflect the actual 22 detected stacks
|
|
28
|
+
|
|
29
|
+
## [1.10.1] - 2026-04-02
|
|
30
|
+
|
|
31
|
+
### Fixed
|
|
32
|
+
- corrected MCP pack package names to verified npm packages
|
|
33
|
+
- aligned settings hierarchy checks with shared settings precedence
|
|
34
|
+
|
|
3
35
|
## [1.10.0] - 2026-04-01
|
|
4
36
|
|
|
5
37
|
### Added
|
package/README.md
CHANGED
|
@@ -1,19 +1,36 @@
|
|
|
1
1
|
# claudex-setup
|
|
2
2
|
|
|
3
|
-
> Score your
|
|
3
|
+
> Score your repo's Claude Code setup against 62 checks. See what's missing, apply only what you approve with rollback, and benchmark the impact — without breaking existing config.
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/claudex-setup)
|
|
6
6
|
[](https://www.npmjs.com/package/claudex-setup)
|
|
7
7
|
[](LICENSE)
|
|
8
8
|
|
|
9
|
+
### What this is
|
|
10
|
+
|
|
11
|
+
- A **Claude Code workflow audit and improvement tool** — not an MCP installer, not a code generator
|
|
12
|
+
- Scores your repo 0-100 across CLAUDE.md, hooks, commands, agents, skills, MCP, security, and more
|
|
13
|
+
- Proposes changes as diffs you review — applies only what you approve, with rollback for every change
|
|
14
|
+
- Includes governance (permission profiles, hook registry, policy packs) and benchmark (isolated before/after)
|
|
15
|
+
|
|
16
|
+
### What this is NOT
|
|
17
|
+
|
|
18
|
+
- Not an MCP setup tool (MCP packs are one of 26 features, not the product)
|
|
19
|
+
- Not a code generator or refactoring tool — it configures how Claude works with your repo, not the code itself
|
|
20
|
+
- Not a replacement for hand-crafted CLAUDE.md — generated output is a strong starting point, not a final answer
|
|
21
|
+
- Not a score you should chase blindly — 90/100 with bad code is still bad code
|
|
22
|
+
|
|
9
23
|
## Quick Start
|
|
10
24
|
|
|
11
25
|
```bash
|
|
26
|
+
npx claudex-setup --lite # Quick beginner scan: top 3 fixes + next command
|
|
12
27
|
npx claudex-setup # Audit your project (10 seconds)
|
|
28
|
+
npx claudex-setup --snapshot # Save a normalized snapshot under .claude/claudex-setup/
|
|
13
29
|
npx claudex-setup setup # Create a starter-safe baseline
|
|
14
30
|
npx claudex-setup augment # Repo-aware plan, no writes
|
|
15
31
|
npx claudex-setup plan # Export proposal bundles with file previews
|
|
16
32
|
npx claudex-setup governance # See permission profiles, packs, and pilot guidance
|
|
33
|
+
npx claudex-setup governance --out governance.md # Export a shareable governance report
|
|
17
34
|
npx claudex-setup benchmark # Measure before/after in an isolated temp copy
|
|
18
35
|
npx claudex-setup --threshold 60 # Fail CI if score is below 60
|
|
19
36
|
```
|
|
@@ -41,18 +58,35 @@ No install. No config. No dependencies.
|
|
|
41
58
|
CI pipeline configured
|
|
42
59
|
→ Add .github/workflows/ for automated testing
|
|
43
60
|
|
|
44
|
-
⚡
|
|
61
|
+
⚡ Top 5 Next Actions
|
|
45
62
|
1. Add CLAUDE.md verification criteria
|
|
63
|
+
Why: Claude needs an explicit verification loop before handoff
|
|
64
|
+
Trace: failed-check:verificationLoop | impact:critical | category:quality
|
|
65
|
+
Risk: high | Confidence: high
|
|
66
|
+
Fix: Add test/lint/build commands to CLAUDE.md so Claude can verify its own work
|
|
67
|
+
|
|
46
68
|
2. Configure safe permissions + deny rules
|
|
69
|
+
Why: Explicit permissions are the main safety layer for repo writes
|
|
70
|
+
Trace: failed-check:permissionDeny | impact:high | category:security
|
|
71
|
+
Risk: medium | Confidence: high
|
|
72
|
+
Fix: Add permissions.deny rules to block dangerous operations
|
|
47
73
|
|
|
48
74
|
Weakest areas:
|
|
49
75
|
design: none (0/2)
|
|
50
76
|
devops: none (0/4)
|
|
51
77
|
|
|
52
78
|
29/62 checks passing
|
|
53
|
-
|
|
79
|
+
Next command: npx claudex-setup setup
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Want the shortest possible first run?
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
npx claudex-setup --lite
|
|
54
86
|
```
|
|
55
87
|
|
|
88
|
+
That prints a compact top-3 quick scan with one clear next command.
|
|
89
|
+
|
|
56
90
|
## All Commands
|
|
57
91
|
|
|
58
92
|
| Command | What it does |
|
|
@@ -84,6 +118,8 @@ No install. No config. No dependencies.
|
|
|
84
118
|
| `--only A,B` | Limit plan/apply to selected proposal ids |
|
|
85
119
|
| `--profile NAME` | Choose a permission profile for write-capable flows |
|
|
86
120
|
| `--mcp-pack A,B` | Merge named MCP packs into generated or patched settings |
|
|
121
|
+
| `--snapshot` | Save a normalized artifact under `.claude/claudex-setup/snapshots/` |
|
|
122
|
+
| `--lite` | Show a short top-3 quick scan with one clear next command |
|
|
87
123
|
| `--dry-run` | Preview apply without writing files |
|
|
88
124
|
| `--verbose` | Show all recommendations (not just critical/high) |
|
|
89
125
|
| `--json` | Machine-readable JSON output (for CI) |
|
|
@@ -141,6 +177,7 @@ Use `governance` when the question is "can we pilot this safely?" instead of "wh
|
|
|
141
177
|
|
|
142
178
|
```bash
|
|
143
179
|
npx claudex-setup governance
|
|
180
|
+
npx claudex-setup governance --out governance.md
|
|
144
181
|
```
|
|
145
182
|
|
|
146
183
|
It exposes:
|
|
@@ -152,6 +189,8 @@ It exposes:
|
|
|
152
189
|
- 26 MCP packs: Context7, Next.js devtools, GitHub, PostgreSQL, Playwright, Docker, Notion, Linear, Sentry, Slack, Stripe, Figma, Shopify, Hugging Face, Blender, WordPress, Jira/Confluence, GA4, Search Console, n8n, Zendesk, Infisical, Composio, memory, sequential-thinking, mcp-security
|
|
153
190
|
- a pilot rollout kit with scope, approvals, success metrics, and rollback expectations
|
|
154
191
|
|
|
192
|
+
Use `--out governance.md` if you want a shareable artifact for leads, platform teams, or security review.
|
|
193
|
+
|
|
155
194
|
## Domain Packs And MCP Packs
|
|
156
195
|
|
|
157
196
|
`augment` and `suggest-only` now recommend repo-shaped guidance instead of giving every project the same advice.
|
|
@@ -181,6 +220,31 @@ Benchmark mode:
|
|
|
181
220
|
- applies starter-safe artifacts only in the copy
|
|
182
221
|
- reruns the audit and emits before/after deltas, workflow-evidence coverage, a case-study summary, and an executive recommendation
|
|
183
222
|
|
|
223
|
+
If you want repeatable evidence artifacts for before/after work, add `--snapshot` to `audit`, `augment`, `suggest-only`, `benchmark`, or `governance`.
|
|
224
|
+
|
|
225
|
+
```bash
|
|
226
|
+
npx claudex-setup --snapshot
|
|
227
|
+
npx claudex-setup augment --snapshot
|
|
228
|
+
npx claudex-setup benchmark --snapshot
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
Snapshots are written to `.claude/claudex-setup/snapshots/` with a shared envelope and an `index.json` history file.
|
|
232
|
+
|
|
233
|
+
## Use Inside Claude Code
|
|
234
|
+
|
|
235
|
+
If you want the first Claude-native entry point, copy the shipped skill template into your repo.
|
|
236
|
+
|
|
237
|
+
If `claudex-setup` is installed locally in `node_modules`, use:
|
|
238
|
+
|
|
239
|
+
```bash
|
|
240
|
+
mkdir -p .claude/skills/audit-repo
|
|
241
|
+
cp ./node_modules/claudex-setup/content/claude-code/audit-repo/SKILL.md .claude/skills/audit-repo/SKILL.md
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
If you are using `npx` only, copy the same file from the GitHub repo at `content/claude-code/audit-repo/SKILL.md`.
|
|
245
|
+
|
|
246
|
+
The skill runs `npx claudex-setup --json`, summarizes the score, shows the top next actions, and points to the right next command without applying changes.
|
|
247
|
+
|
|
184
248
|
## 62 Checks Across 14 Categories
|
|
185
249
|
|
|
186
250
|
The exact applicable count can be lower on a given repo because stack-specific checks are skipped when they do not apply.
|
|
@@ -204,16 +268,16 @@ The exact applicable count can be lower on a given repo because stack-specific c
|
|
|
204
268
|
|
|
205
269
|
## Stack Detection
|
|
206
270
|
|
|
207
|
-
Auto-detects and tailors output for
|
|
271
|
+
Auto-detects and tailors output for 22 stacks:
|
|
208
272
|
|
|
209
273
|
| | |
|
|
210
274
|
|--|--|
|
|
211
275
|
| **Frontend** | React, Vue, Angular, Next.js, Svelte |
|
|
212
276
|
| **Backend** | Node.js, Python, Django, FastAPI |
|
|
213
277
|
| **Mobile** | Flutter, Swift, Kotlin |
|
|
214
|
-
| **Systems** | Rust, Go, Java, Ruby |
|
|
278
|
+
| **Systems** | Rust, Go, Java, Ruby, C++, Bazel |
|
|
215
279
|
| **Language** | TypeScript |
|
|
216
|
-
| **Infra** | Docker |
|
|
280
|
+
| **Infra** | Docker, Terraform, Kubernetes |
|
|
217
281
|
|
|
218
282
|
## GitHub Action
|
|
219
283
|
|
|
@@ -227,7 +291,7 @@ jobs:
|
|
|
227
291
|
runs-on: ubuntu-latest
|
|
228
292
|
steps:
|
|
229
293
|
- uses: actions/checkout@v4
|
|
230
|
-
- uses: DnaFin/claudex-setup@v1.10.
|
|
294
|
+
- uses: DnaFin/claudex-setup@v1.10.3
|
|
231
295
|
with:
|
|
232
296
|
threshold: 50
|
|
233
297
|
```
|
|
@@ -288,7 +352,7 @@ Every check traces to a verified technique from a systematic audit of:
|
|
|
288
352
|
- Anthropic blog posts and benchmark papers
|
|
289
353
|
- 194 hands-on experiments with real evidence
|
|
290
354
|
|
|
291
|
-
The catalog includes 1,107 entries (features, techniques, patterns, tools, stats, and known limitations) — not all are actionable checks.
|
|
355
|
+
The catalog includes 1,107 entries (features, techniques, patterns, tools, stats, and known limitations) — not all are actionable checks. 948 were verified with real evidence. Continuously updated.
|
|
292
356
|
|
|
293
357
|
**Note:** A hand-crafted CLAUDE.md that reflects your real conventions will always be better than a generated one. This tool is most useful for projects starting from zero, or as a checklist for what you might be missing.
|
|
294
358
|
|
package/bin/cli.js
CHANGED
|
@@ -4,8 +4,9 @@ const { audit } = require('../src/audit');
|
|
|
4
4
|
const { setup } = require('../src/setup');
|
|
5
5
|
const { analyzeProject, printAnalysis, exportMarkdown } = require('../src/analyze');
|
|
6
6
|
const { buildProposalBundle, printProposalBundle, writePlanFile, applyProposalBundle, printApplyResult } = require('../src/plans');
|
|
7
|
-
const { getGovernanceSummary, printGovernanceSummary, ensureWritableProfile } = require('../src/governance');
|
|
7
|
+
const { getGovernanceSummary, printGovernanceSummary, ensureWritableProfile, renderGovernanceMarkdown } = require('../src/governance');
|
|
8
8
|
const { runBenchmark, printBenchmark, writeBenchmarkReport } = require('../src/benchmark');
|
|
9
|
+
const { writeSnapshotArtifact } = require('../src/activity');
|
|
9
10
|
const { version } = require('../package.json');
|
|
10
11
|
|
|
11
12
|
const args = process.argv.slice(2);
|
|
@@ -133,6 +134,7 @@ const HELP = `
|
|
|
133
134
|
|
|
134
135
|
Usage:
|
|
135
136
|
npx claudex-setup Run audit on current directory
|
|
137
|
+
npx claudex-setup --lite Run the quick-scan beginner view
|
|
136
138
|
npx claudex-setup discover Discover the highest-value improvements
|
|
137
139
|
npx claudex-setup audit Same as above
|
|
138
140
|
npx claudex-setup starter Alias for setup
|
|
@@ -156,6 +158,8 @@ const HELP = `
|
|
|
156
158
|
--only A,B Limit plan/apply to selected proposal ids or technique keys
|
|
157
159
|
--profile NAME Choose permission profile (read-only, suggest-only, safe-write, power-user, internal-research)
|
|
158
160
|
--mcp-pack A,B Merge named MCP packs into generated settings (e.g. context7-docs,next-devtools)
|
|
161
|
+
--snapshot Save a normalized snapshot artifact under .claude/claudex-setup/snapshots/
|
|
162
|
+
--lite Show a short top-3 quick scan with one clear next command
|
|
159
163
|
--dry-run Preview apply without writing files
|
|
160
164
|
--verbose Show all recommendations (not just critical/high)
|
|
161
165
|
--json Output as JSON (for CI pipelines)
|
|
@@ -166,8 +170,12 @@ const HELP = `
|
|
|
166
170
|
|
|
167
171
|
Examples:
|
|
168
172
|
npx claudex-setup
|
|
173
|
+
npx claudex-setup --lite
|
|
174
|
+
npx claudex-setup --snapshot
|
|
169
175
|
npx claudex-setup augment
|
|
176
|
+
npx claudex-setup augment --snapshot
|
|
170
177
|
npx claudex-setup suggest-only --json
|
|
178
|
+
npx claudex-setup governance --snapshot
|
|
171
179
|
npx claudex-setup plan --out claudex-plan.json
|
|
172
180
|
npx claudex-setup plan --profile safe-write
|
|
173
181
|
npx claudex-setup setup --mcp-pack context7-docs
|
|
@@ -210,6 +218,8 @@ async function main() {
|
|
|
210
218
|
verbose: flags.includes('--verbose'),
|
|
211
219
|
json: flags.includes('--json'),
|
|
212
220
|
auto: flags.includes('--auto'),
|
|
221
|
+
lite: flags.includes('--lite'),
|
|
222
|
+
snapshot: flags.includes('--snapshot'),
|
|
213
223
|
dryRun: flags.includes('--dry-run'),
|
|
214
224
|
threshold: parsed.threshold !== null ? Number(parsed.threshold) : null,
|
|
215
225
|
out: parsed.out,
|
|
@@ -295,6 +305,9 @@ async function main() {
|
|
|
295
305
|
return; // keep process alive for http
|
|
296
306
|
} else if (normalizedCommand === 'augment' || normalizedCommand === 'suggest-only') {
|
|
297
307
|
const report = await analyzeProject({ ...options, mode: normalizedCommand });
|
|
308
|
+
const snapshot = options.snapshot ? writeSnapshotArtifact(options.dir, normalizedCommand, report, {
|
|
309
|
+
sourceCommand: normalizedCommand,
|
|
310
|
+
}) : null;
|
|
298
311
|
if (options.out && !options.json) {
|
|
299
312
|
const fs = require('fs');
|
|
300
313
|
const md = exportMarkdown(report);
|
|
@@ -302,6 +315,11 @@ async function main() {
|
|
|
302
315
|
console.log(`\n Report exported to ${options.out}\n`);
|
|
303
316
|
}
|
|
304
317
|
printAnalysis(report, options);
|
|
318
|
+
if (snapshot && !options.json) {
|
|
319
|
+
console.log(` Snapshot saved: ${snapshot.relativePath}`);
|
|
320
|
+
console.log(` Snapshot index: ${snapshot.indexPath}`);
|
|
321
|
+
console.log('');
|
|
322
|
+
}
|
|
305
323
|
} else if (normalizedCommand === 'plan') {
|
|
306
324
|
const bundle = await buildProposalBundle(options);
|
|
307
325
|
let artifact = null;
|
|
@@ -320,10 +338,34 @@ async function main() {
|
|
|
320
338
|
const result = await applyProposalBundle(options);
|
|
321
339
|
printApplyResult(result, options);
|
|
322
340
|
} else if (normalizedCommand === 'governance') {
|
|
341
|
+
const fs = require('fs');
|
|
342
|
+
const path = require('path');
|
|
323
343
|
const summary = getGovernanceSummary();
|
|
344
|
+
if (options.out) {
|
|
345
|
+
fs.mkdirSync(path.dirname(options.out), { recursive: true });
|
|
346
|
+
const content = path.extname(options.out).toLowerCase() === '.md'
|
|
347
|
+
? renderGovernanceMarkdown(summary)
|
|
348
|
+
: JSON.stringify(summary, null, 2);
|
|
349
|
+
fs.writeFileSync(options.out, content, 'utf8');
|
|
350
|
+
}
|
|
324
351
|
printGovernanceSummary(summary, options);
|
|
352
|
+
const snapshot = options.snapshot ? writeSnapshotArtifact(options.dir, 'governance', summary, {
|
|
353
|
+
sourceCommand: normalizedCommand,
|
|
354
|
+
}) : null;
|
|
355
|
+
if (options.out && !options.json) {
|
|
356
|
+
console.log(` Governance report written to ${options.out}`);
|
|
357
|
+
console.log('');
|
|
358
|
+
}
|
|
359
|
+
if (snapshot && !options.json) {
|
|
360
|
+
console.log(` Snapshot saved: ${snapshot.relativePath}`);
|
|
361
|
+
console.log(` Snapshot index: ${snapshot.indexPath}`);
|
|
362
|
+
console.log('');
|
|
363
|
+
}
|
|
325
364
|
} else if (normalizedCommand === 'benchmark') {
|
|
326
365
|
const report = await runBenchmark(options);
|
|
366
|
+
const snapshot = options.snapshot ? writeSnapshotArtifact(options.dir, 'benchmark', report, {
|
|
367
|
+
sourceCommand: normalizedCommand,
|
|
368
|
+
}) : null;
|
|
327
369
|
if (options.out) {
|
|
328
370
|
writeBenchmarkReport(report, options.out);
|
|
329
371
|
}
|
|
@@ -332,6 +374,11 @@ async function main() {
|
|
|
332
374
|
console.log(` Benchmark report written to ${options.out}`);
|
|
333
375
|
console.log('');
|
|
334
376
|
}
|
|
377
|
+
if (snapshot && !options.json) {
|
|
378
|
+
console.log(` Snapshot saved: ${snapshot.relativePath}`);
|
|
379
|
+
console.log(` Snapshot index: ${snapshot.indexPath}`);
|
|
380
|
+
console.log('');
|
|
381
|
+
}
|
|
335
382
|
} else if (normalizedCommand === 'deep-review') {
|
|
336
383
|
const { deepReview } = require('../src/deep-review');
|
|
337
384
|
await deepReview(options);
|
|
@@ -345,6 +392,14 @@ async function main() {
|
|
|
345
392
|
await setup(options);
|
|
346
393
|
} else {
|
|
347
394
|
const result = await audit(options);
|
|
395
|
+
const snapshot = options.snapshot ? writeSnapshotArtifact(options.dir, 'audit', result, {
|
|
396
|
+
sourceCommand: normalizedCommand,
|
|
397
|
+
}) : null;
|
|
398
|
+
if (snapshot && !options.json) {
|
|
399
|
+
console.log(` Snapshot saved: ${snapshot.relativePath}`);
|
|
400
|
+
console.log(` Snapshot index: ${snapshot.indexPath}`);
|
|
401
|
+
console.log('');
|
|
402
|
+
}
|
|
348
403
|
if (options.threshold !== null && result.score < options.threshold) {
|
|
349
404
|
if (!options.json) {
|
|
350
405
|
console.error(` Threshold failed: score ${result.score}/100 is below required ${options.threshold}/100.\n`);
|
|
@@ -0,0 +1,91 @@
|
|
|
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/58 | X/58 | +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.*
|
|
@@ -0,0 +1,37 @@
|
|
|
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."
|
|
@@ -0,0 +1,20 @@
|
|
|
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
|
|
@@ -0,0 +1,9 @@
|
|
|
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
|
+
}
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
# Launch Posts — Ready to Publish
|
|
2
|
+
|
|
3
|
+
## Post 1: Reddit r/ClaudeAI
|
|
4
|
+
|
|
5
|
+
**Title:** I built a tool that audits your project for Claude Code optimization — scores you 0-100
|
|
6
|
+
|
|
7
|
+
**Body:**
|
|
8
|
+
After cataloging 1,107 Claude Code entries and verifying 948 of them with evidence, I built a CLI that checks if your project is actually set up to get the most out of Claude Code.
|
|
9
|
+
|
|
10
|
+
Most projects score around 10-20/100. After running setup, they jump to 70+.
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
npx claudex-setup
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
It checks for: CLAUDE.md, hooks, custom commands, skills, agents, Mermaid diagrams, XML tags, path rules, MCP config, permissions, and more.
|
|
17
|
+
|
|
18
|
+
Then `npx claudex-setup setup` auto-creates everything that's missing, tailored to your stack (React, Python, TypeScript, etc).
|
|
19
|
+
|
|
20
|
+
Zero dependencies. No API keys. Runs entirely local.
|
|
21
|
+
|
|
22
|
+
GitHub: https://github.com/DnaFin/claudex-setup
|
|
23
|
+
|
|
24
|
+
Would love feedback!
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## Post 2: Reddit r/ChatGPTCoding
|
|
29
|
+
|
|
30
|
+
**Title:** Your Claude Code project is probably running at 10% efficiency. Here's how to check.
|
|
31
|
+
|
|
32
|
+
**Body:**
|
|
33
|
+
I spent weeks cataloging every Claude Code feature, technique, and best practice — 1,107 total, 948 verified with real evidence.
|
|
34
|
+
|
|
35
|
+
Turns out most projects are missing basic stuff that makes a huge difference:
|
|
36
|
+
- No CLAUDE.md (Claude doesn't know your project conventions)
|
|
37
|
+
- No hooks (no auto-lint, no auto-test)
|
|
38
|
+
- No custom commands (repeating the same prompts manually)
|
|
39
|
+
- No Mermaid diagrams (wasting 73% more tokens on prose descriptions)
|
|
40
|
+
|
|
41
|
+
Built a quick checker:
|
|
42
|
+
```
|
|
43
|
+
npx claudex-setup
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Scores your project 0-100, tells you exactly what to fix, and can auto-apply everything.
|
|
47
|
+
|
|
48
|
+
Free, open source, zero dependencies: https://github.com/DnaFin/claudex-setup
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## Post 3: Dev.to Article
|
|
53
|
+
|
|
54
|
+
**Title:** 1,107 Claude Code Entries: What I Learned Building the Most Comprehensive Catalog
|
|
55
|
+
|
|
56
|
+
**Body (excerpt):**
|
|
57
|
+
I set out to catalog every single Claude Code capability, technique, and best practice. After repeated research cycles, I have 1,107 entries — 948 verified with real evidence.
|
|
58
|
+
|
|
59
|
+
Here are the top 10 things most developers are missing:
|
|
60
|
+
|
|
61
|
+
1. **CLAUDE.md** — Claude reads this at the start of every session. Without it, Claude doesn't know your build commands, code style, or project rules.
|
|
62
|
+
|
|
63
|
+
2. **Mermaid diagrams** — A Mermaid architecture diagram saves 73% tokens compared to describing your project in prose.
|
|
64
|
+
|
|
65
|
+
3. **Hooks** — Auto-lint after every edit. Auto-test before every commit. Hooks fire 100% of the time, CLAUDE.md rules fire ~80%.
|
|
66
|
+
|
|
67
|
+
4. **Custom commands** — `/test`, `/deploy`, `/review` — package your repeated workflows.
|
|
68
|
+
|
|
69
|
+
5. **Verification loops** — Tell Claude how to verify its own work. Include test commands in CLAUDE.md.
|
|
70
|
+
|
|
71
|
+
6. **Path-specific rules** — Different conventions for frontend vs backend files.
|
|
72
|
+
|
|
73
|
+
7. **XML tags** — `<constraints>`, `<validation>` in CLAUDE.md = unambiguous instructions.
|
|
74
|
+
|
|
75
|
+
8. **Custom agents** — Security reviewer, test writer — specialized subagents for focused tasks.
|
|
76
|
+
|
|
77
|
+
9. **Skills** — Domain-specific workflows that load on demand, not every session.
|
|
78
|
+
|
|
79
|
+
10. **MCP servers** — Connect Claude to your database, ticket system, Slack.
|
|
80
|
+
|
|
81
|
+
I packaged this into a CLI that checks your project:
|
|
82
|
+
```
|
|
83
|
+
npx claudex-setup
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Full catalog: https://github.com/DnaFin/claudex-setup
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## Post 4: Twitter/X Thread
|
|
91
|
+
|
|
92
|
+
**Tweet 1:**
|
|
93
|
+
I cataloged 1,107 Claude Code entries and verified 948 of them with evidence.
|
|
94
|
+
|
|
95
|
+
Most projects use less than 5% of what Claude Code can do.
|
|
96
|
+
|
|
97
|
+
Here's a free tool that checks your project and tells you exactly what's missing:
|
|
98
|
+
|
|
99
|
+
npx claudex-setup
|
|
100
|
+
|
|
101
|
+
Thread 🧵👇
|
|
102
|
+
|
|
103
|
+
**Tweet 2:**
|
|
104
|
+
The #1 thing you're probably missing: CLAUDE.md
|
|
105
|
+
|
|
106
|
+
It's a file Claude reads at the start of every session. Without it, Claude doesn't know your:
|
|
107
|
+
- Build commands
|
|
108
|
+
- Code style
|
|
109
|
+
- Testing framework
|
|
110
|
+
- Project architecture
|
|
111
|
+
|
|
112
|
+
Takes 2 minutes to create. Impact: massive.
|
|
113
|
+
|
|
114
|
+
**Tweet 3:**
|
|
115
|
+
#2: Mermaid diagrams in CLAUDE.md
|
|
116
|
+
|
|
117
|
+
A few hundred tokens of Mermaid syntax conveys what takes thousands of tokens in prose.
|
|
118
|
+
|
|
119
|
+
73% token savings = faster responses, lower cost, better context.
|
|
120
|
+
|
|
121
|
+
**Tweet 4:**
|
|
122
|
+
#3: Hooks > CLAUDE.md rules
|
|
123
|
+
|
|
124
|
+
CLAUDE.md instructions = ~80% compliance
|
|
125
|
+
Hooks = 100% enforcement
|
|
126
|
+
|
|
127
|
+
Auto-lint after edits. Block commits without tests. Prevent force-push.
|
|
128
|
+
|
|
129
|
+
Hooks are deterministic. Instructions are advisory.
|
|
130
|
+
|
|
131
|
+
**Tweet 5:**
|
|
132
|
+
Want to check your project in 10 seconds?
|
|
133
|
+
|
|
134
|
+
npx claudex-setup
|
|
135
|
+
|
|
136
|
+
Scores 0-100. Shows what's missing. Auto-fixes with `setup`.
|
|
137
|
+
|
|
138
|
+
Free. Open source. Zero dependencies.
|
|
139
|
+
|
|
140
|
+
https://github.com/DnaFin/claudex-setup
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## Post 5: Hacker News (Show HN)
|
|
145
|
+
|
|
146
|
+
**Title:** Show HN: claudex-setup – Audit any project for Claude Code optimization (1,107 entries)
|
|
147
|
+
|
|
148
|
+
**Body:**
|
|
149
|
+
I built a CLI tool that scores your project against Claude Code best practices.
|
|
150
|
+
|
|
151
|
+
After researching 1,107 entries (948 verified with evidence), most projects score 10-20 out of 100 because they're missing basic optimizations like CLAUDE.md files, hooks, custom commands, and architecture diagrams.
|
|
152
|
+
|
|
153
|
+
npx claudex-setup → audit (0-100 score)
|
|
154
|
+
npx claudex-setup setup → auto-fix
|
|
155
|
+
|
|
156
|
+
Detects your stack (React, Python, TS, Rust, Go, etc) and tailors recommendations.
|
|
157
|
+
|
|
158
|
+
Zero dependencies, no API keys, runs locally.
|
|
159
|
+
|
|
160
|
+
https://github.com/DnaFin/claudex-setup
|