roguelike-cli 1.2.0 → 1.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/README.md +233 -139
- package/dist/interactive/startup.js +1 -1
- package/package.json +1 -1
- package/src/interactive/startup.ts +1 -1
package/README.md
CHANGED
|
@@ -13,202 +13,296 @@
|
|
|
13
13
|
' '
|
|
14
14
|
|
|
15
15
|
╔═════════════════════════╗
|
|
16
|
-
║
|
|
16
|
+
║ Roguelike CLI ║
|
|
17
17
|
╚═════════════════════════╝
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
## What is this?
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
**A new format for notes, schemas, and todo lists — where every task is a folder.**
|
|
23
23
|
|
|
24
|
-
|
|
25
|
-
npm i -g roguelike-cli
|
|
26
|
-
```
|
|
24
|
+
Instead of flat text files, your tasks become a **file system tree**. Nested tasks = nested folders. You can:
|
|
27
25
|
|
|
28
|
-
|
|
26
|
+
- **Navigate** your todos like directories (`cd`, `ls`, `tree`)
|
|
27
|
+
- **Attach files** directly to tasks (just put them in the folder)
|
|
28
|
+
- **Track dependencies** and blockers between tasks
|
|
29
|
+
- **Generate beautiful visualizations** — trees, block diagrams, and even **dungeon maps**
|
|
30
|
+
- Let **AI help** you structure complex projects
|
|
31
|
+
|
|
32
|
+
## Why folders?
|
|
29
33
|
|
|
30
|
-
```
|
|
31
|
-
|
|
34
|
+
```
|
|
35
|
+
project/
|
|
36
|
+
├── phase-1-research/
|
|
37
|
+
│ ├── market-analysis/
|
|
38
|
+
│ │ └── competitors.xlsx ← attach files directly!
|
|
39
|
+
│ └── user-interviews/
|
|
40
|
+
├── phase-2-development/
|
|
41
|
+
│ ├── backend-api/
|
|
42
|
+
│ ├── frontend-ui/
|
|
43
|
+
│ └── database-schema/
|
|
44
|
+
└── phase-3-launch/
|
|
45
|
+
├── marketing/
|
|
46
|
+
└── deployment/
|
|
32
47
|
```
|
|
33
48
|
|
|
34
|
-
|
|
35
|
-
- Storage path for your notes
|
|
36
|
-
- AI provider (Claude, GPT, Gemini, Grok)
|
|
37
|
-
- API key
|
|
49
|
+
Your file manager becomes your task manager. Git tracks your progress. AI generates the structure.
|
|
38
50
|
|
|
39
|
-
##
|
|
51
|
+
## Install
|
|
40
52
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
| `tree -A` | Show tree with files |
|
|
46
|
-
| `tree --depth=N` | Limit tree depth |
|
|
47
|
-
| `cd <node>` | Navigate into a node |
|
|
48
|
-
| `cd ..` | Go back to parent |
|
|
49
|
-
| `..` | Same as cd .. |
|
|
50
|
-
| `pwd` | Show current path |
|
|
51
|
-
| `open` | Open current folder in Finder |
|
|
52
|
-
| `open <folder>` | Open specific folder in Finder |
|
|
53
|
-
| `mkdir <name>` | Create new folder |
|
|
54
|
-
| `cp <src> <dest>` | Copy file or folder |
|
|
55
|
-
| `mv <src> <dest>` | Move/rename file or folder |
|
|
56
|
-
| `rm <name>` | Delete file |
|
|
57
|
-
| `rm -rf <name>` | Delete folder recursively |
|
|
58
|
-
| `config` | Show configuration |
|
|
59
|
-
| `config:apiKey=<key>` | Set API key |
|
|
60
|
-
| `init` | Run setup wizard |
|
|
61
|
-
| `help` | Show examples |
|
|
62
|
-
| `clean` | Show items to delete |
|
|
63
|
-
| `clean --yes` | Delete all items in current folder |
|
|
64
|
-
| `exit` / `quit` | Exit the program |
|
|
53
|
+
```bash
|
|
54
|
+
npm i -g roguelike-cli
|
|
55
|
+
rlc
|
|
56
|
+
```
|
|
65
57
|
|
|
66
58
|
## Workflow
|
|
67
59
|
|
|
68
|
-
1. Type description (e.g., `todo: deploy app`)
|
|
69
|
-
2. AI generates schema preview
|
|
70
|
-
3. Refine with more instructions if needed
|
|
71
|
-
4. Type `save` to save or `cancel` to discard
|
|
72
|
-
|
|
73
|
-
**Todo** creates folder structure, **Schema** saves as `.rlc.schema` file.
|
|
74
|
-
|
|
75
|
-
## Clipboard
|
|
76
|
-
|
|
77
|
-
Add `| pbcopy` (macOS), `| copy` or `| clip` (Windows) to any command:
|
|
78
|
-
|
|
79
60
|
```
|
|
80
|
-
>
|
|
81
|
-
|
|
82
|
-
|
|
61
|
+
> todo launch my startup
|
|
62
|
+
|
|
63
|
+
├── Research
|
|
64
|
+
│ ├── Market analysis
|
|
65
|
+
│ ├── Competitor research
|
|
66
|
+
│ └── User interviews
|
|
67
|
+
├── Development
|
|
68
|
+
│ ├── MVP features
|
|
69
|
+
│ ├── Backend API
|
|
70
|
+
│ └── Frontend UI
|
|
71
|
+
├── Launch
|
|
72
|
+
│ ├── Marketing campaign
|
|
73
|
+
│ └── Press release
|
|
74
|
+
└── Growth
|
|
75
|
+
├── Metrics tracking
|
|
76
|
+
└── User feedback
|
|
77
|
+
|
|
78
|
+
[Type "save" to create folder launch-my-startup/]
|
|
79
|
+
> save
|
|
80
|
+
Created todo folder: launch-my-startup/
|
|
81
|
+
|
|
82
|
+
> cd launch-my-startup
|
|
83
|
+
> tree
|
|
84
|
+
├── research/
|
|
85
|
+
│ ├── market-analysis/
|
|
86
|
+
│ ├── competitor-research/
|
|
87
|
+
│ └── user-interviews/
|
|
88
|
+
├── development/
|
|
89
|
+
│ ├── mvp-features/
|
|
90
|
+
│ ├── backend-api/
|
|
91
|
+
│ └── frontend-ui/
|
|
92
|
+
├── launch/
|
|
93
|
+
│ ├── marketing-campaign/
|
|
94
|
+
│ └── press-release/
|
|
95
|
+
└── growth/
|
|
96
|
+
├── metrics-tracking/
|
|
97
|
+
└── user-feedback/
|
|
83
98
|
```
|
|
84
99
|
|
|
85
|
-
|
|
100
|
+
Now you can `cd development/backend-api` and drop your actual code files there!
|
|
86
101
|
|
|
87
|
-
|
|
102
|
+
## Visualizations
|
|
88
103
|
|
|
89
|
-
|
|
90
|
-
> todo opening company in delaware
|
|
91
|
-
|
|
92
|
-
├── register business name
|
|
93
|
-
├── file incorporation papers
|
|
94
|
-
├── get EIN number
|
|
95
|
-
└── Branch: legal
|
|
96
|
-
└── open business bank account
|
|
104
|
+
### Tree View (default)
|
|
97
105
|
|
|
98
|
-
|
|
106
|
+
```
|
|
107
|
+
├── Phase 1: Setup
|
|
108
|
+
│ ├── Create repository
|
|
109
|
+
│ ├── Setup CI/CD
|
|
110
|
+
│ └── Configure environment
|
|
111
|
+
├── Phase 2: Development
|
|
112
|
+
│ ├── Backend API
|
|
113
|
+
│ └── Frontend UI
|
|
114
|
+
└── Phase 3: Deploy
|
|
99
115
|
```
|
|
100
116
|
|
|
101
|
-
###
|
|
117
|
+
### Block Diagram (for architecture)
|
|
102
118
|
|
|
103
119
|
```
|
|
104
|
-
>
|
|
120
|
+
> schema kubernetes cluster
|
|
105
121
|
|
|
106
122
|
┌─────────────────────────────────────────────────────────────┐
|
|
107
|
-
│
|
|
123
|
+
│ Kubernetes Cluster │
|
|
108
124
|
│ │
|
|
109
|
-
│
|
|
110
|
-
│ │
|
|
111
|
-
│ │
|
|
112
|
-
│
|
|
113
|
-
│
|
|
114
|
-
│
|
|
115
|
-
│
|
|
116
|
-
│
|
|
117
|
-
│
|
|
118
|
-
│
|
|
119
|
-
│
|
|
125
|
+
│ ┌──────────────┐ ┌──────────────┐ │
|
|
126
|
+
│ │ postgres │ │ redis │ │
|
|
127
|
+
│ │ │ │ │ │
|
|
128
|
+
│ │ primary-pod │ │ cache-pod-1 │ │
|
|
129
|
+
│ │ replica-pod │ │ cache-pod-2 │ │
|
|
130
|
+
│ └──────┬───────┘ └──────┬───────┘ │
|
|
131
|
+
│ └──────────┬───────────┘ │
|
|
132
|
+
│ ▼ │
|
|
133
|
+
│ ┌───────────────┐ │
|
|
134
|
+
│ │ worker-nodes │ │
|
|
135
|
+
│ └───────────────┘ │
|
|
120
136
|
└─────────────────────────────────────────────────────────────┘
|
|
121
137
|
```
|
|
122
138
|
|
|
123
|
-
###
|
|
139
|
+
### Dungeon Map View (roguelike style) 🎮
|
|
124
140
|
|
|
125
|
-
|
|
126
|
-
> architecture production redis web application
|
|
141
|
+
Visualize your project as a dungeon map! Each room is a task, corridors show dependencies.
|
|
127
142
|
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
143
|
+
```
|
|
144
|
+
> map
|
|
145
|
+
|
|
146
|
+
████████████████████████████████████████
|
|
147
|
+
█ █ █
|
|
148
|
+
█ [Research] █ [Development] █
|
|
149
|
+
█ ♦ Market █ ♦ Backend █
|
|
150
|
+
█ ♦ Users ──────+───♦ Frontend █
|
|
151
|
+
█ █ ♦ Database █
|
|
152
|
+
█████████+███████████████████+██████████
|
|
153
|
+
│ │
|
|
154
|
+
█████████+███████████████████+██████████
|
|
155
|
+
█ █ █
|
|
156
|
+
█ [Launch] █ [Growth] █
|
|
157
|
+
█ ♦ Marketing █ ♦ Metrics █
|
|
158
|
+
█ ♦ Press ──────+───♦ Feedback █
|
|
159
|
+
█ ♣ BOSS: Ship it! █ █
|
|
160
|
+
█ █ █
|
|
161
|
+
████████████████████████████████████████
|
|
162
|
+
|
|
163
|
+
Legend: ♦ Task ♣ Milestone + Door/Dependency █ Wall
|
|
139
164
|
```
|
|
140
165
|
|
|
141
|
-
|
|
166
|
+
*Coming soon: Interactive dungeon exploration, XP for completed tasks, achievements!*
|
|
142
167
|
|
|
143
|
-
|
|
144
|
-
> kubernetes cluster with postgres and redis
|
|
168
|
+
## Gamification (Roadmap)
|
|
145
169
|
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
│ │ │ │ │ │
|
|
152
|
-
│ │ primary-pod │ │ cache-pod-1 │ │
|
|
153
|
-
│ │ replica-pod-1│ │ cache-pod-2 │ │
|
|
154
|
-
│ │ replica-pod-2│ │ │ │
|
|
155
|
-
│ └──────┬───────┘ └──────┬───────┘ │
|
|
156
|
-
│ │ │ │
|
|
157
|
-
│ └──────────┬───────────┘ │
|
|
158
|
-
│ │ │
|
|
159
|
-
│ ┌───────▼────────┐ │
|
|
160
|
-
│ │ worker-zones │ │
|
|
161
|
-
│ │ zone-1 │ │
|
|
162
|
-
│ │ zone-2 │ │
|
|
163
|
-
│ └────────────────┘ │
|
|
164
|
-
└─────────────────────────────────────────────────────────────┘
|
|
165
|
-
```
|
|
170
|
+
- 🎯 **XP System** — Earn experience for completing tasks
|
|
171
|
+
- 🏆 **Achievements** — "First Blood", "100 Tasks", "Deep Nesting"
|
|
172
|
+
- 🗡️ **Boss Tasks** — Major milestones as boss fights
|
|
173
|
+
- 🗺️ **Dungeon Maps** — Explore your project as a roguelike dungeon
|
|
174
|
+
- 📊 **Stats** — Track velocity, streaks, completion rates
|
|
166
175
|
|
|
167
|
-
|
|
176
|
+
## Commands
|
|
177
|
+
|
|
178
|
+
| Command | Description |
|
|
179
|
+
|---------|-------------|
|
|
180
|
+
| `ls` | List tasks and files |
|
|
181
|
+
| `tree` | Show task tree |
|
|
182
|
+
| `tree -A` | Include files |
|
|
183
|
+
| `cd <task>` | Enter task |
|
|
184
|
+
| `..` | Go back |
|
|
185
|
+
| `mkdir <name>` | Create task |
|
|
186
|
+
| `open` | Open in Finder |
|
|
187
|
+
| `cp`, `mv`, `rm` | File operations |
|
|
188
|
+
| `config` | Settings |
|
|
189
|
+
| `help` | Examples |
|
|
190
|
+
|
|
191
|
+
## AI Integration
|
|
192
|
+
|
|
193
|
+
Just describe what you need:
|
|
168
194
|
|
|
169
195
|
```
|
|
170
196
|
> todo bake cookies
|
|
171
197
|
|
|
172
198
|
├── Prep
|
|
173
199
|
│ ├── Gather ingredients
|
|
174
|
-
│ └── Preheat oven
|
|
200
|
+
│ └── Preheat oven
|
|
175
201
|
├── Mix
|
|
176
202
|
│ ├── Cream butter + sugar
|
|
177
|
-
│
|
|
178
|
-
|
|
179
|
-
├── Bake
|
|
180
|
-
│ ├── Shape cookies
|
|
181
|
-
│ └── Bake 8-10 min
|
|
203
|
+
│ └── Add flour
|
|
204
|
+
├── Bake (8-10 min)
|
|
182
205
|
└── Cool & store
|
|
206
|
+
|
|
207
|
+
> add deadline tomorrow for Bake
|
|
208
|
+
> add blocker "buy flour" for Mix
|
|
209
|
+
> shorter
|
|
210
|
+
> more detailed
|
|
211
|
+
> save
|
|
183
212
|
```
|
|
184
213
|
|
|
185
|
-
|
|
214
|
+
AI understands context and refines until you're happy.
|
|
215
|
+
|
|
216
|
+
## Examples
|
|
217
|
+
|
|
218
|
+
### Software Project
|
|
186
219
|
|
|
187
220
|
```
|
|
188
|
-
> todo
|
|
221
|
+
> todo build saas app
|
|
222
|
+
|
|
223
|
+
├── Planning
|
|
224
|
+
│ ├── Define MVP scope
|
|
225
|
+
│ ├── Create wireframes
|
|
226
|
+
│ └── Tech stack decision
|
|
227
|
+
├── Backend
|
|
228
|
+
│ ├── Database schema
|
|
229
|
+
│ ├── API endpoints
|
|
230
|
+
│ ├── Authentication
|
|
231
|
+
│ └── Payment integration
|
|
232
|
+
├── Frontend
|
|
233
|
+
│ ├── Components library
|
|
234
|
+
│ ├── Pages
|
|
235
|
+
│ └── State management
|
|
236
|
+
├── DevOps
|
|
237
|
+
│ ├── CI/CD pipeline
|
|
238
|
+
│ ├── Staging environment
|
|
239
|
+
│ └── Production deployment
|
|
240
|
+
└── Launch
|
|
241
|
+
├── Beta testing
|
|
242
|
+
├── Marketing site
|
|
243
|
+
└── Product Hunt launch
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
### Life Goals
|
|
189
247
|
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
├──
|
|
195
|
-
│ ├──
|
|
196
|
-
│
|
|
197
|
-
|
|
198
|
-
├──
|
|
199
|
-
│ ├──
|
|
200
|
-
│
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
248
|
+
```
|
|
249
|
+
> todo learn japanese
|
|
250
|
+
|
|
251
|
+
├── Basics (Month 1-2)
|
|
252
|
+
│ ├── Hiragana
|
|
253
|
+
│ ├── Katakana
|
|
254
|
+
│ └── Basic grammar
|
|
255
|
+
├── Foundation (Month 3-6)
|
|
256
|
+
│ ├── Kanji (500)
|
|
257
|
+
│ ├── Vocabulary (2000 words)
|
|
258
|
+
│ └── Genki textbook
|
|
259
|
+
├── Intermediate (Month 6-12)
|
|
260
|
+
│ ├── JLPT N4 prep
|
|
261
|
+
│ ├── Reading practice
|
|
262
|
+
│ └── Conversation partner
|
|
263
|
+
└── Advanced
|
|
264
|
+
├── JLPT N3
|
|
265
|
+
├── Watch anime without subs
|
|
266
|
+
└── Visit Japan
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
### Infrastructure
|
|
270
|
+
|
|
271
|
+
```
|
|
272
|
+
> schema cloud infrastructure
|
|
273
|
+
|
|
274
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
275
|
+
│ Production │
|
|
276
|
+
│ │
|
|
277
|
+
│ ┌──────────────────┐ ┌──────────────────┐ │
|
|
278
|
+
│ │ Load Balancer │ │ CDN │ │
|
|
279
|
+
│ └────────┬─────────┘ └──────────────────┘ │
|
|
280
|
+
│ │ │
|
|
281
|
+
│ ┌────────▼────────┐ ┌────────────┐ ┌────────────────┐ │
|
|
282
|
+
│ │ App Servers │ │ Redis │ │ PostgreSQL │ │
|
|
283
|
+
│ │ (3 replicas) │──│ Cache │ │ (Primary + │ │
|
|
284
|
+
│ └─────────────────┘ └────────────┘ │ Replica) │ │
|
|
285
|
+
│ └────────────────┘ │
|
|
286
|
+
└─────────────────────────────────────────────────────────────┘
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
## Clipboard
|
|
290
|
+
|
|
291
|
+
```
|
|
292
|
+
> tree | pbcopy # macOS
|
|
293
|
+
> tree | clip # Windows
|
|
206
294
|
```
|
|
207
295
|
|
|
208
296
|
## Website
|
|
209
297
|
|
|
210
298
|
**https://www.rlc.rocks**
|
|
211
299
|
|
|
300
|
+
## Inspired by
|
|
301
|
+
|
|
302
|
+
- [roguelike](https://www.npmjs.com/package/roguelike) — 2D dungeon map generator
|
|
303
|
+
- Unix philosophy — everything is a file
|
|
304
|
+
- GTD methodology — capture, organize, do
|
|
305
|
+
|
|
212
306
|
## License
|
|
213
307
|
|
|
214
308
|
MIT
|
package/package.json
CHANGED