@kplay/cli
v0.1.0
Published
KPlay CLI — upload, update, and download HTML5 games on kplay.games
Maintainers
Readme
kplay
CLI for kplay.games — upload, update, and download HTML5 games from your terminal.
Install
npm install -g @kplay/cliThe binary is installed as kplay.
Requires Node.js 20+.
Login
kplay loginOpens a browser to authorize this machine. The resulting API token is saved to ~/.kplay/config.json.
Alternatives:
kplay login --token kp_xxx— skip browser, provide token directlykplay login --no-browser— paste a token manually
Upload / update a game
# Upload the current directory as a new or existing project
kplay update
# Specify a folder or a pre-built .zip
kplay update ./my-game
kplay update ./my-game.zip
# Force a new project even if .kplay.json exists in cwd
kplay update --new --title "My Game" --publicBehavior:
- If
.kplay.jsonis present in the current directory, overwrites the linked project. - If not, you'll be prompted to pick an existing project or create a new one.
- On first successful upload a hidden
.kplay.jsonis written, so subsequentkplay updateruns target the same project.
Options:
-p, --project <id>— target project ID (overrides.kplay.json)-t, --title <title>— title for a new project--new— force creating a new project--public— make the new project public (new only)--api <url>— override API base URL--token <token>— override API token
Download a game
# Download into the current folder
kplay download
# Pick a specific project and output dir
kplay download --project <id> --out ./restoredFiles stream directly from R2 via presigned URLs (server bandwidth is not used).
Options:
-p, --project <id>— project ID (defaults to.kplay.jsonin cwd, or prompts)-o, --out <dir>— output directory (default: current dir)--force— overwrite files in a non-empty output dir without prompting
Files
~/.kplay/config.json— auth config (API URL + token).kplay.json(per project dir) — link to the remote project; safe to commit or gitignore as you prefer
License
MIT
