@caisual/cli 0.17.0 → 0.21.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/LICENSE +21 -0
- package/README.md +38 -0
- package/dist/caisual.mjs +32 -285
- package/package.json +12 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Damiano Rodriguez
|
|
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
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# @caisual/cli
|
|
2
|
+
|
|
3
|
+
Create, test and publish browser games on [Caisual](https://caisual.com), a free home for small browser games with multiplayer built in.
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
npx @caisual/cli init my-game
|
|
7
|
+
cd my-game
|
|
8
|
+
npx @caisual/cli dev
|
|
9
|
+
export CAISUAL_KEY='ck_...'
|
|
10
|
+
npx @caisual/cli publish
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
A game is a folder with `caisual.json`, `client/index.html` and, for rooms, `server.js`. Every publish creates a new immutable version behind one permanent address, `caisual.com/g/<id>`.
|
|
14
|
+
|
|
15
|
+
## Commands
|
|
16
|
+
|
|
17
|
+
```text
|
|
18
|
+
caisual init [--multiplayer | --arcade] [folder]
|
|
19
|
+
caisual dev [folder] [--port 8790] [--day YYYY-MM-DD] [--latency ms [--jitter ms] [--loss percent]]
|
|
20
|
+
caisual check [folder] [--json]
|
|
21
|
+
caisual publish [folder]
|
|
22
|
+
caisual versions [folder|id]
|
|
23
|
+
caisual rollback [folder|id] --to <n>
|
|
24
|
+
caisual unlist [folder|id]
|
|
25
|
+
caisual relist [folder|id]
|
|
26
|
+
caisual delete [folder|id] --yes
|
|
27
|
+
caisual skill
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
`dev` runs the game locally with the production handshake, several guests and network simulation. `check` runs every local validation used by publish without a key. `skill` writes the publishing guide, the kit reference and the index of the guides into `.claude/skills/caisual/SKILL.md`, so a coding agent reads the rules before it starts; `init` does the same in the new folder.
|
|
31
|
+
|
|
32
|
+
## Documentation
|
|
33
|
+
|
|
34
|
+
- [Publishing guide](https://caisual.com/publish.md): the folder, the manifest, the limits and every command.
|
|
35
|
+
- [Kit reference](https://caisual.com/kit.md): the API the game calls, from [`@caisual/kit`](https://www.npmjs.com/package/@caisual/kit).
|
|
36
|
+
- [Guides](https://caisual.com/docs) and [llms.txt](https://caisual.com/llms.txt) for coding agents.
|
|
37
|
+
|
|
38
|
+
Requires Node.js 20 or newer. Publishing is free; games run on caisual.com.
|