@couch-kit/cli 0.0.6
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 +48 -0
- package/dist/index.js +10003 -0
- package/package.json +32 -0
package/README.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# @couch-kit/cli
|
|
2
|
+
|
|
3
|
+
Developer tooling for Couch Kit.
|
|
4
|
+
|
|
5
|
+
> **Starter Project:** See [Buzz](https://github.com/faluciano/buzz-tv-party-game) for a complete example that uses the CLI to bundle its web controller.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
bun add -d @couch-kit/cli
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Commands
|
|
14
|
+
|
|
15
|
+
### `init`
|
|
16
|
+
|
|
17
|
+
Scaffolds a new web controller project (Vite + React + TypeScript) configured to work with Couch Kit.
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
bunx couch-kit init web-controller
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### `bundle`
|
|
24
|
+
|
|
25
|
+
Builds the web controller and copies the assets into your Android project's `assets/www` folder. This is used when preparing your TV app for release.
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
# Default (looks for ./web-controller and copies to android/app/src/main/assets/www)
|
|
29
|
+
bunx couch-kit bundle
|
|
30
|
+
|
|
31
|
+
# Custom paths
|
|
32
|
+
bunx couch-kit bundle --source ./my-web-app --output ./android/app/src/main/assets/www
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### `simulate`
|
|
36
|
+
|
|
37
|
+
Spawns headless WebSocket bots to simulate players (useful for load testing and quick iteration).
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# Default: 4 bots, ws://localhost:8082
|
|
41
|
+
bunx couch-kit simulate
|
|
42
|
+
|
|
43
|
+
# Custom host + count
|
|
44
|
+
bunx couch-kit simulate --url ws://192.168.1.99:8082 --count 8
|
|
45
|
+
|
|
46
|
+
# Action interval (ms)
|
|
47
|
+
bunx couch-kit simulate --interval 250
|
|
48
|
+
```
|