@remix-gg/cli
v0.9.0
Published
Typed CLI command layer for Remix.gg agent services
Readme
@remix-gg/cli
The official CLI for Remix.
Built for humans, AI Agents, and CI/CD pipelines.
▄▄▄▄▄▄▄ ▄▄▄▄▄▄▄ ▄▄▄ ▄▄▄ ▄▄▄▄▄ ▄▄▄ ▄▄▄
███▀▀███▄ ███▀▀▀▀▀ ████▄ ▄████ ███ ████▄████
███▄▄███▀ ███▄▄ ███▀████▀███ ███ ▀█████▀
███▀▀██▄ ███ ███ ▀▀ ███ ███ ▄███████▄
███ ▀███ ▀███████ ███ ███ ▄███▄ ███▀ ▀███ Install
curl -fsSL https://remix.gg/install.sh | bashOr use npm directly:
npm install -g @remix-gg/cliQuick Start
Authenticate:
remix loginInspect the active auth/config context:
remix whoami
remix whoami --jsonCreate or update a game:
remix games create --name "My Game"
remix games icon upload ./icon.png
remix games versions code update --code-path ./game.htmlManage shop items:
remix games items list
remix games items create --name "Extra Life" --bits-cost 50
remix games items create --name "Premium Skin" --item-type ONE_TIME --bits-cost 100
remix games items update --item-id item_xxx --bits-cost 75
remix games items delete --item-id item_xxxOutput
The CLI is human-readable in interactive terminals and machine-readable for agents:
--jsonforces JSON output- non-TTY stdout defaults to JSON output
--quietsuppresses human-only status output and implies--json
Examples:
remix whoami --json
remix games list --json
remix games create --name "My Game" | jqAuth And Config
Runtime config precedence is:
- explicit command flags
- environment variables
- stored config/credentials
- defaults
Supported environment variables:
REMIX_API_KEYREMIX_API_URL
Stored files:
- global credentials:
~/.config/remix/credentials.json - project config: nearest
.remix-cli.json
For local development:
remix config set --api-url http://localhost:3003
remix loginCommands
remix loginremix whoamiremix config setremix config getremix config whereremix health getremix games listremix games getremix games createremix games assets listremix games assets uploadremix games icon uploadremix games categories setremix games launch-readiness getremix games versions listremix games versions getremix games versions code getremix games versions code updateremix games versions thread getremix games versions status getremix games versions validate getremix games items listremix games items createremix games items updateremix games items deleteremix metadata categories list
Use built-in help for command details:
remix --help
remix login --help
remix games assets upload --helpDevelopment
bun run build
bun run test
remix list-tools
remix games assets upload ./hero.png hero-image
remix games versions code update --code-path ./game.html