About remix-cli
A command-line skill for managing Remix games and related project workflows. It covers authentication, configuration, uploads, versions, readiness, shop items, and analytics, with JSON output for automation.
Key features
- 01Authentication and configuration
- 02Game and asset management
- 03Version code upload and validation
- 04Launch readiness and analytics
- 05Shop item management
- 06JSON output for automation
Use cases
- 01Creating a game and uploading code
- 02Managing game assets and versions
- 03Inspecting launch readiness and analytics
- 04Parsing CLI output in agent workflows
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ farworld-labs/ remix-skills --skill remix-cliAfter installing, type/remix-cliin Claude Code to confirm it loaded.
Bundled filesagents/openai.yaml
Details
From the project READMERemix Cli
Overview
Use the remix CLI for human-facing terminal workflows. Prefer it over handwritten REST calls when the task is local auth, config management, game creation, asset uploads, code uploads, or analytics inspection.
Quick Start
Install and authenticate:
curl -fsSL https://remix.gg/install.sh | bash
remix login
remix whoami
remix login <deviceCode>
Create and upload a game:
remix games create --name "My Game"
remix games icon upload ./icon.png
remix games versions code update --code-path ./game.html
remix games versions validate get
Output Modes
--jsonforces machine-readable output.- non-TTY stdout defaults to JSON.
--quietsuppresses human-only status output and implies JSON-friendly output.
Use JSON mode for agent parsing and shell pipelines.
Config Model
- Project config lives in the nearest
.remix-cli.json. - Credentials live in
~/.config/remix/credentials.json. - Legacy
.remix-mcp.jsoncan still be discovered, but new CLI config is.remix-cli.json. REMIX_API_URLoverrides the API base URL for CLI commands.- Runtime precedence is:
- explicit flags
- environment variables
- stored config and credentials
- defaults
Useful inspection commands:
remix config get
remix config where
remix whoami --json
Commands To Reach For
- Auth:
remix login,remix whoami - Config:
remix config set|get|where - Health:
remix health get - Games:
remix games list|get|create - Assets:
remix games assets list|upload,remix games icon upload - Metadata:
remix metadata categories list,remix games categories set - Versions:
remix games versions list|get|code get|code update|thread get|status get|validate get - Readiness:
remix games launch-readiness get - Analytics:
remix games analytics overview get,remix games analytics shop get,remix games analytics leaderboard get - Shop items:
remix games items list|create|update|delete
Guardrails
- Reuse
gameIdandversionIdfrom.remix-cli.jsonwhen present. - Run
remix whoamibefore debugging auth manually. - If
remix loginis interrupted after it prints a device code, resume withremix login <deviceCode>instead of starting a second device-auth flow. - Use
remix games listonly when the user explicitly wants their game list. - Prefer
remix games versions code update --code-path ...over constructing raw upload requests by hand. - For local development against a non-production API, set
remix config set --api-url http://localhost:3003.
Comments
Markdown supported