roku-cli

command module
v0.0.0-...-96a5f51 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 19, 2021 License: Apache-2.0 Imports: 3 Imported by: 0

README

Roku CLI

A cross platform Roku CLI written in Go.

Features

  • Manages multiple Roku devices during development
  • Debug Roku output from Telnet ports (TODO)
  • Builds and installs apps onto Roku hardware
  • Builds apps for submission to the Roku Channel Store
  • Scans local network to find all available Roku devices

Installing

  1. Install a recent version of go, like v1.6
  2. go install github.com/jfhbrook/roku-cli

Usage

$ roku-cli COMMAND SUBCOMMAND ARGS

Command: devices|d

All of the devices commands work against your $HOME/.rokuclirc file to store IP address, usernames, and passwords to make working with multiple devices easier.

You can set a current devices and switch between them so that commands like install will always work with the currently active device.

Subcommand: find|f

Scans the local subnet for all available Roku devices.

$ roku-cli devices find
192.168.0.12
192.168.0.100
Subcommand: list|l|ls

List all Roku devices set in your $HOME/.rokuclirc file.

$ roku-cli devices list
0) stick 192.168.0.13 (rokudev/testing12345)
1) roku-3 192.168.0.100 (admin/demo) current
Subcommand: switch|s

Switch Roku devices to set a current one for interacting with.

$ roku-cli devices switch -choice=0
0) stick 192.168.0.13 (rokudev/testing12345) current
1) roku-3 192.168.0.100 (admin/demo)
Subcommand: create|c

Create a new Roku device in your $HOME/.rokuclirc file. All flags are required to create a device.

$ roku-cli devices create --name="roku-2" --ip="10.0.0.12" --username=rokudev --password=roku4life --default=true
0) stick 192.168.0.13 (rokudev/testing12345)
1) roku-3 192.168.0.100 (admin/demo)
2) roku-2 10.0.0.12 (rokudev/roku4life) current
Subcommand: update|u

Update a Roku device in your $HOME/.rokuclirc file. Only flag values that are passed in will be updated. Others will be left alone.

$ roku-cli devices update --choice=1 --name="roku-3" --ip="10.0.0.100"
0) stick 192.168.0.13 (rokudev/testing12345)
1) roku-3 10.0.0.100 (admin/demo)
2) roku-2 10.0.0.12 (rokudev/roku4life) current
Subcommand: delete|d|del

Delete a Roku device in your $HOME/.rokuclirc file.

$ roku-cli devices delete --choice=0
0) stick 192.168.0.13 (rokudev/testing12345) current
1) roku-2 10.0.0.12 (rokudev/roku4life)

Note: Flags also have shorthand versions too.

  • --choice (-c)
  • --name (-n)
  • --ip (-i)
  • --username (-u)
  • --password (-p)
  • --default (-d)
Command: build

This will build a ZIP file to be installed or submitted to Roku for distribution.

$ roku-cli build
Building from path: ./src
Build complete: ./build/channel.zip

$ roku-cli build --source=/some/other/path --destination=/var/tmp --zip=package-v1234.zip
Building from path: /some/other/path
Build complete: /var/tmp/package-v1234.zip
Command: install

This will build a ZIP file and install it to the currently active Roku device.

$ roku-cli install
Building from path: ./src
Build complete: ./build/package.zip
Install complete: roku-2 10.0.0.12
Roku response: "Application Received: 131313131 bytes saves"

$ roku-cli install ~/some/other/path /var/tmp
Building from path: ~/some/other/path
Build complete: /var/tmp/package.zip
Install complete: roku-2 10.0.0.12
Roku response: "Application Received: Identical to previous version -- not replacing"
Command: debug (TODO)

This will connect to the available telnet ports for debugging information being provided by the Roku while your app is running.

$ roku-cli debug
Connected to: roku-2 10.0.0.12

License

Apache 2.0 © Odd Networks

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL