rk create

Summary

Create a new Roku app from the baseline template.

Description

A standalone app gets a pnpm-workspace.yaml with the allowBuilds decisions pnpm 11 requires before it will install. Inside an existing pnpm workspace no file is written, 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.

Usage

rk create <app-name> [options]
ArgumentDescriptionRequiredRepeatable
app-nameName of the app (kebab-case, e.g., my-awesome-app)yesno

Options

FlagAliasValue/typeDefaultRequired
--component—name (string)derived from app-nameno
--title—title (string)derived from app-nameno
--output-odir (string)current directoryno
--no-install—boolean—no

--component

Custom component name in PascalCase

--title

Custom app title

--output

Base directory where to create app folder

--no-install

Skip automatic dependency installation

Examples

rk create my-app
rk create my-app --component MainScene
rk create my-app --output ../projects
rk create my-app --no-install

Did this page help you?