@idlekit/cli 0.0.0-stage → 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/LICENSE +21 -0
- package/README.md +71 -2
- package/dist/main.js +33652 -0
- package/dist/main.js.map +244 -0
- package/package.json +61 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 imjlk
|
|
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
CHANGED
|
@@ -1,3 +1,72 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @idlekit/cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`idk` is the command-line interface for idle game design evaluation.
|
|
4
|
+
Use it to validate scenarios, run simulations, inspect pacing, compare variants, and tune strategies.
|
|
5
|
+
Official support in v1: Bun `>=1.4.2` only. Node.js and browser runtimes are not part of the v1 compatibility contract.
|
|
6
|
+
|
|
7
|
+
This registry install requires a published package. If it returns `404`, use the repository [local-pack workflow](https://github.com/imjlk/idlekit#try-a-local-package-build), including its overrides for unpublished internal dependencies, in a separate consumer project.
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
bun add -g @idlekit/cli
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Requires Bun `>=1.4.2`.
|
|
14
|
+
|
|
15
|
+
Typical flow:
|
|
16
|
+
|
|
17
|
+
<!-- snippet: snippets/readme/cli-quick-start.sh -->
|
|
18
|
+
```bash
|
|
19
|
+
idk init scenario --track personal --preset builder --out ./my-game-v1.json --name "Space Miner"
|
|
20
|
+
idk validate ./space-miner-v1.json
|
|
21
|
+
idk simulate ./space-miner-v1.json --format json
|
|
22
|
+
idk experience ./space-miner-v1.json --format json
|
|
23
|
+
idk evaluate ./space-miner-v1.json --format md
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Interactive scaffold and review:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
idk init scenario --wizard true --track personal --preset builder --out ./my-game-v1.json
|
|
30
|
+
idk review doctor
|
|
31
|
+
idk review evaluate ./space-miner-v1.json
|
|
32
|
+
idk review compare ./space-miner-v1.json ./space-miner-v1-compare-b.json
|
|
33
|
+
idk tune ./space-miner-v1.json --wizard true
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Shell completion and health check:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
source <(idk completions zsh)
|
|
40
|
+
idk doctor --format md
|
|
41
|
+
idk doctor --fix true --shell zsh
|
|
42
|
+
idk review doctor
|
|
43
|
+
idk setup plugin-trust --plugin ./custom-econ-plugin.ts --out ./.idk/plugin-trust.json
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Worked real-game example in this repository:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
bun run --cwd packages/cli dev -- experience ../../examples/tutorials/14-orbital-foundry-v1.json \
|
|
50
|
+
--plugin ../../examples/plugins/custom-econ-plugin.ts \
|
|
51
|
+
--allow-plugin true \
|
|
52
|
+
--session-pattern twice-daily \
|
|
53
|
+
--days 7 \
|
|
54
|
+
--format json
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Runtime
|
|
58
|
+
|
|
59
|
+
`@idlekit/cli` is maintained as a Bun-first CLI package.
|
|
60
|
+
|
|
61
|
+
- automation path: `evaluate`, `compare --format json`, `experience --format md|json`
|
|
62
|
+
- human review path: `review evaluate`, `review compare`, `review doctor`
|
|
63
|
+
- guided setup path: `init scenario --wizard`, `tune --wizard`, `doctor --fix`, `setup completions`
|
|
64
|
+
- recommended human sequence: `init scenario --wizard` -> `review doctor` -> `review evaluate` -> `review compare` -> `tune --wizard`
|
|
65
|
+
|
|
66
|
+
## Documentation
|
|
67
|
+
|
|
68
|
+
- Repository: [github.com/imjlk/idlekit](https://github.com/imjlk/idlekit)
|
|
69
|
+
- Product roadmap: [docs/roadmap.md](https://github.com/imjlk/idlekit/blob/main/docs/roadmap.md)
|
|
70
|
+
- Start here: [docs/start-here-cli-designer.md](https://github.com/imjlk/idlekit/blob/main/docs/start-here-cli-designer.md)
|
|
71
|
+
- Command reference: [docs/usage-guide.md](https://github.com/imjlk/idlekit/blob/main/docs/usage-guide.md)
|
|
72
|
+
- Typed CSV balance workflow: [docs/balance-sheets.md](https://github.com/imjlk/idlekit/blob/main/docs/balance-sheets.md)
|