CLI

@replayablejs/cli installs the replayable executable. Run commands from the playable project root. Configuration files must have a default export.

Command	Purpose	Options
replayable assets	Generate optimized assets and TypeScript modules	-c, --config <file>; default replayable.assets.ts
replayable config	Open the resolved-variant viewer	-c, --config <file>; --json prints JSON instead
replayable dev	Serve one variant with Vite HMR	-c, --config <file>, --host <host>, --language <language>, --version <version>, -o, --open, -p, --port <port>
replayable build	Build all configured variants	-c, --config <file>
replayable export	Export existing variant builds	-c, --config <file>, -o, --output <directory>

Except for assets, configuration defaults to replayable.config.ts. Ports must be integers from 1 through 65535. dev --version selects a project variant, not a package release number. Use replayable --help or <command> --help for command help.

pnpm exec replayable config --json
pnpm exec replayable dev --language en --version default --open
pnpm exec replayable build
pnpm exec replayable export --output exports

Stop development before building the same project. Export reads build output and does not compile application code. Command errors produce a nonzero exit status.

Command implementation.

Development Server

Start the default creative version and choose a configured language:

pnpm exec replayable dev --language en --version default --open

To test from another device on your local network, bind to a reachable interface:

pnpm exec replayable dev --host 0.0.0.0 --port 5173

Use the network URL reported by the server on that device. The language and version must exist in the configuration. Stop the server before generating production builds in the same project.

Inspect Configuration

pnpm exec replayable config
pnpm exec replayable config --json

The viewer helps inspect expanded variants. JSON output is useful when checking resolved parameter values and overrides. These commands use replayable.config.ts unless --config is supplied.

Generate Assets

pnpm exec replayable assets --config replayable.assets.ts

This command uses the standalone asset configuration, which includes its own selected language and fallback. Project builds derive those settings from each variant.

Build and Export

pnpm exec replayable build --config replayable.config.ts
pnpm exec replayable export --config replayable.config.ts --output delivery

Build processes every configured variant. Export reads the resulting files and writes delivery artifacts into delivery in this example. See Build and Export for output paths and common failures.

Troubleshooting

• Configuration file cannot be found: run from the project root or pass --config.
• Configuration is rejected: default-export a valid configuration and inspect the reported field.
• Port is rejected: use an integer from 1 to 65535.
• Export cannot find a build: build with the same configuration before exporting.

For npm projects, replace pnpm exec replayable with npx replayable in these commands.