ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2025-04-28 06:50:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Regenerate docs

Browse Source
This commit is contained in:
Juan Cruz Viotti 2015-07-07 18:01:25 -04:00
parent 0acbdac66f
commit aa3cb39551
3 changed files with 104 additions and 141 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
capitanodoc.json
View File

@ -68,12 +68,6 @@
"lib/actions/notes.coffee" "lib/actions/notes.coffee"
] ]
}, },
{
"title": "OS",
"files": [
"lib/actions/os.coffee"
]
},
{ {
"title": "Plugin", "title": "Plugin",
"files": [ "files": [

224
doc/cli.markdown
View File

@ -16,91 +16,87 @@ Now you have access to all the commands referenced below.
- Application - Application
- [app create <name>](#/pages/using/cli.md#app-create-60-name-62-) - [app create <name>](#app-create-60-name-62-)
- [apps](#/pages/using/cli.md#apps) - [apps](#apps)
- [app <name>](#/pages/using/cli.md#app-60-name-62-) - [app <name>](#app-60-name-62-)
- [app restart <name>](#/pages/using/cli.md#app-restart-60-name-62-) - [app restart <name>](#app-restart-60-name-62-)
- [app rm <name>](#/pages/using/cli.md#app-rm-60-name-62-) - [app rm <name>](#app-rm-60-name-62-)
- [app associate <name>](#/pages/using/cli.md#app-associate-60-name-62-) - [app associate <name>](#app-associate-60-name-62-)
- [init](#/pages/using/cli.md#init) - [init](#init)
- Authentication - Authentication
- [login [token]](#/pages/using/cli.md#login-token-) - [login [token]](#login-token-)
- [logout](#/pages/using/cli.md#logout) - [logout](#logout)
- [signup](#/pages/using/cli.md#signup) - [signup](#signup)
- [whoami](#/pages/using/cli.md#whoami) - [whoami](#whoami)
- Device - Device
- [devices](#/pages/using/cli.md#devices) - [devices](#devices)
- [device <name>](#/pages/using/cli.md#device-60-name-62-) - [device <name>](#device-60-name-62-)
- [device rm <name>](#/pages/using/cli.md#device-rm-60-name-62-) - [device rm <name>](#device-rm-60-name-62-)
- [device identify <uuid>](#/pages/using/cli.md#device-identify-60-uuid-62-) - [device identify <uuid>](#device-identify-60-uuid-62-)
- [device rename <name> [newName]](#/pages/using/cli.md#device-rename-60-name-62-newname-) - [device rename <name> [newName]](#device-rename-60-name-62-newname-)
- [devices supported](#/pages/using/cli.md#devices-supported) - [devices supported](#devices-supported)
- [device await <name>](#/pages/using/cli.md#device-await-60-name-62-) - [device await <name>](#device-await-60-name-62-)
- [device init [device]](#/pages/using/cli.md#device-init-device-) - [device init [device]](#device-init-device-)
- Drive - Drive
- [drives](#/pages/using/cli.md#drives) - [drives](#drives)
- Environment Variables - Environment Variables
- [envs](#/pages/using/cli.md#envs) - [envs](#envs)
- [env rm <id>](#/pages/using/cli.md#env-rm-60-id-62-) - [env rm <id>](#env-rm-60-id-62-)
- [env add <key> [value]](#/pages/using/cli.md#env-add-60-key-62-value-) - [env add <key> [value]](#env-add-60-key-62-value-)
- [env rename <id> <value>](#/pages/using/cli.md#env-rename-60-id-62-60-value-62-) - [env rename <id> <value>](#env-rename-60-id-62-60-value-62-)
- Examples - Examples
- [examples](#/pages/using/cli.md#examples) - [examples](#examples)
- [example <id>](#/pages/using/cli.md#example-60-id-62-) - [example <name>](#example-60-name-62-)
- [example clone <id>](#/pages/using/cli.md#example-clone-60-id-62-) - [example clone <name>](#example-clone-60-name-62-)
- Help - Help
- [help [command...]](#/pages/using/cli.md#help-command-) - [help [command...]](#help-command-)
- Information - Information
- [version](#/pages/using/cli.md#version) - [version](#version)
- [config](#config)
- Keys - Keys
- [keys](#/pages/using/cli.md#keys) - [keys](#keys)
- [key <id>](#/pages/using/cli.md#key-60-id-62-) - [key <id>](#key-60-id-62-)
- [key rm <id>](#/pages/using/cli.md#key-rm-60-id-62-) - [key rm <id>](#key-rm-60-id-62-)
- [key add <name> [path]](#/pages/using/cli.md#key-add-60-name-62-path-) - [key add <name> [path]](#key-add-60-name-62-path-)
- Logs - Logs
- [logs <uuid>](#/pages/using/cli.md#logs-60-uuid-62-) - [logs <uuid>](#logs-60-uuid-62-)
- Notes - Notes
- [note <|note>](#/pages/using/cli.md#note-60-note-62-) - [note <|note>](#note-60-note-62-)
- OS
- [os download <name>](#/pages/using/cli.md#os-download-60-name-62-)
- [os install <image> [device]](#/pages/using/cli.md#os-install-60-image-62-device-)
- Plugin - Plugin
- [plugins](#/pages/using/cli.md#plugins) - [plugins](#plugins)
- [plugin install <name>](#/pages/using/cli.md#plugin-install-60-name-62-) - [plugin install <name>](#plugin-install-60-name-62-)
- [plugin update <name>](#/pages/using/cli.md#plugin-update-60-name-62-) - [plugin update <name>](#plugin-update-60-name-62-)
- [plugin rm <name>](#/pages/using/cli.md#plugin-rm-60-name-62-) - [plugin rm <name>](#plugin-rm-60-name-62-)
- Preferences - Preferences
- [preferences](#/pages/using/cli.md#preferences) - [preferences](#preferences)
- Update - Update
- [update](#/pages/using/cli.md#update) - [update](#update)
# Application # Application
@ -185,6 +181,12 @@ Examples:
$ resin app associate MyApp $ resin app associate MyApp
$ resin app associate MyApp --project my/app/directory $ resin app associate MyApp --project my/app/directory
### Options
#### --yes, -y
confirm non interactively
## init ## init
Use this command to initialise a directory as a resin application. Use this command to initialise a directory as a resin application.
@ -370,9 +372,7 @@ If `device` is omitted, you will be prompted to select a device interactively.
Notice this command asks for confirmation interactively. Notice this command asks for confirmation interactively.
You can avoid this by passing the `--yes` boolean option. You can avoid this by passing the `--yes` boolean option.
You can quiet the progress bar by passing the `--quiet` boolean option. You can quiet the progress bar and other logging information by passing the `--quiet` boolean option.
You may have to unmount the device before attempting this operation.
You need to configure the network type and other settings: You need to configure the network type and other settings:
@ -424,17 +424,18 @@ Examples:
## envs ## envs
Use this command to list all environment variables for a particular application. Use this command to list all environment variables for
Notice we will support per-device environment variables soon. a particular application or device.
This command lists all custom environment variables set on the devices running This command lists all custom environment variables.
the application. If you want to see all environment variables, including private If you want to see all environment variables, including private
ones used by resin, use the verbose option. ones used by resin, use the verbose option.
Example: Example:
$ resin envs --application 91 $ resin envs --application MyApp
$ resin envs --application 91 --verbose $ resin envs --application MyApp --verbose
$ resin envs --device MyDevice
### Options ### Options
@ -442,6 +443,10 @@ Example:
application name application name
#### --device, -d <device>
device name
#### --verbose, -v #### --verbose, -v
show private environment variables show private environment variables
@ -455,10 +460,13 @@ Don't remove resin specific variables, as things might not work as expected.
Notice this command asks for confirmation interactively. Notice this command asks for confirmation interactively.
You can avoid this by passing the `--yes` boolean option. 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: Examples:
$ resin env rm 215 $ resin env rm 215
$ resin env rm 215 --yes $ resin env rm 215 --yes
$ resin env rm 215 --device
### Options ### Options
@ -466,22 +474,28 @@ Examples:
confirm non interactively confirm non interactively
#### --device, -d
device name
## env add <key> [value] ## env add <key> [value]
Use this command to add an enviroment variable to an application. Use this command to add an enviroment variable to an application.
You need to pass the `--application` option.
If value is omitted, the tool will attempt to use the variable's value If value is omitted, the tool will attempt to use the variable's value
as defined in your host machine. 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. If the value is grabbed from the environment, a warning message will be printed.
Use `--quiet` to remove it. Use `--quiet` to remove it.
Examples: Examples:
$ resin env add EDITOR vim -a 91 $ resin env add EDITOR vim --application MyApp
$ resin env add TERM -a 91 $ resin env add TERM --application MyApp
$ resin env add EDITOR vim --device MyDevice
### Options ### Options
@ -489,13 +503,26 @@ Examples:
application name application name
#### --device, -d <device>
device name
## env rename <id> <value> ## env rename <id> <value>
Use this command to rename an enviroment variable from an application. 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: Examples:
$ resin env rename 376 emacs $ resin env rename 376 emacs
$ resin env rename 376 emacs --device
### Options
#### --device, -d
device name
# Examples # Examples
@ -507,15 +534,15 @@ Example:
$ resin examples $ resin examples
## example <id> ## example <name>
Use this command to show information of a single example application Use this command to show information of a single example application
Example: Example:
$ resin example 3 $ resin example cimon
## example clone <id> ## example clone <name>
Use this command to clone an example application to the current directory Use this command to clone an example application to the current directory
@ -524,7 +551,7 @@ Use `--quiet` to remove that output.
Example: Example:
$ resin example clone 3 $ resin example clone cimon
# Help # Help
@ -543,6 +570,12 @@ Examples:
Display the Resin CLI version. Display the Resin CLI version.
## config
See your current Resin CLI configuration.
Configuration lives in $HOME/.resin/config.
# Keys # Keys
## keys ## keys
@ -645,71 +678,6 @@ Examples:
device name device name
# OS
## os download <name>
Use this command to download the device OS configured to a specific network.
Ethernet:
You can setup the device OS to use ethernet by setting the `--network` option to "ethernet".
Wifi:
You can setup the device OS to use wifi by setting the `--network` option to "wifi".
If you set "network" to "wifi", you will need to specify the `--ssid` and `--key` option as well.
Alternatively, you can omit all kind of network configuration options to configure interactively.
You have to specify an output location with the `--output` option.
Examples:
$ resin os download MyApp --output ~/MyResinOS.zip
$ resin os download MyApp --network ethernet --output ~/MyResinOS.zip
$ resin os download MyApp --network wifi --ssid MyNetwork --key secreykey123 --output ~/MyResinOS.zip
$ resin os download MyApp --network ethernet --output ~/MyResinOS.zip
### Options
#### --network, -n <network>
network type
#### --ssid, -s <ssid>
wifi ssid, if network is wifi
#### --key, -k <key>
wifi key, if network is wifi
#### --output, -o <output>
output file
## os install <image> [device]
Use this command to write an operating system image to a device.
Note that this command requires admin privileges.
If `device` is omitted, you will be prompted to select a device interactively.
Notice this command asks for confirmation interactively.
You can avoid this by passing the `--yes` boolean option.
You can quiet the progress bar by passing the `--quiet` boolean option.
Examples:
$ resin os install rpi.iso /dev/disk2
### Options
#### --yes, -y
confirm non interactively
# Plugin # Plugin
## plugins ## plugins

15
extras/capitanodoc/index.coffee
View File

@ -1,4 +1,5 @@
_ = require('lodash') _ = require('lodash')
path = require('path')
capitanodoc = require('../../capitanodoc.json') capitanodoc = require('../../capitanodoc.json')
markdown = require('./markdown') markdown = require('./markdown')
@ -13,10 +14,13 @@ for commandCategory in capitanodoc.categories
category.commands = [] category.commands = []
for file in commandCategory.files for file in commandCategory.files
actions = require(file) actions = require(path.join(process.cwd(), file))
for actionName, actionCommand of actions if actions.signature?
category.commands.push(_.omit(actionCommand, 'action')) category.commands.push(_.omit(actions, 'action'))
else
for actionName, actionCommand of actions
category.commands.push(_.omit(actionCommand, 'action'))
result.categories.push(category) result.categories.push(category)
@ -25,10 +29,7 @@ result.toc = _.map result.toc, (category) ->
category.commands = _.map category.commands, (command) -> category.commands = _.map category.commands, (command) ->
return { return {
signature: command.signature signature: command.signature
anchor: '#' + command.signature
# TODO: Make anchor prefix a configurable setting
# in capitanodoc.json
anchor: '#/pages/using/cli.md#' + command.signature
.replace(/\s/g,'-') .replace(/\s/g,'-')
.replace(/</g, '60-') .replace(/</g, '60-')
.replace(/>/g, '-62-') .replace(/>/g, '-62-')