ideabox 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +14 -0
- package/CLAUDE.md +14 -0
- package/LICENSE +21 -0
- package/README.md +413 -0
- package/bin/cli.mjs +267 -0
- package/package.json +39 -0
- package/skills/backlog/SKILL.md +101 -0
- package/skills/ideabox/SKILL.md +110 -0
- package/skills/ideabox/phases/01-research.md +173 -0
- package/skills/ideabox/phases/02-brainstorm.md +213 -0
- package/skills/ideabox/phases/03-plan.md +166 -0
- package/skills/ideabox/phases/04-build.md +213 -0
- package/skills/ideabox/phases/05-qa.md +135 -0
- package/skills/ideabox/phases/06-polish.md +111 -0
- package/skills/ideabox/phases/07-ship.md +119 -0
- package/skills/ideabox/phases/08-post-ship.md +83 -0
- package/skills/ideabox/phases/09-learn.md +208 -0
- package/skills/ideabox/references/research-sources.md +247 -0
- package/skills/ideabox/references/revenue-models.md +81 -0
- package/skills/ideabox/references/scoring-rubric.md +245 -0
- package/skills/ideabox/references/self-improvement.md +217 -0
- package/skills/profile/SKILL.md +97 -0
- package/skills/research/SKILL.md +62 -0
package/AGENTS.md
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# IdeaBox Agent Rules
|
|
2
|
+
|
|
3
|
+
## Iron Laws (absolute — no exceptions)
|
|
4
|
+
1. NO CODE BEFORE DESIGN APPROVAL — brainstorm phase must complete before any implementation
|
|
5
|
+
2. NO PRODUCTION CODE WITHOUT A FAILING TEST FIRST — TDD in the build phase
|
|
6
|
+
3. NO FIXES WITHOUT ROOT CAUSE INVESTIGATION — systematic debugging, not guess-and-check
|
|
7
|
+
4. NO COMPLETION CLAIMS WITHOUT FRESH VERIFICATION EVIDENCE — run the command, read the output, THEN claim
|
|
8
|
+
|
|
9
|
+
## Pipeline
|
|
10
|
+
- Phases execute sequentially: research -> brainstorm -> plan -> build -> QA -> polish -> ship -> post-ship -> learn
|
|
11
|
+
- Phases 01-04 mandatory, 05-08 skippable, 09 always runs
|
|
12
|
+
- State on disk: read `.ideabox/state.json` before every phase transition
|
|
13
|
+
- Append-only: never modify existing lines in .jsonl files
|
|
14
|
+
- Detailed instructions live in the phase files — loaded automatically by each skill
|
package/CLAUDE.md
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# IdeaBox Agent Rules
|
|
2
|
+
|
|
3
|
+
## Iron Laws (absolute — no exceptions)
|
|
4
|
+
1. NO CODE BEFORE DESIGN APPROVAL — brainstorm phase must complete before any implementation
|
|
5
|
+
2. NO PRODUCTION CODE WITHOUT A FAILING TEST FIRST — TDD in the build phase
|
|
6
|
+
3. NO FIXES WITHOUT ROOT CAUSE INVESTIGATION — systematic debugging, not guess-and-check
|
|
7
|
+
4. NO COMPLETION CLAIMS WITHOUT FRESH VERIFICATION EVIDENCE — run the command, read the output, THEN claim
|
|
8
|
+
|
|
9
|
+
## Pipeline
|
|
10
|
+
- Phases execute sequentially: research -> brainstorm -> plan -> build -> QA -> polish -> ship -> post-ship -> learn
|
|
11
|
+
- Phases 01-04 mandatory, 05-08 skippable, 09 always runs
|
|
12
|
+
- State on disk: read `.ideabox/state.json` before every phase transition
|
|
13
|
+
- Append-only: never modify existing lines in .jsonl files
|
|
14
|
+
- Detailed instructions live in the phase files — loaded automatically by each skill
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Pawan Paudel
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,413 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<h1 align="center">IdeaBox</h1>
|
|
3
|
+
<p align="center">Data-driven project idea engine for coding agents</p>
|
|
4
|
+
</p>
|
|
5
|
+
|
|
6
|
+
<p align="center">
|
|
7
|
+
<a href="https://www.npmjs.com/package/ideabox"><img src="https://img.shields.io/npm/v/ideabox.svg" alt="npm version"></a>
|
|
8
|
+
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT"></a>
|
|
9
|
+
<a href="https://github.com/pawanpaudel93/ideabox"><img src="https://img.shields.io/github/stars/pawanpaudel93/ideabox?style=social" alt="GitHub stars"></a>
|
|
10
|
+
</p>
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
Researches real market demand, scores ideas on monetization and open-source impact, and orchestrates a full **9-phase pipeline** from idea to shipped code. Self-improving — gets smarter with every session.
|
|
15
|
+
|
|
16
|
+
## Table of Contents
|
|
17
|
+
|
|
18
|
+
- [The Problem](#the-problem)
|
|
19
|
+
- [The Solution](#the-solution)
|
|
20
|
+
- [Features](#features)
|
|
21
|
+
- [Installation](#installation)
|
|
22
|
+
- [Usage](#usage)
|
|
23
|
+
- [How It Works](#how-it-works)
|
|
24
|
+
- [Scoring](#scoring)
|
|
25
|
+
- [Data Sources](#data-sources)
|
|
26
|
+
- [Self-Improvement](#self-improvement)
|
|
27
|
+
- [Persistence](#persistence)
|
|
28
|
+
- [Architecture](#architecture)
|
|
29
|
+
- [CLI](#cli)
|
|
30
|
+
- [Requirements](#requirements)
|
|
31
|
+
- [Contributing](#contributing)
|
|
32
|
+
- [License](#license)
|
|
33
|
+
|
|
34
|
+
## The Problem
|
|
35
|
+
|
|
36
|
+
You have Claude Code tokens but no idea what to build. Existing idea generators are either:
|
|
37
|
+
- **Static lists** frozen in time (91K+ stars on app-ideas, never updated)
|
|
38
|
+
- **Thin AI wrappers** that hallucinate untested concepts
|
|
39
|
+
- **Validation-only tools** that require you already have an idea
|
|
40
|
+
|
|
41
|
+
No tool combines real market demand data with developer skill matching in a developer-native workflow.
|
|
42
|
+
|
|
43
|
+
## The Solution
|
|
44
|
+
|
|
45
|
+
IdeaBox researches **real demand signals** from 6 source categories — HN, GitHub, Reddit, npm, the MCP ecosystem, and more. Every idea is backed by evidence, scored on a 60-point rubric, and matched to your skills. Then it orchestrates the entire build pipeline — brainstorm, plan, build, test, polish, and ship.
|
|
46
|
+
|
|
47
|
+
## Features
|
|
48
|
+
|
|
49
|
+
| Feature | Description |
|
|
50
|
+
|---------|-------------|
|
|
51
|
+
| **Data-grounded research** | Parallel subagents search 6 source categories using structured APIs |
|
|
52
|
+
| **60-point scoring rubric** | Revenue potential, market gap, demand signal, feasibility, stack fit, trend momentum |
|
|
53
|
+
| **9-phase pipeline** | Research through shipped code, all in one command |
|
|
54
|
+
| **Visual score bars** | Quick-scan summary table + per-idea score breakdowns |
|
|
55
|
+
| **Deep-interview validation** | Ambiguity scoring across Problem/User/Scope/Revenue dimensions |
|
|
56
|
+
| **Head-to-head comparison** | `/ideabox backlog compare 1 3` for side-by-side analysis |
|
|
57
|
+
| **Acceptance criteria** | Build phase only completes when ALL spec criteria pass |
|
|
58
|
+
| **Handoff documents** | Structured transition docs between phases |
|
|
59
|
+
| **Self-improving** | Learns preferences, adapts source weights, evolves queries |
|
|
60
|
+
| **Phase skipping** | Detects existing artifacts and offers to skip completed phases |
|
|
61
|
+
| **Research history** | Every run auto-saved for trend detection over time |
|
|
62
|
+
| **Resume support** | Save and resume pipeline state across sessions |
|
|
63
|
+
| **Self-contained** | Zero external plugin dependencies |
|
|
64
|
+
| **Cross-agent** | Works with Claude Code and Codex CLI |
|
|
65
|
+
|
|
66
|
+
## Installation
|
|
67
|
+
|
|
68
|
+
### Claude Code Plugin (recommended)
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
claude plugin add pawanpaudel93/ideabox
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Via npm
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
npx ideabox init
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### From Source
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
git clone https://github.com/pawanpaudel93/ideabox.git
|
|
84
|
+
cd ideabox
|
|
85
|
+
npm install
|
|
86
|
+
node bin/cli.mjs init
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Usage
|
|
90
|
+
|
|
91
|
+
```
|
|
92
|
+
/ideabox # Full 9-phase pipeline: research -> ship
|
|
93
|
+
/ideabox research # Browse ideas without building
|
|
94
|
+
/ideabox backlog # View saved ideas
|
|
95
|
+
/ideabox backlog compare 1 3 # Head-to-head idea comparison
|
|
96
|
+
/ideabox profile # Set up or edit your profile
|
|
97
|
+
/ideabox profile # Reset learning data (choose "reset learning")
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### First Run
|
|
101
|
+
|
|
102
|
+
On your first `/ideabox` run, you'll be asked 4 quick setup questions:
|
|
103
|
+
|
|
104
|
+
1. **GitHub username** — scans your repos to understand your tech stack
|
|
105
|
+
2. **Interests** — developer tools, SaaS, mobile, AI/ML, open source, desktop
|
|
106
|
+
3. **Goals** — monetization, open-source impact, or both
|
|
107
|
+
4. **Avoid topics** — optional exclusions (crypto, social media, etc.)
|
|
108
|
+
|
|
109
|
+
After setup, it goes straight to researching ideas.
|
|
110
|
+
|
|
111
|
+
### Example Output
|
|
112
|
+
|
|
113
|
+
```
|
|
114
|
+
## Research Results: 5 ideas scored
|
|
115
|
+
|
|
116
|
+
| # | Idea | Score | Rating | Monetization | Top Signal |
|
|
117
|
+
|----|----------------------------|--------|-------------|------------------|---------------------|
|
|
118
|
+
| 1 | MCP Testing Framework | 48/60 | Exceptional | Freemium $29/mo | 47 upvotes Reddit |
|
|
119
|
+
| 2 | AI Cost Monitor | 42/60 | Strong | SaaS $19/mo | 3 HN threads |
|
|
120
|
+
| 3 | Context Engine CLI | 38/60 | Strong | Open source | 12 GitHub issues |
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
### #1: MCP Testing Framework
|
|
125
|
+
|
|
126
|
+
> Developers cannot test MCP servers before production deployment.
|
|
127
|
+
|
|
128
|
+
Revenue [=========-] 9/10
|
|
129
|
+
Gap [========--] 8/10
|
|
130
|
+
Demand [=========-] 9/10
|
|
131
|
+
Feasibility[========--] 8/10
|
|
132
|
+
Stack Fit [======----] 6/10
|
|
133
|
+
Trend [========--] 8/10
|
|
134
|
+
|
|
135
|
+
Evidence:
|
|
136
|
+
[Reddit] "How do you test MCP servers?" (47 upvotes)
|
|
137
|
+
[HN] "Show HN: MCP server testing" (89 points)
|
|
138
|
+
[GitHub] 12 open issues requesting testing tools
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## How It Works
|
|
142
|
+
|
|
143
|
+
### 9-Phase Pipeline
|
|
144
|
+
|
|
145
|
+
```
|
|
146
|
+
/ideabox
|
|
147
|
+
[1. Research] Parallel subagents search 6 source categories
|
|
148
|
+
[2. Brainstorm] Refine chosen idea into a design spec
|
|
149
|
+
[3. Plan] Create bite-sized TDD implementation plan
|
|
150
|
+
[4. Build] Execute with subagent-driven development
|
|
151
|
+
[5. QA] Systematic testing with health score rubric
|
|
152
|
+
[6. Polish] Visual QA, AI slop detection, accessibility
|
|
153
|
+
[7. Ship] PR creation, version bump, changelog
|
|
154
|
+
[8. Post-Ship] Production monitoring, documentation sync
|
|
155
|
+
[9. Learn] Update preferences, improve future suggestions
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
- Phases 1-4 are **mandatory** (research, brainstorm, plan, build)
|
|
159
|
+
- Phases 5-8 can be **skipped** by user request
|
|
160
|
+
- Phase 9 **always runs** automatically
|
|
161
|
+
|
|
162
|
+
### Phase Gates
|
|
163
|
+
|
|
164
|
+
Each phase has a concrete gate condition:
|
|
165
|
+
|
|
166
|
+
| Phase | Gate Condition |
|
|
167
|
+
|-------|---------------|
|
|
168
|
+
| Research | 3+ ideas with 3+ evidence sources each |
|
|
169
|
+
| Brainstorm | Spec written, self-reviewed, user-approved |
|
|
170
|
+
| Plan | No placeholders, full spec coverage, type consistency |
|
|
171
|
+
| Build | All tests pass, two-stage review (spec + quality) complete |
|
|
172
|
+
| QA | Health score >= 70, zero critical bugs |
|
|
173
|
+
| Polish | Before/after evidence, no AI slop detected |
|
|
174
|
+
| Ship | PR created, CI passes, version bumped |
|
|
175
|
+
| Post-Ship | Canary health check passes or skipped |
|
|
176
|
+
| Learn | Preferences and self-improvement data updated |
|
|
177
|
+
|
|
178
|
+
### Iron Laws
|
|
179
|
+
|
|
180
|
+
Four non-negotiable rules enforced throughout the pipeline:
|
|
181
|
+
|
|
182
|
+
1. **No code before design approval** — brainstorm phase must complete first
|
|
183
|
+
2. **No production code without a failing test** — TDD in the build phase
|
|
184
|
+
3. **No fixes without root cause investigation** — systematic debugging
|
|
185
|
+
4. **No completion claims without verification evidence** — run the command, read the output, then claim
|
|
186
|
+
|
|
187
|
+
## Scoring
|
|
188
|
+
|
|
189
|
+
Every idea must pass a hard filter: **real monetization potential** OR **high open-source impact**.
|
|
190
|
+
|
|
191
|
+
### 6 Dimensions (max 60)
|
|
192
|
+
|
|
193
|
+
| Dimension | What it measures | Bonus |
|
|
194
|
+
|-----------|-----------------|-------|
|
|
195
|
+
| Revenue potential | Willingness to pay, market size, pricing precedent | |
|
|
196
|
+
| Market gap | Number and quality of existing competitors | |
|
|
197
|
+
| Demand signal | Evidence from HN, Reddit, GitHub | +2/+3 cross-source |
|
|
198
|
+
| Feasibility | Can a solo dev build an MVP with AI? | |
|
|
199
|
+
| Stack fit | Match to your known tech stack | Bonus, not blocker |
|
|
200
|
+
| Trend momentum | Is this space growing? | +2 agentic AI |
|
|
201
|
+
|
|
202
|
+
### Score Interpretation
|
|
203
|
+
|
|
204
|
+
| Score | Rating | Action |
|
|
205
|
+
|-------|--------|--------|
|
|
206
|
+
| 45-60 | Exceptional | Build this now |
|
|
207
|
+
| 35-44 | Strong | Worth serious consideration |
|
|
208
|
+
| 25-34 | Decent | Consider if it matches interests |
|
|
209
|
+
| < 25 | Filtered | Not shown |
|
|
210
|
+
|
|
211
|
+
## Data Sources
|
|
212
|
+
|
|
213
|
+
All research uses **token-efficient structured APIs** (not generic web scraping):
|
|
214
|
+
|
|
215
|
+
| Category | What We Search | API |
|
|
216
|
+
|----------|---------------|-----|
|
|
217
|
+
| **Agentic AI** (priority) | Agent frameworks, MCP servers, Claude Code plugins | HN Algolia, GitHub Search |
|
|
218
|
+
| **Developer Pain Points** | Reddit complaints, HN Ask threads | Reddit JSON, HN Algolia |
|
|
219
|
+
| **Trending Projects** | GitHub Trending, Show HN | GitHub Search API |
|
|
220
|
+
| **Indie Hacker Signals** | r/SideProject, r/indiehackers revenue stories | Reddit JSON |
|
|
221
|
+
| **Package Ecosystem** | npm trending, plugin marketplace gaps | npm Registry API |
|
|
222
|
+
| **Your GitHub Profile** | Your repos, languages, project types | GitHub REST API |
|
|
223
|
+
|
|
224
|
+
## Self-Improvement
|
|
225
|
+
|
|
226
|
+
IdeaBox gets smarter the more you use it through **4 auto-iterating loops**:
|
|
227
|
+
|
|
228
|
+
### 1. Preference Learning (immediate)
|
|
229
|
+
Tracks which ideas you accept, dismiss, start, complete, or abandon. Updates category/complexity/monetization scores. Anti-echo-chamber: always reserves 10% for diverse suggestions.
|
|
230
|
+
|
|
231
|
+
### 2. Source Quality Tracking (after 5 sessions)
|
|
232
|
+
Tracks which research sources contribute to ideas you actually choose. High-performing sources get expanded queries; low-performing sources get reduced. Scores clamped to [0.1, 1.0] — nothing fully eliminated.
|
|
233
|
+
|
|
234
|
+
### 3. Scoring Weight Adaptation (after 10 outcomes)
|
|
235
|
+
Tracks which scoring dimensions predict ideas that actually ship. Auto-adjusts weights (e.g., demand signal matters more than feasibility for you). Clamped to [0.5x, 1.5x] to prevent over-fitting.
|
|
236
|
+
|
|
237
|
+
### 4. Query Evolution (after 3 uses per query)
|
|
238
|
+
Tracks which search queries return useful results. Productive queries spawn variations; dead queries retire. Retired queries archived for trend analysis.
|
|
239
|
+
|
|
240
|
+
**Reset:** `/ideabox profile` -> choose "reset learning"
|
|
241
|
+
|
|
242
|
+
## Persistence
|
|
243
|
+
|
|
244
|
+
All data stored locally — nothing leaves your machine:
|
|
245
|
+
|
|
246
|
+
| File | Location | Purpose |
|
|
247
|
+
|------|----------|---------|
|
|
248
|
+
| `profile.json` | `~/.ideabox/` | Interests, stacks, preference scores |
|
|
249
|
+
| `ideas.jsonl` | `~/.ideabox/` | All ideas with scores and status (append-only) |
|
|
250
|
+
| `sessions.jsonl` | `~/.ideabox/` | Research session logs |
|
|
251
|
+
| `preferences.jsonl` | `~/.ideabox/` | Implicit feedback events |
|
|
252
|
+
| `source-quality.jsonl` | `~/.ideabox/` | Source quality tracking |
|
|
253
|
+
| `scoring-feedback.jsonl` | `~/.ideabox/` | Scoring weight adaptation |
|
|
254
|
+
| `query-performance.jsonl` | `~/.ideabox/` | Query evolution data |
|
|
255
|
+
| `research/` | `~/.ideabox/` | Auto-saved research history |
|
|
256
|
+
| `state.json` | `.ideabox/` (per-project) | Pipeline state for resume |
|
|
257
|
+
|
|
258
|
+
## Architecture
|
|
259
|
+
|
|
260
|
+
Self-contained Claude Code plugin. Zero external dependencies.
|
|
261
|
+
|
|
262
|
+
```
|
|
263
|
+
ideabox/
|
|
264
|
+
├── .claude-plugin/
|
|
265
|
+
│ └── plugin.json # Plugin manifest (name: "ideabox")
|
|
266
|
+
├── bin/
|
|
267
|
+
│ └── cli.mjs # CLI: init, uninstall, doctor
|
|
268
|
+
├── skills/
|
|
269
|
+
│ ├── ideabox/ # Main skill (/ideabox)
|
|
270
|
+
│ │ ├── SKILL.md # Pipeline router (~3KB)
|
|
271
|
+
│ │ ├── phases/
|
|
272
|
+
│ │ │ ├── 01-research.md # Parallel API research
|
|
273
|
+
│ │ │ ├── 02-brainstorm.md # Design spec creation
|
|
274
|
+
│ │ │ ├── 03-plan.md # TDD implementation plan
|
|
275
|
+
│ │ │ ├── 04-build.md # Subagent-driven development
|
|
276
|
+
│ │ │ ├── 05-qa.md # Health score testing
|
|
277
|
+
│ │ │ ├── 06-polish.md # Visual QA + AI slop detection
|
|
278
|
+
│ │ │ ├── 07-ship.md # PR + version + changelog
|
|
279
|
+
│ │ │ ├── 08-post-ship.md # Canary + docs sync
|
|
280
|
+
│ │ │ └── 09-learn.md # Self-improvement
|
|
281
|
+
│ │ └── references/
|
|
282
|
+
│ │ ├── research-sources.md
|
|
283
|
+
│ │ ├── scoring-rubric.md
|
|
284
|
+
│ │ ├── revenue-models.md
|
|
285
|
+
│ │ └── self-improvement.md
|
|
286
|
+
│ ├── research/SKILL.md # Browse-only mode
|
|
287
|
+
│ ├── backlog/SKILL.md # Idea management + compare
|
|
288
|
+
│ └── profile/SKILL.md # Profile setup + reset learning
|
|
289
|
+
├── CLAUDE.md # Agent rules (Claude Code)
|
|
290
|
+
├── AGENTS.md # Agent rules (Codex CLI)
|
|
291
|
+
├── package.json
|
|
292
|
+
├── LICENSE
|
|
293
|
+
└── README.md
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
## CLI
|
|
297
|
+
|
|
298
|
+
```bash
|
|
299
|
+
npx ideabox init # Install skills to current project
|
|
300
|
+
npx ideabox uninstall # Remove skills from current project
|
|
301
|
+
npx ideabox doctor # Run health checks
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
The `doctor` command verifies:
|
|
305
|
+
- Node.js >= 18
|
|
306
|
+
- Data directory (`~/.ideabox/`)
|
|
307
|
+
- Profile configured
|
|
308
|
+
- Skills installed (checks Claude Code and Codex paths)
|
|
309
|
+
- CLI availability
|
|
310
|
+
|
|
311
|
+
## Requirements
|
|
312
|
+
|
|
313
|
+
- [Claude Code](https://code.claude.com) or [Codex CLI](https://github.com/openai/codex)
|
|
314
|
+
- Node.js >= 18
|
|
315
|
+
- `gh` CLI recommended (for GitHub API access with higher rate limits)
|
|
316
|
+
|
|
317
|
+
## Permissions
|
|
318
|
+
|
|
319
|
+
IdeaBox uses these tools during its pipeline:
|
|
320
|
+
|
|
321
|
+
| Tool | Phase | Purpose |
|
|
322
|
+
|------|-------|---------|
|
|
323
|
+
| `WebSearch` | Research | Search HN, GitHub, Reddit for demand signals |
|
|
324
|
+
| `WebFetch` | Research | Hit structured APIs (HN Algolia, npm, Reddit JSON) |
|
|
325
|
+
| `Agent` | Research, Build | Parallel subagents for research and implementation |
|
|
326
|
+
| `Read` | All | Read files, state, research artifacts |
|
|
327
|
+
| `Write` | All | Write phase outputs, state, profiles |
|
|
328
|
+
| `Edit` | Build, Polish | Modify source code |
|
|
329
|
+
| `Bash` | Build, QA, Ship | Run tests, git commands, CLI tools |
|
|
330
|
+
| `Glob` / `Grep` | Build, QA | Search codebase |
|
|
331
|
+
|
|
332
|
+
### Claude Code
|
|
333
|
+
|
|
334
|
+
**Option 1: Auto mode (recommended)** — press `Shift+Tab` to toggle. Approves most tool calls with background safety checks. Requires Team/Enterprise/API plan with Sonnet 4.6+ or Opus 4.6+.
|
|
335
|
+
|
|
336
|
+
**Option 2: Accept edits mode** — press `Shift+Tab` to select `acceptEdits`. Auto-approves file changes, prompts for Bash and network.
|
|
337
|
+
|
|
338
|
+
**Option 3: Custom permission rules** — add to `.claude/settings.json` (project) or `~/.claude/settings.json` (global):
|
|
339
|
+
|
|
340
|
+
```json
|
|
341
|
+
{
|
|
342
|
+
"permissions": {
|
|
343
|
+
"allow": [
|
|
344
|
+
"WebSearch",
|
|
345
|
+
"WebFetch",
|
|
346
|
+
"Glob",
|
|
347
|
+
"Grep",
|
|
348
|
+
"Read",
|
|
349
|
+
"Edit",
|
|
350
|
+
"Write",
|
|
351
|
+
"Bash(git *)",
|
|
352
|
+
"Bash(gh *)",
|
|
353
|
+
"Bash(npm *)",
|
|
354
|
+
"Bash(pnpm *)",
|
|
355
|
+
"Bash(node *)"
|
|
356
|
+
]
|
|
357
|
+
}
|
|
358
|
+
}
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
> **Note:** `deny` rules take precedence over `allow`. Protected paths (`.git/`, `.env`) always prompt regardless of mode.
|
|
362
|
+
|
|
363
|
+
### Codex CLI
|
|
364
|
+
|
|
365
|
+
Codex CLI uses different permission flags:
|
|
366
|
+
|
|
367
|
+
```bash
|
|
368
|
+
# Recommended: workspace-write sandbox with auto-approvals
|
|
369
|
+
codex --full-auto "run ideabox research"
|
|
370
|
+
|
|
371
|
+
# More control: approval mode + sandbox separately
|
|
372
|
+
codex -a untrusted -s workspace-write "run ideabox"
|
|
373
|
+
|
|
374
|
+
# Maximum access (use with caution)
|
|
375
|
+
codex --yolo "run ideabox"
|
|
376
|
+
```
|
|
377
|
+
|
|
378
|
+
| Codex Flag | Claude Code Equivalent |
|
|
379
|
+
|-----------|----------------------|
|
|
380
|
+
| `-a on-request` | `default` mode |
|
|
381
|
+
| `-a untrusted` | `acceptEdits` mode |
|
|
382
|
+
| `--full-auto` | `auto` mode (sandboxed) |
|
|
383
|
+
| `--yolo` | `bypassPermissions` mode |
|
|
384
|
+
|
|
385
|
+
## Contributing
|
|
386
|
+
|
|
387
|
+
Contributions welcome! Please:
|
|
388
|
+
|
|
389
|
+
1. Fork the repository
|
|
390
|
+
2. Create a feature branch (`git checkout -b feat/my-feature`)
|
|
391
|
+
3. Make your changes
|
|
392
|
+
4. Run `node bin/cli.mjs doctor` to verify
|
|
393
|
+
5. Submit a pull request
|
|
394
|
+
|
|
395
|
+
## Acknowledgements
|
|
396
|
+
|
|
397
|
+
IdeaBox's pipeline design was inspired by patterns and approaches from these projects:
|
|
398
|
+
|
|
399
|
+
| Project | Inspiration |
|
|
400
|
+
|---------|--------------|
|
|
401
|
+
| [superpowers](https://github.com/obra/superpowers) | Brainstorming workflow, TDD discipline, writing-plans, subagent-driven development, verification-before-completion, systematic debugging |
|
|
402
|
+
| [gstack](https://github.com/garrytan/gstack) | QA health score rubric, design review with AI slop detection, ship workflow, canary monitoring, office-hours forcing questions |
|
|
403
|
+
| [oh-my-claudecode](https://github.com/Yeachan-Heo/oh-my-claudecode) | Deep-interview validation, artifact-based phase skipping, autopilot phase chaining |
|
|
404
|
+
| [last30days-skill](https://github.com/mvanhorn/last30days-skill) | Research stats block, auto-save research history, comparison mode |
|
|
405
|
+
| [Homunculus](https://github.com/humanplane/homunculus) | Implicit feedback tracking, instinct-based self-improvement |
|
|
406
|
+
| [Spec-Flow](https://github.com/marcusgoll/Spec-Flow) | Phase-gate pipeline architecture, progressive disclosure pattern |
|
|
407
|
+
| [planning-with-files](https://github.com/OthmanAdi/planning-with-files) | "Context = RAM, Filesystem = Disk" principle |
|
|
408
|
+
|
|
409
|
+
Thank you to these projects and their maintainers for sharing their work openly.
|
|
410
|
+
|
|
411
|
+
## License
|
|
412
|
+
|
|
413
|
+
[MIT](LICENSE) - [Pawan Paudel](https://github.com/pawanpaudel93)
|