mirror of
https://github.com/balena-io/balena-cli.git
synced 2024-12-22 23:12:22 +00:00
865 lines
16 KiB
Markdown
865 lines
16 KiB
Markdown
# Resin CLI Documentation
|
|
|
|
This tool allows you to interact with the resin.io api from the comfort of your command line.
|
|
|
|
To get started download the CLI from npm.
|
|
|
|
$ npm install resin-cli -g
|
|
|
|
Then authenticate yourself:
|
|
|
|
$ resin login
|
|
|
|
Now you have access to all the commands referenced below.
|
|
|
|
# Table of contents
|
|
|
|
- Application
|
|
|
|
- [app create <name>](#app-create-60-name-62-)
|
|
- [apps](#apps)
|
|
- [app <name>](#app-60-name-62-)
|
|
- [app restart <name>](#app-restart-60-name-62-)
|
|
- [app rm <name>](#app-rm-60-name-62-)
|
|
|
|
- Authentication
|
|
|
|
- [login](#login)
|
|
- [logout](#logout)
|
|
- [signup](#signup)
|
|
- [whoami](#whoami)
|
|
|
|
- Device
|
|
|
|
- [devices](#devices)
|
|
- [device <uuid>](#device-60-uuid-62-)
|
|
- [device register <application>](#device-register-60-application-62-)
|
|
- [device rm <uuid>](#device-rm-60-uuid-62-)
|
|
- [device identify <uuid>](#device-identify-60-uuid-62-)
|
|
- [device reboot <uuid>](#device-reboot-60-uuid-62-)
|
|
- [device rename <uuid> [newName]](#device-rename-60-uuid-62-newname-)
|
|
- [device move <uuid>](#device-move-60-uuid-62-)
|
|
- [device init](#device-init)
|
|
|
|
- Environment Variables
|
|
|
|
- [envs](#envs)
|
|
- [env rm <id>](#env-rm-60-id-62-)
|
|
- [env add <key> [value]](#env-add-60-key-62-value-)
|
|
- [env rename <id> <value>](#env-rename-60-id-62-60-value-62-)
|
|
|
|
- Help
|
|
|
|
- [help [command...]](#help-command-)
|
|
|
|
- Information
|
|
|
|
- [version](#version)
|
|
|
|
- Keys
|
|
|
|
- [keys](#keys)
|
|
- [key <id>](#key-60-id-62-)
|
|
- [key rm <id>](#key-rm-60-id-62-)
|
|
- [key add <name> [path]](#key-add-60-name-62-path-)
|
|
|
|
- Logs
|
|
|
|
- [logs <uuid>](#logs-60-uuid-62-)
|
|
|
|
- Sync
|
|
|
|
- [sync [source]](#sync-source-)
|
|
|
|
- SSH
|
|
|
|
- [ssh <uuid>](#ssh-60-uuid-62-)
|
|
|
|
- Notes
|
|
|
|
- [note <|note>](#note-60-note-62-)
|
|
|
|
- OS
|
|
|
|
- [os download <type>](#os-download-60-type-62-)
|
|
- [os configure <image> <uuid>](#os-configure-60-image-62-60-uuid-62-)
|
|
- [os initialize <image>](#os-initialize-60-image-62-)
|
|
|
|
- Config
|
|
|
|
- [config read](#config-read)
|
|
- [config write <key> <value>](#config-write-60-key-62-60-value-62-)
|
|
- [config inject <file>](#config-inject-60-file-62-)
|
|
- [config reconfigure](#config-reconfigure)
|
|
- [config generate](#config-generate)
|
|
|
|
- Settings
|
|
|
|
- [settings](#settings)
|
|
|
|
- Wizard
|
|
|
|
- [quickstart [name]](#quickstart-name-)
|
|
|
|
# Application
|
|
|
|
## app create <name>
|
|
|
|
Use this command to create a new resin.io application.
|
|
|
|
You can specify the application type with the `--type` option.
|
|
Otherwise, an interactive dropdown will be shown for you to select from.
|
|
|
|
You can see a list of supported device types with
|
|
|
|
$ resin devices supported
|
|
|
|
Examples:
|
|
|
|
$ resin app create MyApp
|
|
$ resin app create MyApp --type raspberry-pi
|
|
|
|
### Options
|
|
|
|
#### --type, -t <type>
|
|
|
|
application type
|
|
|
|
## apps
|
|
|
|
Use this command to list all your applications.
|
|
|
|
Notice this command only shows the most important bits of information for each app.
|
|
If you want detailed information, use resin app <name> instead.
|
|
|
|
Examples:
|
|
|
|
$ resin apps
|
|
|
|
## app <name>
|
|
|
|
Use this command to show detailed information for a single application.
|
|
|
|
Examples:
|
|
|
|
$ resin app MyApp
|
|
|
|
## app restart <name>
|
|
|
|
Use this command to restart all devices that belongs to a certain application.
|
|
|
|
Examples:
|
|
|
|
$ resin app restart MyApp
|
|
|
|
## app rm <name>
|
|
|
|
Use this command to remove a resin.io application.
|
|
|
|
Notice this command asks for confirmation interactively.
|
|
You can avoid this by passing the `--yes` boolean option.
|
|
|
|
Examples:
|
|
|
|
$ resin app rm MyApp
|
|
$ resin app rm MyApp --yes
|
|
|
|
### Options
|
|
|
|
#### --yes, -y
|
|
|
|
confirm non interactively
|
|
|
|
# Authentication
|
|
|
|
## login
|
|
|
|
Use this command to login to your resin.io account.
|
|
|
|
This command will prompt you to login using the following login types:
|
|
|
|
- Web authorization: open your web browser and prompt you to authorize the CLI
|
|
from the dashboard.
|
|
|
|
- Credentials: using email/password and 2FA.
|
|
|
|
- Token: using the authentication token from the preferences page.
|
|
|
|
Examples:
|
|
|
|
$ resin login
|
|
$ resin login --web
|
|
$ resin login --token "..."
|
|
$ resin login --credentials
|
|
$ resin login --credentials --email johndoe@gmail.com --password secret
|
|
|
|
### Options
|
|
|
|
#### --token, -t <token>
|
|
|
|
auth token
|
|
|
|
#### --web, -w
|
|
|
|
web-based login
|
|
|
|
#### --credentials, -c
|
|
|
|
credential-based login
|
|
|
|
#### --email, --e,u, --e,u <email>
|
|
|
|
email
|
|
|
|
#### --password, -p <password>
|
|
|
|
password
|
|
|
|
## logout
|
|
|
|
Use this command to logout from your resin.io account.o
|
|
|
|
Examples:
|
|
|
|
$ resin logout
|
|
|
|
## signup
|
|
|
|
Use this command to signup for a resin.io account.
|
|
|
|
If signup is successful, you'll be logged in to your new user automatically.
|
|
|
|
Examples:
|
|
|
|
$ resin signup
|
|
Email: me@mycompany.com
|
|
Username: johndoe
|
|
Password: ***********
|
|
|
|
$ resin whoami
|
|
johndoe
|
|
|
|
## whoami
|
|
|
|
Use this command to find out the current logged in username and email address.
|
|
|
|
Examples:
|
|
|
|
$ resin whoami
|
|
|
|
# Device
|
|
|
|
## devices
|
|
|
|
Use this command to list all devices that belong to you.
|
|
|
|
You can filter the devices by application by using the `--application` option.
|
|
|
|
Examples:
|
|
|
|
$ resin devices
|
|
$ resin devices --application MyApp
|
|
$ resin devices --app MyApp
|
|
$ resin devices -a MyApp
|
|
|
|
### Options
|
|
|
|
#### --application, --a,app, --a,app <application>
|
|
|
|
application name
|
|
|
|
## device <uuid>
|
|
|
|
Use this command to show information about a single device.
|
|
|
|
Examples:
|
|
|
|
$ resin device 7cf02a6
|
|
|
|
## device register <application>
|
|
|
|
Use this command to register a device to an application.
|
|
|
|
Examples:
|
|
|
|
$ resin device register MyApp
|
|
|
|
### Options
|
|
|
|
#### --uuid, -u <uuid>
|
|
|
|
custom uuid
|
|
|
|
## device rm <uuid>
|
|
|
|
Use this command to remove a device from resin.io.
|
|
|
|
Notice this command asks for confirmation interactively.
|
|
You can avoid this by passing the `--yes` boolean option.
|
|
|
|
Examples:
|
|
|
|
$ resin device rm 7cf02a6
|
|
$ resin device rm 7cf02a6 --yes
|
|
|
|
### Options
|
|
|
|
#### --yes, -y
|
|
|
|
confirm non interactively
|
|
|
|
## device identify <uuid>
|
|
|
|
Use this command to identify a device.
|
|
|
|
In the Raspberry Pi, the ACT led is blinked several times.
|
|
|
|
Examples:
|
|
|
|
$ resin device identify 23c73a1
|
|
|
|
## device reboot <uuid>
|
|
|
|
Use this command to remotely reboot a device
|
|
|
|
Examples:
|
|
|
|
$ resin device reboot 23c73a1
|
|
|
|
## device rename <uuid> [newName]
|
|
|
|
Use this command to rename a device.
|
|
|
|
If you omit the name, you'll get asked for it interactively.
|
|
|
|
Examples:
|
|
|
|
$ resin device rename 7cf02a6
|
|
$ resin device rename 7cf02a6 MyPi
|
|
|
|
## device move <uuid>
|
|
|
|
Use this command to move a device to another application you own.
|
|
|
|
If you omit the application, you'll get asked for it interactively.
|
|
|
|
Examples:
|
|
|
|
$ resin device move 7cf02a6
|
|
$ resin device move 7cf02a6 --application MyNewApp
|
|
|
|
### Options
|
|
|
|
#### --application, --a,app, --a,app <application>
|
|
|
|
application name
|
|
|
|
## device init
|
|
|
|
Use this command to download the OS image of a certain application and write it to an SD Card.
|
|
|
|
Notice this command may ask for confirmation interactively.
|
|
You can avoid this by passing the `--yes` boolean option.
|
|
|
|
Examples:
|
|
|
|
$ resin device init
|
|
$ resin device init --application MyApp
|
|
|
|
### Options
|
|
|
|
#### --application, --a,app, --a,app <application>
|
|
|
|
application name
|
|
|
|
#### --yes, -y
|
|
|
|
confirm non interactively
|
|
|
|
#### --advanced, -v
|
|
|
|
enable advanced configuration
|
|
|
|
# Environment Variables
|
|
|
|
## envs
|
|
|
|
Use this command to list all environment variables for
|
|
a particular application or device.
|
|
|
|
This command lists all custom environment variables.
|
|
If you want to see all environment variables, including private
|
|
ones used by resin, use the verbose option.
|
|
|
|
Example:
|
|
|
|
$ resin envs --application MyApp
|
|
$ resin envs --application MyApp --verbose
|
|
$ resin envs --device 7cf02a6
|
|
|
|
### Options
|
|
|
|
#### --application, --a,app, --a,app <application>
|
|
|
|
application name
|
|
|
|
#### --device, -d <device>
|
|
|
|
device uuid
|
|
|
|
#### --verbose, -v
|
|
|
|
show private environment variables
|
|
|
|
## env rm <id>
|
|
|
|
Use this command to remove an environment variable from an application.
|
|
|
|
Don't remove resin specific variables, as things might not work as expected.
|
|
|
|
Notice this command asks for confirmation interactively.
|
|
You can avoid this by passing the `--yes` boolean option.
|
|
|
|
If you want to eliminate a device environment variable, pass the `--device` boolean option.
|
|
|
|
Examples:
|
|
|
|
$ resin env rm 215
|
|
$ resin env rm 215 --yes
|
|
$ resin env rm 215 --device
|
|
|
|
### Options
|
|
|
|
#### --yes, -y
|
|
|
|
confirm non interactively
|
|
|
|
#### --device, -d
|
|
|
|
device
|
|
|
|
## env add <key> [value]
|
|
|
|
Use this command to add an enviroment variable to an application.
|
|
|
|
If value is omitted, the tool will attempt to use the variable's value
|
|
as defined in your host machine.
|
|
|
|
Use the `--device` option if you want to assign the environment variable
|
|
to a specific device.
|
|
|
|
If the value is grabbed from the environment, a warning message will be printed.
|
|
Use `--quiet` to remove it.
|
|
|
|
Examples:
|
|
|
|
$ resin env add EDITOR vim --application MyApp
|
|
$ resin env add TERM --application MyApp
|
|
$ resin env add EDITOR vim --device 7cf02a6
|
|
|
|
### Options
|
|
|
|
#### --application, --a,app, --a,app <application>
|
|
|
|
application name
|
|
|
|
#### --device, -d <device>
|
|
|
|
device uuid
|
|
|
|
## env rename <id> <value>
|
|
|
|
Use this command to rename an enviroment variable from an application.
|
|
|
|
Pass the `--device` boolean option if you want to rename a device environment variable.
|
|
|
|
Examples:
|
|
|
|
$ resin env rename 376 emacs
|
|
$ resin env rename 376 emacs --device
|
|
|
|
### Options
|
|
|
|
#### --device, -d
|
|
|
|
device
|
|
|
|
# Help
|
|
|
|
## help [command...]
|
|
|
|
Get detailed help for an specific command.
|
|
|
|
Examples:
|
|
|
|
$ resin help apps
|
|
$ resin help os download
|
|
|
|
### Options
|
|
|
|
#### --verbose, -v
|
|
|
|
show additional commands
|
|
|
|
# Information
|
|
|
|
## version
|
|
|
|
Display the Resin CLI version.
|
|
|
|
# Keys
|
|
|
|
## keys
|
|
|
|
Use this command to list all your SSH keys.
|
|
|
|
Examples:
|
|
|
|
$ resin keys
|
|
|
|
## key <id>
|
|
|
|
Use this command to show information about a single SSH key.
|
|
|
|
Examples:
|
|
|
|
$ resin key 17
|
|
|
|
## key rm <id>
|
|
|
|
Use this command to remove a SSH key from resin.io.
|
|
|
|
Notice this command asks for confirmation interactively.
|
|
You can avoid this by passing the `--yes` boolean option.
|
|
|
|
Examples:
|
|
|
|
$ resin key rm 17
|
|
$ resin key rm 17 --yes
|
|
|
|
### Options
|
|
|
|
#### --yes, -y
|
|
|
|
confirm non interactively
|
|
|
|
## key add <name> [path]
|
|
|
|
Use this command to associate a new SSH key with your account.
|
|
|
|
If `path` is omitted, the command will attempt
|
|
to read the SSH key from stdin.
|
|
|
|
Examples:
|
|
|
|
$ resin key add Main ~/.ssh/id_rsa.pub
|
|
$ cat ~/.ssh/id_rsa.pub | resin key add Main
|
|
|
|
# Logs
|
|
|
|
## logs <uuid>
|
|
|
|
Use this command to show logs for a specific device.
|
|
|
|
By default, the command prints all log messages and exit.
|
|
|
|
To continuously stream output, and see new logs in real time, use the `--tail` option.
|
|
|
|
Note that for now you need to provide the whole UUID for this command to work correctly.
|
|
|
|
This is due to some technical limitations that we plan to address soon.
|
|
|
|
Examples:
|
|
|
|
$ resin logs 23c73a1
|
|
$ resin logs 23c73a1
|
|
|
|
### Options
|
|
|
|
#### --tail, -t
|
|
|
|
continuously stream output
|
|
|
|
# Sync
|
|
|
|
## sync [source]
|
|
|
|
WARNING: If you're running Windows, this command only supports `cmd.exe`.
|
|
|
|
Use this command to sync your local changes to a certain device on the fly.
|
|
|
|
The `source` argument can be either a device uuid or an application name.
|
|
|
|
You can save all the options mentioned below in a `resin-sync.yml` file,
|
|
by using the same option names as keys. For example:
|
|
|
|
$ cat $PWD/resin-sync.yml
|
|
source: src/
|
|
before: 'echo Hello'
|
|
ignore:
|
|
- .git
|
|
- node_modules/
|
|
progress: true
|
|
|
|
Notice that explicitly passed command options override the ones set in the configuration file.
|
|
|
|
Examples:
|
|
|
|
$ resin sync MyApp
|
|
$ resin sync 7cf02a6
|
|
$ resin sync 7cf02a6 --port 8080
|
|
$ resin sync 7cf02a6 --ignore foo,bar
|
|
|
|
### Options
|
|
|
|
#### --source, -s <path>
|
|
|
|
custom source path
|
|
|
|
#### --ignore, -i <paths>
|
|
|
|
comma delimited paths to ignore when syncing
|
|
|
|
#### --before, -b <command>
|
|
|
|
execute a command before syncing
|
|
|
|
#### --progress, -p
|
|
|
|
show progress
|
|
|
|
#### --port, -t <port>
|
|
|
|
ssh port
|
|
|
|
# SSH
|
|
|
|
## ssh <uuid>
|
|
|
|
WARNING: If you're running Windows, this command only supports `cmd.exe`.
|
|
|
|
Use this command to get a shell into the running application container of
|
|
your device.
|
|
|
|
Examples:
|
|
|
|
$ resin ssh 7cf02a6
|
|
$ resin ssh 7cf02a6 --port 8080
|
|
|
|
### Options
|
|
|
|
#### --port, -t <port>
|
|
|
|
ssh gateway port
|
|
|
|
# Notes
|
|
|
|
## note <|note>
|
|
|
|
Use this command to set or update a device note.
|
|
|
|
If note command isn't passed, the tool attempts to read from `stdin`.
|
|
|
|
To view the notes, use $ resin device <uuid>.
|
|
|
|
Examples:
|
|
|
|
$ resin note "My useful note" --device 7cf02a6
|
|
$ cat note.txt | resin note --device 7cf02a6
|
|
|
|
### Options
|
|
|
|
#### --device, --d,dev, --d,dev <device>
|
|
|
|
device uuid
|
|
|
|
# OS
|
|
|
|
## os download <type>
|
|
|
|
Use this command to download an unconfigured os image for a certain device type.
|
|
|
|
Examples:
|
|
|
|
$ resin os download parallella -o ../foo/bar/parallella.img
|
|
|
|
### Options
|
|
|
|
#### --output, -o <output>
|
|
|
|
output path
|
|
|
|
## os configure <image> <uuid>
|
|
|
|
Use this command to configure a previously download operating system image with a device.
|
|
|
|
Examples:
|
|
|
|
$ resin os configure ../path/rpi.img 7cf02a6
|
|
|
|
### Options
|
|
|
|
#### --advanced, -v
|
|
|
|
show advanced commands
|
|
|
|
## os initialize <image>
|
|
|
|
Use this command to initialize a previously configured operating system image.
|
|
|
|
Examples:
|
|
|
|
$ resin os initialize ../path/rpi.img --type 'raspberry-pi'
|
|
|
|
### Options
|
|
|
|
#### --yes, -y
|
|
|
|
confirm non interactively
|
|
|
|
#### --type, -t <type>
|
|
|
|
device type
|
|
|
|
#### --drive, -d <drive>
|
|
|
|
drive
|
|
|
|
# Config
|
|
|
|
## config read
|
|
|
|
Use this command to read the config.json file from a provisioned device
|
|
|
|
Examples:
|
|
|
|
$ resin config read --type raspberry-pi
|
|
$ resin config read --type raspberry-pi --drive /dev/disk2
|
|
|
|
### Options
|
|
|
|
#### --type, -t <type>
|
|
|
|
device type
|
|
|
|
#### --drive, -d <drive>
|
|
|
|
drive
|
|
|
|
## config write <key> <value>
|
|
|
|
Use this command to write the config.json file of a provisioned device
|
|
|
|
Examples:
|
|
|
|
$ resin config write --type raspberry-pi username johndoe
|
|
$ resin config write --type raspberry-pi --drive /dev/disk2 username johndoe
|
|
$ resin config write --type raspberry-pi files.network/settings "..."
|
|
|
|
### Options
|
|
|
|
#### --type, -t <type>
|
|
|
|
device type
|
|
|
|
#### --drive, -d <drive>
|
|
|
|
drive
|
|
|
|
## config inject <file>
|
|
|
|
Use this command to inject a config.json file to a provisioned device
|
|
|
|
Examples:
|
|
|
|
$ resin config inject my/config.json --type raspberry-pi
|
|
$ resin config inject my/config.json --type raspberry-pi --drive /dev/disk2
|
|
|
|
### Options
|
|
|
|
#### --type, -t <type>
|
|
|
|
device type
|
|
|
|
#### --drive, -d <drive>
|
|
|
|
drive
|
|
|
|
## config reconfigure
|
|
|
|
Use this command to reconfigure a provisioned device
|
|
|
|
Examples:
|
|
|
|
$ resin config reconfigure --type raspberry-pi
|
|
$ resin config reconfigure --type raspberry-pi --advanced
|
|
$ resin config reconfigure --type raspberry-pi --drive /dev/disk2
|
|
|
|
### Options
|
|
|
|
#### --type, -t <type>
|
|
|
|
device type
|
|
|
|
#### --drive, -d <drive>
|
|
|
|
drive
|
|
|
|
#### --advanced, -v
|
|
|
|
show advanced commands
|
|
|
|
## config generate
|
|
|
|
Use this command to generate a config.json for a device or application
|
|
|
|
Examples:
|
|
|
|
$ resin config generate --device 7cf02a6
|
|
$ resin config generate --device 7cf02a6 --output config.json
|
|
$ resin config generate --app MyApp
|
|
$ resin config generate --app MyApp --output config.json
|
|
|
|
### Options
|
|
|
|
#### --application, --a,app, --a,app <application>
|
|
|
|
application name
|
|
|
|
#### --device, -d <device>
|
|
|
|
device uuid
|
|
|
|
#### --output, -o <output>
|
|
|
|
output
|
|
|
|
# Settings
|
|
|
|
## settings
|
|
|
|
Use this command to display detected settings
|
|
|
|
Examples:
|
|
|
|
$ resin settings
|
|
|
|
# Wizard
|
|
|
|
## quickstart [name]
|
|
|
|
Use this command to run a friendly wizard to get started with resin.io.
|
|
|
|
The wizard will guide you through:
|
|
|
|
- Create an application.
|
|
- Initialise an SDCard with the resin.io operating system.
|
|
- Associate an existing project directory with your resin.io application.
|
|
- Push your project to your devices.
|
|
|
|
Examples:
|
|
|
|
$ resin quickstart
|
|
$ resin quickstart MyApp
|
|
|