rk sideload
Summary
Sideload a pre-built app to a Roku device without rebuilding.
Description
DEPRECATED: use rk dev --no-build instead. This command still works and its options are unchanged, but it will be removed in a future release. Run rk dev or rk build first to populate the output directory, then modify <out-dir>/pkg-dir/ as needed before running this command.
Usage
rk sideload [options]Options
| Flag | Alias | Value/type | Default | Required |
|---|---|---|---|---|
--config | — | string | roku-config.ts found by walking upward | no |
--device | — | string | — | no |
--host | — | string | — | no |
--password | — | string | — | no |
--out-dir | -od | string | dist-dev | no |
--launch-params | -lp | string | — | no |
--no-launch | — | boolean | — | no |
--config
Path to config file
Example:
rk sideload --config apps/demo/roku-config.ts--device
Target device (ID, IP, or name)
Example:
rk sideload --device 192.168.1.42--host
Connect directly to a device by IPv4 or hostname
--password
Device developer password override
--out-dir
Output directory containing pkg-dir
--launch-params
Launch app after sideloading with these JSON params
Example:
rk sideload --launch-params '{"contentId":"123","mediaType":"movie"}'--no-launch
Sideload without auto-launching app
Examples
rk sideload --out-dir dist-devEnvironment variables
| Environment variable | Description |
|---|---|
RK_RCE_TOKEN | The Roku Cloud Emulator (RCE) token. When set, it takes precedence over the token saved by rk device set-rce-token. That suits CI, where the token comes from a masked variable. |
RK_RCE_API_URL | Points rk at another RCE Core API (an https host under rce.roku.com, or 127.0.0.1, [::1] or localhost on any port, for testing). The default is https://api.rce.roku.com/api/v1. A value that is not a URL is reported by the variable's name, without echoing it. |
RK_RCE_NO_LIFECYCLE | Set to 1 by rk server in the processes it spawns: they use running RCE devices but never start or stop one. Not meant to be set by hand. |
All documented variables are listed on rk environment variables.
See also
Updated about 6 hours ago
Did this page help you?