1.0.1-beta • Published 1 year ago

uberboard-cli v1.0.1-beta

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

uberboard.io CLI

uberboard.io CLI

GitHub branch checks state GitHub package.json version GitHub

Usage

$ npm install -g uberboard-cli
$ uberboard COMMAND
running command...
$ uberboard (--version)
uberboard-cli/1.0.1-beta darwin-arm64 node-v19.6.0
$ uberboard --help [COMMAND]
USAGE
  $ uberboard COMMAND
...

Commands

uberboard dashboard create [NAME]

Create a new dashboard

USAGE
  $ uberboard dashboard create [NAME]

ARGUMENTS
  NAME  Name of the dashboard folder to create

DESCRIPTION
  Create a new dashboard

uberboard dashboard start

Start dashboard in the current directory

USAGE
  $ uberboard dashboard start [-d]

FLAGS
  -d, --daemon  If provided, the dashboard will be running in background

DESCRIPTION
  Start dashboard in the current directory

uberboard dashboard stop

describe the command here

USAGE
  $ uberboard dashboard stop

DESCRIPTION
  describe the command here

EXAMPLES
  $ uberboard dashboard stop

uberboard dashboard upgrade [DASHBOARDDIR]

Upgrade dashboard version

USAGE
  $ uberboard dashboard upgrade [DASHBOARDDIR]

ARGUMENTS
  DASHBOARDDIR  Name of the dashboard folder to upgrade

DESCRIPTION
  Upgrade dashboard version

uberboard help [COMMANDS]

Display help for uberboard.

USAGE
  $ uberboard help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

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

DESCRIPTION
  Display help for uberboard.

See code: @oclif/plugin-help

uberboard plugins

List installed plugins.

USAGE
  $ uberboard plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ uberboard plugins

See code: @oclif/plugin-plugins

uberboard plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ uberboard 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
  $ uberboard plugins add

EXAMPLES
  $ uberboard plugins:install myplugin 

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

  $ uberboard plugins:install someuser/someplugin

uberboard plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ uberboard plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

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

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ uberboard plugins:inspect myplugin

uberboard plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ uberboard 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
  $ uberboard plugins add

EXAMPLES
  $ uberboard plugins:install myplugin 

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

  $ uberboard plugins:install someuser/someplugin

uberboard plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ uberboard 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
  $ uberboard plugins:link myplugin

uberboard plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ uberboard plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ uberboard plugins unlink
  $ uberboard plugins remove

uberboard plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ uberboard plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ uberboard plugins unlink
  $ uberboard plugins remove

uberboard plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ uberboard plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ uberboard plugins unlink
  $ uberboard plugins remove

uberboard plugins update

Update installed plugins.

USAGE
  $ uberboard plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

uberboard shippers

Manage uberboard shippers

USAGE
  $ uberboard shippers

DESCRIPTION
  Manage uberboard shippers

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

uberboard shippers add

Install shipper

USAGE
  $ uberboard shippers add

DESCRIPTION
  Install shipper

uberboard shippers create NAME

Generate a new shipper

USAGE
  $ uberboard shippers create NAME

ARGUMENTS
  NAME  Name of the shipper to create

DESCRIPTION
  Generate a new shipper

uberboard shippers ls

List remotely available shippers

USAGE
  $ uberboard shippers ls

DESCRIPTION
  List remotely available shippers

uberboard update [CHANNEL]

update the uberboard CLI

USAGE
  $ uberboard update [CHANNEL] [-a] [-v <value> | -i] [--force]

FLAGS
  -a, --available        Install a specific version.
  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
  -v, --version=<value>  Install a specific version.
  --force                Force a re-download of the requested version.

DESCRIPTION
  update the uberboard CLI

EXAMPLES
  Update to the stable channel:

    $ uberboard update stable

  Update to a specific version:

    $ uberboard update --version 1.0.0

  Interactively select version:

    $ uberboard update --interactive

  See available versions:

    $ uberboard update --available

See code: @oclif/plugin-update

uberboard views

Manage uberboard views

USAGE
  $ uberboard views

DESCRIPTION
  Manage uberboard views

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

uberboard views add

Install view

USAGE
  $ uberboard views add

DESCRIPTION
  Install view

uberboard views create NAME

Generate a new view

USAGE
  $ uberboard views create NAME

ARGUMENTS
  NAME  Name of the view to create

DESCRIPTION
  Generate a new view

uberboard views ls

List remotely available views

USAGE
  $ uberboard views ls

DESCRIPTION
  List remotely available views