claudex-setup 0.2.0 → 0.2.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/APF.md DELETED
@@ -1,121 +0,0 @@
1
- # CLAUDEX-SETUP: Autonomous Project Framework
2
-
3
- ## Project Definition
4
-
5
- **Product:** `claudex-setup` - CLI tool that audits and optimizes any project for Claude Code
6
- **Revenue model:** Free CLI (audience) + Premium newsletter (revenue) + Consulting (high-ticket)
7
- **Unfair advantage:** 972 verified techniques, 773 tested. Nobody else has this.
8
-
9
- ---
10
-
11
- ## Phase 0: Launch Parameters
12
-
13
- - **Budget:** $0 initial (Claude Max already active, n8n running)
14
- - **Revenue target:** First $100 within 30 days
15
- - **Timeline:** MVP in 1 week, launch in 2 weeks
16
- - **Human provides:** npm account, GitHub repo, social media publish (or n8n automation)
17
- - **Claude handles:** Everything else
18
-
19
- ---
20
-
21
- ## Strategy: 3-Layer Revenue
22
-
23
- ### Layer 1: Free CLI (Audience Builder)
24
- ```
25
- npx claudex-setup → audit + setup your project for Claude Code
26
- ```
27
- - Free, open source, zero friction
28
- - Goal: 1,000 downloads in first month
29
- - Converts to newsletter subscribers
30
-
31
- ### Layer 2: Newsletter / Content (Recurring Revenue)
32
- ```
33
- "Claude Code Weekly" - 5 techniques you missed this week
34
- ```
35
- - Free tier: weekly email with 3 tips
36
- - Premium: daily tips + full technique database access ($10/month)
37
- - Source: 972 items = 2+ years of unique daily content
38
-
39
- ### Layer 3: One-time Products (Cash Injection)
40
- ```
41
- "The Claude Code Playbook" - complete guide, $29
42
- ```
43
- - PDF/Notion guide built from catalog + by-usecase.md
44
- - Upsell from free CLI users
45
- - Zero marginal cost
46
-
47
- ---
48
-
49
- ## Build Plan (Priority Order)
50
-
51
- ### Week 1: CLI MVP + GitHub
52
- - [ ] Build `claudex-setup` CLI (audit + setup)
53
- - [ ] Publish to npm
54
- - [ ] GitHub repo with good README
55
- - [ ] Test on 3 real projects
56
-
57
- ### Week 2: Landing Page + Content Pipeline
58
- - [ ] Landing page (Vercel, free)
59
- - [ ] Newsletter setup (Buttondown free tier or similar)
60
- - [ ] Write first 10 newsletter issues from catalog
61
- - [ ] n8n automation: scheduled content publishing
62
-
63
- ### Week 3: Launch
64
- - [ ] Post on Reddit r/ClaudeAI, r/ChatGPTPro
65
- - [ ] Post on Hacker News (Show HN)
66
- - [ ] Post on Dev.to, Medium
67
- - [ ] GitHub: add to awesome-claude-code lists
68
- - [ ] Product Hunt launch
69
-
70
- ### Week 4: Measure + Iterate
71
- - [ ] Track: downloads, stars, subscribers, revenue
72
- - [ ] Analyze: which techniques get most engagement
73
- - [ ] Decide: continue / pivot / expand
74
-
75
- ---
76
-
77
- ## What I Need From You
78
-
79
- ### One-time setup (5 minutes total):
80
- 1. **npm account** - create at npmjs.com if don't have, give me auth token
81
- 2. **GitHub** - create repo `claudex-setup` (or I use existing account)
82
- 3. **Social media** - either:
83
- - Give me access to post (Twitter/X, Reddit)
84
- - OR: I prepare posts, n8n publishes automatically
85
- - OR: I prepare posts, you copy-paste once a day (1 min)
86
-
87
- ### When I ask for budget approval:
88
- - Domain (~$12) - optional, can start with github.io
89
- - Newsletter service - free tier available
90
- - Everything else: $0
91
-
92
- ---
93
-
94
- ## Success Metrics
95
-
96
- | Metric | Week 1 | Week 2 | Week 4 | Month 2 | Pivot if below |
97
- |--------|--------|--------|--------|---------|---------------|
98
- | npm downloads | 50 | 200 | 500 | 2,000 | <100 at week 4 |
99
- | GitHub stars | 10 | 30 | 100 | 300 | <20 at week 4 |
100
- | Newsletter subs | 0 | 20 | 100 | 300 | <30 at week 4 |
101
- | Revenue | $0 | $0 | $50 | $500 | <$50 at month 2 |
102
-
103
- ## Stop Criteria
104
- - Week 4: <100 downloads AND <20 stars → pivot approach
105
- - Month 2: <$50 revenue → reassess product-market fit
106
- - Month 3: <$200 revenue → stop or major pivot
107
-
108
- ## Continue Criteria
109
- - Week 4: 500+ downloads → accelerate content
110
- - Month 2: $200+ revenue → invest in premium features
111
- - Month 3: $1,000+ revenue → dedicated infrastructure
112
-
113
- ---
114
-
115
- ## Decision Log
116
-
117
- | Date | Decision | Reasoning |
118
- |------|----------|-----------|
119
- | 2026-03-30 | Start with CLI + newsletter model | Lowest cost, fastest to market, leverages existing 972 items |
120
- | 2026-03-30 | Free CLI, premium content | CLI builds audience, content monetizes. Proven model. |
121
- | 2026-03-30 | n8n for automation | Already running on Docker, zero additional cost |
package/CLAUDE.md DELETED
@@ -1,42 +0,0 @@
1
- # CLAUDEX-SETUP — Autonomous Product Project
2
-
3
- ## On Every Session Start
4
- 1. Read `apf/state.json` for current metrics
5
- 2. Read `apf/todo.md` for pending tasks
6
- 3. Check metrics:
7
- - npm: `curl -s "https://api.npmjs.org/downloads/point/last-week/claudex-setup"`
8
- - GitHub: `curl -s https://api.github.com/repos/DnaFin/claudex`
9
- - Dev.to: `curl -s -H "api-key: RZ8Zgf5GUcc6dVNErSiwocYu" https://dev.to/api/articles/me?per_page=5`
10
- 4. Update `apf/state.json`
11
- 5. Execute highest priority from `apf/todo.md`
12
- 6. Before ending: update todo.md + state.json + commit + push
13
-
14
- ## Credentials (.env)
15
- - npm: NPM_TOKEN
16
- - GitHub: GITHUB_TOKEN (DnaFin)
17
- - Dev.to: DEVTO_API_KEY
18
- - n8n: N8N_API_KEY (localhost:5678)
19
-
20
- ## Decision Authority
21
- I decide everything autonomously. Ask human ONLY for:
22
- - Budget approval (any spend > $0)
23
- - New account credentials
24
- - Captcha / manual verification
25
-
26
- ## Architecture
27
- ```mermaid
28
- graph TD
29
- CLAUDEX[CLAUDEX Research 1107 items] -->|knowledge| CLI[CLI Tool npx claudex-setup]
30
- CLI -->|downloads| NPM[npm registry]
31
- CLI -->|code| GH[GitHub DnaFin/claudex]
32
- GH -->|hosting| LP[Landing Page]
33
- CLAUDEX -->|content| DT[Dev.to Articles]
34
- DT -->|traffic| GH
35
- N8N[n8n Weekly Publisher] -->|auto-post| DT
36
- Users -->|feedback| CLI
37
- Users -->|feedback| CLAUDEX
38
- ```
39
-
40
- ## Language
41
- - Code: English
42
- - User communication: Hebrew
package/CONTRIBUTING.md DELETED
@@ -1,53 +0,0 @@
1
- # Contributing to claudex-setup
2
-
3
- ## Adding a New Check
4
-
5
- 1. Open `src/techniques.js`
6
- 2. Add an entry to the `CHECKS` array:
7
- ```js
8
- { id: 'my-check', category: 'Quality', weight: 10, label: 'Description',
9
- test: (ctx) => fs.existsSync(path.join(ctx.root, 'some-file')),
10
- fix: 'Add some-file to your project root.' }
11
- ```
12
- 3. The `test` function receives a context object with `root`, `stack`, and `files`
13
- 4. Run `npm test` to verify
14
-
15
- ## Adding a New Template
16
-
17
- 1. Open `src/setup.js`
18
- 2. Add a template function to `TEMPLATES`:
19
- ```js
20
- TEMPLATES['my-template'] = (ctx) => `file content for ${ctx.stack}`;
21
- ```
22
- 3. Register it in the `generateFiles()` function with its output path
23
- 4. Templates receive the same context object as checks
24
-
25
- ## Adding a New Stack
26
-
27
- 1. Open `src/techniques.js`
28
- 2. Add an entry to the `STACKS` object:
29
- ```js
30
- STACKS['my-framework'] = {
31
- detect: (ctx) => ctx.files.includes('my-framework.config.js'),
32
- label: 'My Framework',
33
- testCmd: 'my-framework test',
34
- lintCmd: 'my-framework lint'
35
- };
36
- ```
37
- 3. Stack detection runs before checks, so checks can reference `ctx.stack`
38
-
39
- ## Research Backing
40
-
41
- Every check should trace back to a technique in the [CLAUDEX catalog](https://github.com/DnaFin/claudex). When adding checks, reference the technique ID in a comment:
42
-
43
- ```js
44
- // CLAUDEX: T-042 (Mermaid diagrams reduce token usage by 73%)
45
- ```
46
-
47
- ## Running Tests
48
-
49
- ```bash
50
- npm test
51
- ```
52
-
53
- Tests run all checks against fixture projects in `test/fixtures/`.
package/apf/state.json DELETED
@@ -1,29 +0,0 @@
1
- {
2
- "project": "claudex-setup",
3
- "launched": "2026-03-30",
4
- "version": "0.1.0",
5
- "metrics": {
6
- "npm_downloads_total": 0,
7
- "github_stars": 0,
8
- "devto_views": 0,
9
- "devto_reactions": 0,
10
- "newsletter_subs": 0,
11
- "revenue": 0
12
- },
13
- "platforms": {
14
- "npm": "live",
15
- "github": "live",
16
- "devto": "live",
17
- "landing_page": "live",
18
- "n8n_workflow": "active",
19
- "reddit": "pending_api_approval",
20
- "hackernews": "pending_account_maturity"
21
- },
22
- "content": {
23
- "devto_articles_published": 1,
24
- "reddit_posts": 1,
25
- "launch_posts_ready": 5
26
- },
27
- "last_session": "2026-03-30",
28
- "sessions_total": 1
29
- }
package/apf/todo.md DELETED
@@ -1,40 +0,0 @@
1
- # Task Queue — CLAUDEX-SETUP
2
-
3
- ## Priority 1 (Next Session)
4
- - [ ] Measure: npm downloads, GitHub stars, Dev.to article views
5
- - [ ] Write Dev.to article #2: "5 CLAUDE.md mistakes killing your Claude Code productivity"
6
- - [ ] Improve CLI: add more technique checks (currently 12, target 25)
7
- - [ ] Try Reddit again (comment on existing posts to build karma first)
8
- - [ ] Check if awesome-claude-code PR/issue got response
9
-
10
- ## Priority 2 (This Week)
11
- - [ ] Write Dev.to article #3: "Hooks vs CLAUDE.md: Why 100% beats 80%"
12
- - [ ] Add `--fix` flag to audit (suggest specific fixes inline)
13
- - [ ] Add JSON schema validation for .claude/settings.json
14
- - [ ] Create newsletter signup (Buttondown free tier)
15
- - [ ] Try posting on r/programming (different subreddit, less strict)
16
-
17
- ## Priority 3 (Week 2)
18
- - [ ] Premium content: "Claude Code Playbook" PDF ($29)
19
- - [ ] More stack-specific templates (Django, FastAPI, Rust, Go)
20
- - [ ] Add technique count to CLI output ("12/972 best practices checked")
21
- - [ ] Collect user feedback (GitHub issues, Dev.to comments)
22
- - [ ] Try HN again when account is mature
23
-
24
- ## Priority 4 (Month 1)
25
- - [ ] Newsletter with 3 free tips/week from catalog
26
- - [ ] Premium tier: full technique database access
27
- - [ ] Consulting landing page
28
- - [ ] Cross-post content to Medium, LinkedIn
29
-
30
- ## Completed
31
- - [x] Build CLI MVP (audit + setup)
32
- - [x] Publish to npm
33
- - [x] Create GitHub repo
34
- - [x] Build landing page
35
- - [x] Publish Dev.to article #1
36
- - [x] Post on Reddit r/ClaudeAI (removed by filters)
37
- - [x] Submit to awesome-claude-code
38
- - [x] Setup n8n weekly publisher
39
- - [x] Create publish.js automation tool
40
- - [x] Redesign landing page (anti-AI-slop)
@@ -1,8 +0,0 @@
1
- {
2
- "article": {
3
- "title": "972 Claude Code Techniques: What I Learned Building the Most Comprehensive Catalog",
4
- "published": true,
5
- "tags": ["claude", "ai", "productivity", "devtools"],
6
- "body_markdown": "After 39 research cycles, I cataloged **972 Claude Code techniques** and tested **773 of them with real evidence**. Here are the top 10 things most developers are missing.\n\n## The Problem\n\nClaude Code is incredibly powerful - 74 releases in 52 days, hundreds of features. But most projects barely scratch the surface.\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## Top 10 Things You're Probably Missing\n\n### 1. CLAUDE.md (Impact: 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\nRun `/init` to auto-generate one from your codebase.\n\n### 2. Mermaid Architecture Diagrams (Saves 73% Tokens)\n\nA Mermaid diagram in CLAUDE.md gives Claude your project structure in a fraction of the tokens that prose would require.\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. No exceptions.\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\nClaude performs dramatically better when it can verify its own work. Include test commands in CLAUDE.md.\n\n> This is the single highest-leverage thing you can do. - Anthropic Best Practices\n\n### 6. Path-Specific Rules\n\nDifferent conventions for frontend vs backend files in `.claude/rules/`.\n\n### 7. XML Tags for Structured Prompts\n\nUse `<constraints>`, `<validation>` in CLAUDE.md for unambiguous instructions. 30% quality improvement (Anthropic-measured).\n\n### 8. Custom Agents\n\nSpecialized subagents for focused tasks: security-reviewer, test-writer in `.claude/agents/`.\n\n### 9. Skills (On-Demand Knowledge)\n\nUnlike CLAUDE.md (loaded every session), skills load only when relevant. Run `/fix-issue 1234` and Claude handles the rest.\n\n### 10. MCP Servers\n\nConnect Claude to your database, ticket system, or Slack via MCP configuration.\n\n## Try It Now\n\n```bash\nnpx claudex-setup # Audit (10 seconds)\nnpx claudex-setup setup # Auto-fix\n```\n\nFree, open source, zero dependencies.\n\n**GitHub:** [github.com/DnaFin/claudex](https://github.com/DnaFin/claudex)\n\n---\n\n*Built from [CLAUDEX](https://github.com/DnaFin/claudex) - 972 verified Claude Code techniques, 773 tested with real evidence.*"
7
- }
8
- }
@@ -1,160 +0,0 @@
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 972 Claude Code techniques and testing 773 of them, 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
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 — 972 total, 773 tested 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
49
-
50
- ---
51
-
52
- ## Post 3: Dev.to Article
53
-
54
- **Title:** 972 Claude Code Techniques: 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. 39 research cycles later, I have 972 items — 773 tested 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
87
-
88
- ---
89
-
90
- ## Post 4: Twitter/X Thread
91
-
92
- **Tweet 1:**
93
- I cataloged 972 Claude Code techniques and tested 773 of them.
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
141
-
142
- ---
143
-
144
- ## Post 5: Hacker News (Show HN)
145
-
146
- **Title:** Show HN: claudex-setup – Audit any project for Claude Code optimization (972 techniques)
147
-
148
- **Body:**
149
- I built a CLI tool that scores your project against Claude Code best practices.
150
-
151
- After researching 972 techniques (773 tested live), 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