mirror of
https://github.com/balena-io/balena-cli.git
synced 2025-01-02 03:56:39 +00:00
Regenerate documentation
This commit is contained in:
parent
f0346b1fd0
commit
0cc1765a1e
@ -26,7 +26,7 @@
|
|||||||
exports.download = {
|
exports.download = {
|
||||||
signature: 'os download <id>',
|
signature: 'os download <id>',
|
||||||
description: 'download device OS',
|
description: 'download device OS',
|
||||||
help: 'Use this command to download the device OS configured to a specific network.\n\nEthernet:\n You can setup the device OS to use ethernet by setting the `--network` option to "ethernet".\n\nWifi:\n You can setup the device OS to use wifi by setting the `--network` option to "wifi".\n If you set "network" to "wifi", you will need to specify the `--ssid` and `--key` option as well.\n\nBy default, this command saved the downloaded image into a resin specific directory.\nYou can save it to a custom location by specifying the `--output` option.\n\nExamples:\n\n $ resin os download 91 --network ethernet\n $ resin os download 91 --network wifi --ssid MyNetwork --key secreykey123\n $ resin os download 91 --network ethernet --output ~/MyResinOS.zip',
|
help: 'Use this command to download the device OS configured to a specific network.\n\nEthernet:\n You can setup the device OS to use ethernet by setting the `--network` option to "ethernet".\n\nWifi:\n You can setup the device OS to use wifi by setting the `--network` option to "wifi".\n If you set "network" to "wifi", you will need to specify the `--ssid` and `--key` option as well.\n\nAlternatively, you can omit all kind of network configuration options to configure interactively.\n\nYou have to specify an output location with the `--output` option.\n\nExamples:\n\n $ resin os download 91 --output ~/MyResinOS.zip\n $ resin os download 91 --network ethernet --output ~/MyResinOS.zip\n $ resin os download 91 --network wifi --ssid MyNetwork --key secreykey123 --output ~/MyResinOS.zip\n $ resin os download 91 --network ethernet --output ~/MyResinOS.zip',
|
||||||
options: [
|
options: [
|
||||||
commandOptions.network, commandOptions.wifiSsid, commandOptions.wifiKey, {
|
commandOptions.network, commandOptions.wifiSsid, commandOptions.wifiKey, {
|
||||||
signature: 'output',
|
signature: 'output',
|
||||||
|
10
doc/app/associate.md
Normal file
10
doc/app/associate.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
# app associate <id>
|
||||||
|
|
||||||
|
Use this command to associate a project directory with a resin application.
|
||||||
|
|
||||||
|
This command adds a 'resin' git remote to the directory and runs git init if necessary.
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
|
||||||
|
$ resin app associate 91
|
||||||
|
$ resin app associate 91 --project my/app/directory
|
@ -1,10 +1,13 @@
|
|||||||
# init <id>
|
# init
|
||||||
|
|
||||||
Use this command to associate a local project to an existing resin.io application.
|
Use this command to initialise a directory as a resin application.
|
||||||
|
|
||||||
The application should be a git repository before issuing this command.
|
This command performs the following steps:
|
||||||
Notice this command adds a `resin` git remote to your application.
|
- Create a resin.io application.
|
||||||
|
- Initialize the current directory as a git repository.
|
||||||
|
- Add the corresponding git remote to the application.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
$ cd myApp && resin init 91
|
$ resin init
|
||||||
|
$ resin init --project my/app/directory
|
||||||
|
@ -9,13 +9,15 @@ Wifi:
|
|||||||
You can setup the device OS to use wifi by setting the `--network` option to "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.
|
If you set "network" to "wifi", you will need to specify the `--ssid` and `--key` option as well.
|
||||||
|
|
||||||
By default, this command saved the downloaded image into a resin specific directory.
|
Alternatively, you can omit all kind of network configuration options to configure interactively.
|
||||||
You can save it to a custom location by specifying the `--output` option.
|
|
||||||
|
You have to specify an output location with the `--output` option.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
$ resin os download 91 --network ethernet
|
$ resin os download 91 --output ~/MyResinOS.zip
|
||||||
$ resin os download 91 --network wifi --ssid MyNetwork --key secreykey123
|
$ resin os download 91 --network ethernet --output ~/MyResinOS.zip
|
||||||
|
$ resin os download 91 --network wifi --ssid MyNetwork --key secreykey123 --output ~/MyResinOS.zip
|
||||||
$ resin os download 91 --network ethernet --output ~/MyResinOS.zip
|
$ resin os download 91 --network ethernet --output ~/MyResinOS.zip
|
||||||
|
|
||||||
## Options
|
## Options
|
||||||
|
@ -23,13 +23,15 @@ exports.download =
|
|||||||
You can setup the device OS to use wifi by setting the `--network` option to "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.
|
If you set "network" to "wifi", you will need to specify the `--ssid` and `--key` option as well.
|
||||||
|
|
||||||
By default, this command saved the downloaded image into a resin specific directory.
|
Alternatively, you can omit all kind of network configuration options to configure interactively.
|
||||||
You can save it to a custom location by specifying the `--output` option.
|
|
||||||
|
You have to specify an output location with the `--output` option.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
$ resin os download 91 --network ethernet
|
$ resin os download 91 --output ~/MyResinOS.zip
|
||||||
$ resin os download 91 --network wifi --ssid MyNetwork --key secreykey123
|
$ resin os download 91 --network ethernet --output ~/MyResinOS.zip
|
||||||
|
$ resin os download 91 --network wifi --ssid MyNetwork --key secreykey123 --output ~/MyResinOS.zip
|
||||||
$ resin os download 91 --network ethernet --output ~/MyResinOS.zip
|
$ resin os download 91 --network ethernet --output ~/MyResinOS.zip
|
||||||
'''
|
'''
|
||||||
options: [
|
options: [
|
||||||
|
Loading…
Reference in New Issue
Block a user