ota-cli v0.1.0-pre

ota-cli

Uploads firmware over the air to devices like Arduino, ESP8266, ESP32, etc.

Authentication supported.

Summary

• ota-cli
• Summary
• Usage
• Commands

Usage

$ npm install -g ota-cli
$ ota COMMAND
running command...
$ ota (--version)
ota-cli/0.1.0-pre win32-x64 node-v16.13.2
$ ota --help [COMMAND]
USAGE
  $ ota COMMAND
...

Commands

• ota help [COMMAND]
• ota plugins
• ota plugins:inspect PLUGIN...
• ota plugins:install PLUGIN...
• ota plugins:link PLUGIN
• ota plugins:uninstall PLUGIN...
• ota plugins:update
• ota upload

ota help [COMMAND]

Display help for ota.

USAGE
  $ ota help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for ota.

See code: @oclif/plugin-help

ota plugins

List installed plugins.

USAGE
  $ ota plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ ota plugins

See code: @oclif/plugin-plugins

ota plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ ota plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ ota plugins:inspect myplugin

See code: @oclif/plugin-plugins

ota plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ ota plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ ota plugins:add

EXAMPLES
  $ ota plugins:install myplugin 

  $ ota plugins:install https://github.com/someuser/someplugin

  $ ota plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

ota plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ ota plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLES
  $ ota plugins:link myplugin

See code: @oclif/plugin-plugins

ota plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ ota plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ota plugins:unlink
  $ ota plugins:remove

See code: @oclif/plugin-plugins

ota plugins:update

Update installed plugins.

USAGE
  $ ota plugins:update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

ota upload

Upload a firmware to a device

USAGE
  $ ota upload -f <value> -i <value> [--debug <value>] [--deviceIp <value>] [--devicePass <value>]
    [--dnsServiceName <value>] [--dnsServiceType <value>]

FLAGS
  -f, --file=path/to/firmware.bin  (required) Path to the firmware binary file
  -i, --interfaceIp=<value>        (required) Provide IP of your default local network interface
  --debug=<value>
  --deviceIp=path/to/firmware.bin  (WIP) Skip the scanning step by providing the device IP address directly
  --devicePass=<value>             Skip the authentication step by providing the password directly
  --dnsServiceName=<value>         [default: _arduino._tcp.local] Provide the name of the DNS service to lookup
  --dnsServiceType=<value>         [default: PTR] Provide the type of the DNS service to lookup

DESCRIPTION
  Upload a firmware to a device

See code: dist/commands/upload/index.ts