roguelike-cli 1.1.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 +308 -0
- package/dist/interactive/startup.js +1 -1
- package/package.json +1 -1
- package/src/interactive/startup.ts +1 -1
- package/INSTALL.md +0 -108
package/README.md
ADDED
|
@@ -0,0 +1,308 @@
|
|
|
1
|
+
# Roguelike CLI
|
|
2
|
+
|
|
3
|
+
```
|
|
4
|
+
|
|
|
5
|
+
|
|
|
6
|
+
+ \
|
|
7
|
+
\.G_.*=.
|
|
8
|
+
`(#'/.\ |
|
|
9
|
+
.>' (_--.
|
|
10
|
+
_=/d ,^\
|
|
11
|
+
~~ \)-' '
|
|
12
|
+
/ |
|
|
13
|
+
' '
|
|
14
|
+
|
|
15
|
+
╔═════════════════════════╗
|
|
16
|
+
║ Roguelike CLI ║
|
|
17
|
+
╚═════════════════════════╝
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## What is this?
|
|
21
|
+
|
|
22
|
+
**A new format for notes, schemas, and todo lists — where every task is a folder.**
|
|
23
|
+
|
|
24
|
+
Instead of flat text files, your tasks become a **file system tree**. Nested tasks = nested folders. You can:
|
|
25
|
+
|
|
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?
|
|
33
|
+
|
|
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/
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Your file manager becomes your task manager. Git tracks your progress. AI generates the structure.
|
|
50
|
+
|
|
51
|
+
## Install
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
npm i -g roguelike-cli
|
|
55
|
+
rlc
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Workflow
|
|
59
|
+
|
|
60
|
+
```
|
|
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/
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Now you can `cd development/backend-api` and drop your actual code files there!
|
|
101
|
+
|
|
102
|
+
## Visualizations
|
|
103
|
+
|
|
104
|
+
### Tree View (default)
|
|
105
|
+
|
|
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
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### Block Diagram (for architecture)
|
|
118
|
+
|
|
119
|
+
```
|
|
120
|
+
> schema kubernetes cluster
|
|
121
|
+
|
|
122
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
123
|
+
│ Kubernetes Cluster │
|
|
124
|
+
│ │
|
|
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
|
+
│ └───────────────┘ │
|
|
136
|
+
└─────────────────────────────────────────────────────────────┘
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Dungeon Map View (roguelike style) 🎮
|
|
140
|
+
|
|
141
|
+
Visualize your project as a dungeon map! Each room is a task, corridors show dependencies.
|
|
142
|
+
|
|
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
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
*Coming soon: Interactive dungeon exploration, XP for completed tasks, achievements!*
|
|
167
|
+
|
|
168
|
+
## Gamification (Roadmap)
|
|
169
|
+
|
|
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
|
|
175
|
+
|
|
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:
|
|
194
|
+
|
|
195
|
+
```
|
|
196
|
+
> todo bake cookies
|
|
197
|
+
|
|
198
|
+
├── Prep
|
|
199
|
+
│ ├── Gather ingredients
|
|
200
|
+
│ └── Preheat oven
|
|
201
|
+
├── Mix
|
|
202
|
+
│ ├── Cream butter + sugar
|
|
203
|
+
│ └── Add flour
|
|
204
|
+
├── Bake (8-10 min)
|
|
205
|
+
└── Cool & store
|
|
206
|
+
|
|
207
|
+
> add deadline tomorrow for Bake
|
|
208
|
+
> add blocker "buy flour" for Mix
|
|
209
|
+
> shorter
|
|
210
|
+
> more detailed
|
|
211
|
+
> save
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
AI understands context and refines until you're happy.
|
|
215
|
+
|
|
216
|
+
## Examples
|
|
217
|
+
|
|
218
|
+
### Software Project
|
|
219
|
+
|
|
220
|
+
```
|
|
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
|
|
247
|
+
|
|
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
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
## Website
|
|
297
|
+
|
|
298
|
+
**https://www.rlc.rocks**
|
|
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
|
+
|
|
306
|
+
## License
|
|
307
|
+
|
|
308
|
+
MIT
|
package/package.json
CHANGED
package/INSTALL.md
DELETED
|
@@ -1,108 +0,0 @@
|
|
|
1
|
-
# Roguelike CLI - Installation Guide
|
|
2
|
-
|
|
3
|
-
## Local Development Setup
|
|
4
|
-
|
|
5
|
-
1. Install dependencies:
|
|
6
|
-
```bash
|
|
7
|
-
cd cli
|
|
8
|
-
npm install
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
2. Build the project:
|
|
12
|
-
```bash
|
|
13
|
-
npm run build
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
3. Link locally for testing:
|
|
17
|
-
```bash
|
|
18
|
-
npm link
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
This will make `rlc` command available globally.
|
|
22
|
-
|
|
23
|
-
4. Test the installation:
|
|
24
|
-
```bash
|
|
25
|
-
rlc
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
## First Run
|
|
29
|
-
|
|
30
|
-
Run `init` to configure:
|
|
31
|
-
```bash
|
|
32
|
-
rlc
|
|
33
|
-
> init
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
Or set API key manually:
|
|
37
|
-
```bash
|
|
38
|
-
> config:apiKey=your-api-key-here
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
## How to Use
|
|
42
|
-
|
|
43
|
-
### View config
|
|
44
|
-
```bash
|
|
45
|
-
> config
|
|
46
|
-
Provider: claude
|
|
47
|
-
Model: claude-sonnet-4-20250514
|
|
48
|
-
API Key: sk-ant-a...1234
|
|
49
|
-
Storage: /Users/you/.rlc/notes
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
### Create schema or todo
|
|
53
|
-
```bash
|
|
54
|
-
> todo opening company in delaware
|
|
55
|
-
> architecture kubernetes cluster with postgres
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
### Navigation
|
|
59
|
-
```bash
|
|
60
|
-
> ls # list files (columns)
|
|
61
|
-
> cd my-project # go into folder
|
|
62
|
-
> cd .. # go back
|
|
63
|
-
> pwd # current path
|
|
64
|
-
> tree # show tree structure
|
|
65
|
-
> tree -A # show tree with files
|
|
66
|
-
> tree --depth=2 # limit depth
|
|
67
|
-
> open # open folder in Finder
|
|
68
|
-
> open my-folder # open specific folder
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
### Copy to clipboard
|
|
72
|
-
Add `| pbcopy` (macOS), `| copy` or `| clip` (Windows) to any command:
|
|
73
|
-
```bash
|
|
74
|
-
> ls | pbcopy
|
|
75
|
-
> tree | pbcopy
|
|
76
|
-
> config | pbcopy
|
|
77
|
-
> pwd | pbcopy
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
### File operations
|
|
81
|
-
```bash
|
|
82
|
-
> mkdir my-note # create folder
|
|
83
|
-
> cp source dest # copy
|
|
84
|
-
> mv source dest # move/rename
|
|
85
|
-
> rm file # delete file
|
|
86
|
-
> rm -rf folder # delete folder
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
## Uninstall
|
|
90
|
-
|
|
91
|
-
```bash
|
|
92
|
-
npm unlink -g roguelike-cli
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
## Troubleshooting
|
|
96
|
-
|
|
97
|
-
If you get "command not found":
|
|
98
|
-
- Make sure `npm link` was run successfully
|
|
99
|
-
- Check that `~/.npm-global/bin` or similar is in your PATH
|
|
100
|
-
|
|
101
|
-
If API errors occur:
|
|
102
|
-
- Verify your API key is set: `config`
|
|
103
|
-
- Check that you have credits/access to Claude API
|
|
104
|
-
|
|
105
|
-
## Website
|
|
106
|
-
|
|
107
|
-
https://www.rlc.rocks
|
|
108
|
-
|