roguelike-cli 1.1.0 → 1.2.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/README.md +214 -0
- package/package.json +1 -1
- package/INSTALL.md +0 -108
package/README.md
ADDED
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
# Roguelike CLI
|
|
2
|
+
|
|
3
|
+
```
|
|
4
|
+
|
|
|
5
|
+
|
|
|
6
|
+
+ \
|
|
7
|
+
\.G_.*=.
|
|
8
|
+
`(#'/.\ |
|
|
9
|
+
.>' (_--.
|
|
10
|
+
_=/d ,^\
|
|
11
|
+
~~ \)-' '
|
|
12
|
+
/ |
|
|
13
|
+
' '
|
|
14
|
+
|
|
15
|
+
╔═════════════════════════╗
|
|
16
|
+
║ Roguelike CLI v1.1 ║
|
|
17
|
+
╚═════════════════════════╝
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
AI-powered interactive terminal for creating schemas, architectures and todo lists.
|
|
21
|
+
|
|
22
|
+
## Install
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm i -g roguelike-cli
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Usage
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
rlc
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
First run will start the setup wizard to configure:
|
|
35
|
+
- Storage path for your notes
|
|
36
|
+
- AI provider (Claude, GPT, Gemini, Grok)
|
|
37
|
+
- API key
|
|
38
|
+
|
|
39
|
+
## Commands
|
|
40
|
+
|
|
41
|
+
| Command | Description |
|
|
42
|
+
|---------|-------------|
|
|
43
|
+
| `ls` | List all schemas, todos, and notes |
|
|
44
|
+
| `tree` | Show directory tree structure |
|
|
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 |
|
|
65
|
+
|
|
66
|
+
## Workflow
|
|
67
|
+
|
|
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
|
+
```
|
|
80
|
+
> ls | pbcopy
|
|
81
|
+
> tree | pbcopy
|
|
82
|
+
> config | copy
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Examples
|
|
86
|
+
|
|
87
|
+
### Todo List
|
|
88
|
+
|
|
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
|
|
97
|
+
|
|
98
|
+
[Type "save" to create folder opening-company-in-delaware/]
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Cloud Infrastructure Schema
|
|
102
|
+
|
|
103
|
+
```
|
|
104
|
+
> yandex cloud production infrastructure
|
|
105
|
+
|
|
106
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
107
|
+
│ Yandex Cloud │
|
|
108
|
+
│ │
|
|
109
|
+
│ ┌──────────────────┐ ┌──────────────────┐ │
|
|
110
|
+
│ │ back-fastapi │ │ admin-next │ │
|
|
111
|
+
│ │ (VM) │ │ (VM) │ │
|
|
112
|
+
│ └────────┬─────────┘ └──────────────────┘ │
|
|
113
|
+
│ │ │
|
|
114
|
+
│ ├──────────────────┬─────────────────┐ │
|
|
115
|
+
│ │ │ │ │
|
|
116
|
+
│ ┌────────▼────────┐ ┌─────▼──────┐ ┌──────▼────────┐ │
|
|
117
|
+
│ │ PostgreSQL │ │ Redis │ │ Cloudflare │ │
|
|
118
|
+
│ │ (Existing DB) │ │ Cluster │ │ R2 Storage │ │
|
|
119
|
+
│ └─────────────────┘ └────────────┘ └───────────────┘ │
|
|
120
|
+
└─────────────────────────────────────────────────────────────┘
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Web Application Architecture
|
|
124
|
+
|
|
125
|
+
```
|
|
126
|
+
> architecture production redis web application
|
|
127
|
+
|
|
128
|
+
├── load-balancer
|
|
129
|
+
├── web-servers
|
|
130
|
+
│ ├── app-server-1
|
|
131
|
+
│ ├── app-server-2
|
|
132
|
+
│ └── app-server-3
|
|
133
|
+
├── redis
|
|
134
|
+
│ ├── cache-cluster
|
|
135
|
+
│ └── session-store
|
|
136
|
+
└── database
|
|
137
|
+
├── postgres-primary
|
|
138
|
+
└── postgres-replica
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### Kubernetes Cluster
|
|
142
|
+
|
|
143
|
+
```
|
|
144
|
+
> kubernetes cluster with postgres and redis
|
|
145
|
+
|
|
146
|
+
┌─────────────────────────────────────────────────────────────┐
|
|
147
|
+
│ Kubernetes cluster with clusters postgres │
|
|
148
|
+
│ │
|
|
149
|
+
│ ┌──────────────┐ ┌──────────────┐ │
|
|
150
|
+
│ │ postgres │ │ redis │ │
|
|
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
|
+
```
|
|
166
|
+
|
|
167
|
+
### Recipe Steps
|
|
168
|
+
|
|
169
|
+
```
|
|
170
|
+
> todo bake cookies
|
|
171
|
+
|
|
172
|
+
├── Prep
|
|
173
|
+
│ ├── Gather ingredients
|
|
174
|
+
│ └── Preheat oven (375°F)
|
|
175
|
+
├── Mix
|
|
176
|
+
│ ├── Cream butter + sugar
|
|
177
|
+
│ ├── Add eggs + vanilla
|
|
178
|
+
│ └── Mix in flour
|
|
179
|
+
├── Bake
|
|
180
|
+
│ ├── Shape cookies
|
|
181
|
+
│ └── Bake 8-10 min
|
|
182
|
+
└── Cool & store
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### Project Planning
|
|
186
|
+
|
|
187
|
+
```
|
|
188
|
+
> todo launch startup
|
|
189
|
+
|
|
190
|
+
├── Phase 1: Ideation
|
|
191
|
+
│ ├── Market research
|
|
192
|
+
│ ├── Define MVP
|
|
193
|
+
│ └── Create business plan
|
|
194
|
+
├── Phase 2: Development
|
|
195
|
+
│ ├── Build prototype
|
|
196
|
+
│ ├── User testing
|
|
197
|
+
│ └── Iterate
|
|
198
|
+
├── Phase 3: Launch
|
|
199
|
+
│ ├── Marketing campaign
|
|
200
|
+
│ ├── Press release
|
|
201
|
+
│ └── Launch day
|
|
202
|
+
└── Phase 4: Growth
|
|
203
|
+
├── Gather feedback
|
|
204
|
+
├── Scale infrastructure
|
|
205
|
+
└── Hire team
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
## Website
|
|
209
|
+
|
|
210
|
+
**https://www.rlc.rocks**
|
|
211
|
+
|
|
212
|
+
## License
|
|
213
|
+
|
|
214
|
+
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
|
-
|