mirror of
https://github.com/balena-io/balena-cli.git
synced 2025-06-01 07:20:42 +00:00
Regenerate docs and include sync
This commit is contained in:
parent
469d35fcc1
commit
20969ef249
@ -50,6 +50,12 @@
|
|||||||
"lib/actions/logs.coffee"
|
"lib/actions/logs.coffee"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"title": "Sync",
|
||||||
|
"files": [
|
||||||
|
"lib/actions/sync.coffee"
|
||||||
|
]
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"title": "Notes",
|
"title": "Notes",
|
||||||
"files": [
|
"files": [
|
||||||
|
@ -67,6 +67,10 @@ Now you have access to all the commands referenced below.
|
|||||||
|
|
||||||
- [logs <uuid>](#logs-60-uuid-62-)
|
- [logs <uuid>](#logs-60-uuid-62-)
|
||||||
|
|
||||||
|
- Sync
|
||||||
|
|
||||||
|
- [sync <uuid>](#sync-60-uuid-62-)
|
||||||
|
|
||||||
- Notes
|
- Notes
|
||||||
|
|
||||||
- [note <|note>](#note-60-note-62-)
|
- [note <|note>](#note-60-note-62-)
|
||||||
@ -83,7 +87,7 @@ Now you have access to all the commands referenced below.
|
|||||||
- [config write <key> <value>](#config-write-60-key-62-60-value-62-)
|
- [config write <key> <value>](#config-write-60-key-62-60-value-62-)
|
||||||
- [config inject <file>](#config-inject-60-file-62-)
|
- [config inject <file>](#config-inject-60-file-62-)
|
||||||
- [config reconfigure](#config-reconfigure)
|
- [config reconfigure](#config-reconfigure)
|
||||||
- [config generate <uuid>](#config-generate-60-uuid-62-)
|
- [config generate](#config-generate)
|
||||||
|
|
||||||
- Settings
|
- Settings
|
||||||
|
|
||||||
@ -572,6 +576,58 @@ Examples:
|
|||||||
|
|
||||||
continuously stream output
|
continuously stream output
|
||||||
|
|
||||||
|
# Sync
|
||||||
|
|
||||||
|
## sync <uuid>
|
||||||
|
|
||||||
|
Use this command to sync your local changes to a certain device on the fly.
|
||||||
|
|
||||||
|
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'
|
||||||
|
exec: 'python main.py'
|
||||||
|
ignore:
|
||||||
|
- .git
|
||||||
|
- node_modules/
|
||||||
|
progress: true
|
||||||
|
|
||||||
|
Notice that explicitly passed command options override the ones set in the configuration file.
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
|
||||||
|
$ 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
|
||||||
|
|
||||||
|
#### --exec, -x <command>
|
||||||
|
|
||||||
|
execute a command after syncing (on the device)
|
||||||
|
|
||||||
|
#### --progress, -p
|
||||||
|
|
||||||
|
show progress
|
||||||
|
|
||||||
|
#### --port, -t <port>
|
||||||
|
|
||||||
|
ssh port
|
||||||
|
|
||||||
# Notes
|
# Notes
|
||||||
|
|
||||||
## note <|note>
|
## note <|note>
|
||||||
@ -729,17 +785,27 @@ drive
|
|||||||
|
|
||||||
show advanced commands
|
show advanced commands
|
||||||
|
|
||||||
## config generate <uuid>
|
## config generate
|
||||||
|
|
||||||
Use this command to generate a config.json for a device
|
Use this command to generate a config.json for a device or application
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
$ resin config generate 7cf02a6
|
$ resin config generate --device 7cf02a6
|
||||||
$ resin config generate 7cf02a6 --output config.json
|
$ resin config generate --device 7cf02a6 --output config.json
|
||||||
|
$ resin config generate --app MyApp
|
||||||
|
$ resin config generate --app MyApp --output config.json
|
||||||
|
|
||||||
### Options
|
### Options
|
||||||
|
|
||||||
|
#### --application, --a,app, --a,app <application>
|
||||||
|
|
||||||
|
application name
|
||||||
|
|
||||||
|
#### --device, -d <device>
|
||||||
|
|
||||||
|
device uuid
|
||||||
|
|
||||||
#### --output, -o <output>
|
#### --output, -o <output>
|
||||||
|
|
||||||
output
|
output
|
||||||
|
Loading…
x
Reference in New Issue
Block a user