# roku-cli

> Roku CLI Build tools

Latest version **0.3.19** (published 2026-11-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install roku-cli
pnpm add roku-cli
yarn add roku-cli
bun add roku-cli
```

Provides the command `roku`.

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.3.19 |
| Published | 2026-11-19 |
| First published | 2020-12-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 314.1 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 1 |
| Author | Adheus Rangel |
| Maintainers | adheus |

## Links

- npm: https://www.npmjs.com/package/roku-cli
- Repository: https://github.com/adheus/roku-cli
- Homepage: https://github.com/adheus/roku-cli#readme
- Issues: https://github.com/adheus/roku-cli/issues
- npm.io page: https://npm.io/package/roku-cli

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [yargs](https://npm.io/package/yargs.md) ^16.2.0
- [telnet-client](https://npm.io/package/telnet-client.md) ^1.4.9
- [fast-xml-parser](https://npm.io/package/fast-xml-parser.md) ^3.18.0
- [@adheus/roku-deploy](https://npm.io/package/@adheus/roku-deploy.md) https://github.com/adheus/roku-deploy/releases/download/v3.4.3/adheus-roku-deploy-3.4.3.tgz

## Recent versions

- 0.3.19 (latest) — 2026-11-19
- 0.3.18 — 2024-05-03
- 0.3.17 — 2024-05-03
- 0.3.16 — 2024-05-03
- 0.3.15 — 2024-05-03
- 0.3.14 — 2024-05-03
- 0.3.13 — 2024-05-03
- 0.3.12 — 2024-05-03
- 0.3.11 — 2021-07-15
- 0.3.10 — 2021-07-14
- 0.3.9 — 2021-07-13
- 0.3.8 — 2021-07-13
- 0.3.7 — 2021-07-13
- 0.3.6 — 2021-07-13
- 0.3.5 — 2021-07-01
- … 25 more at https://npm.io/package/roku-cli/versions

## README

# roku-cli
A CLI tool for signing Roku packages

#### Installation
```
$ npm install -g roku-cli
```

#### Supported commands are:
```
$ roku deploy
```
Deploy the given project to the Roku device
#### Arguments:
- `-p` or `--path` - path to the roku project

```
$ roku sign
```
Deploys, rekey the device (if needed) with the given signing credentials file and signs the package.
#### Arguments:
- `-n` or `--name` - application package name (without .pkg). defaults to 'app'
- `-p` or `--path` - path to the roku project
- `-s` or `--signing` - path to signing properties folder. This folder must be a folder containing the previous .pkg file and a signing credentials file.
- `-o` or `--output` - path to where the package should be saved. defaults to current working directory. defaults to working directory.

```
$ roku rekey
```
Rekeys a given Roku device by reading the dev_id and password in the given signing properties file.
#### Arguments:
- `-s` or `--signing` - path to signing properties folder. This folder must be a folder containing the previous .pkg file and a signing credentials file.

```
$ roku create-signing-credentials
```
Creates a signing credentials file and a dummy package to be used for future package signing.
#### Arguments:
- `-n` or `--name` - output package filename
- `-o` or `--output` - path to where signing properties should be saved. defaults to working directory.


### What is a signing credentials file?
A signing credentials file is a file in the following format:
```
{
    "dev_id":"aca142f48ff0178977d45f34311eb2e87641626e0",
    "password":"G+3xm/Nr7VR33iqzcXQSDQ=="
}
```

It is a simple way to store and reuse the signing properties required by Roku package generation. 


#### All commands supports passing the following parameters:

- `-d` or `--device` - sets the network address of the Roku device
- `-u` or `--user` - sets the user of the Roku device. defaults to `rokudev`
- `-w` or `--password` - sets the password of the Roku device

Also, device properties can be passed by setting the following environment variables:
`ROKU_DEVICE_ADDRESS`, `ROKU_DEVICE_USERNAME` and `ROKU_DEVICE_PASSWORD`

---
_Source: https://npm.io/package/roku-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
