rk create

The rk create command creates scaffolding for a new RSG 2.0 SDK application.

Synopsis

Run the command with the following syntax:

rk create <app-name> [options]

See rk create for more information on every option, including component name, title, output directory, and --no-install.

A standalone app gets a pnpm-workspace.yaml file with the allowBuilds decisions pnpm 11 requires before it installs. Inside an existing pnpm workspace, the command does not write a file, and the workspace root's allowBuilds must cover @roku-sdk/tooling, @parcel/watcher, esbuild, and unrs-resolver. If the install fails, rk create prints pnpm's own error and leaves the app files in place.

Examples

The following examples show how to run the command with different options:

# Create an app with default settings
rk create my-app

# Set a custom component name
rk create my-app --component MainScene

# Set a custom title
rk create my-app --title "My App"

# Specify the output directory
rk create my-app --output ../projects/my-app

# Skip the dependency installation
rk create my-app --no-install