Merge pull request #1294 from balena-io/docs-scan

Add 'scan' command to the website reference documentation
This commit is contained in:
Paulo Castro 2019-06-06 10:43:16 +01:00 committed by GitHub
commit eba193278e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 4 deletions

View File

@ -74,8 +74,12 @@ const capitanoDoc = {
files: ['build/actions/logs.js'],
},
{
title: 'SSH',
files: ['build/actions/ssh.js', 'build/actions/tunnel.js'],
title: 'Network',
files: [
'build/actions/scan.js',
'build/actions/ssh.js',
'build/actions/tunnel.js',
],
},
{
title: 'Notes',

View File

@ -137,8 +137,9 @@ If you come across any problems or would like to get in touch:
- [logs <uuidOrDevice>](#logs-uuidordevice)
- SSH
- Network
- [scan](#scan)
- [ssh <applicationOrDevice> [serviceName]](#ssh-applicationordevice-servicename)
- [tunnel <uuid>](#tunnel-uuid)
@ -870,7 +871,26 @@ This can be used in combination with --system or other --service flags.
Only show system logs. This can be used in combination with --service.
# SSH
# Network
## scan
Examples:
$ balena scan
$ balena scan --timeout 120
$ balena scan --verbose
### Options
#### --verbose, -v
Display full info
#### --timeout, -t <timeout>
Scan timeout in seconds
## ssh <applicationOrDevice> [serviceName]