# uberboard-cli

> CLI application for creating and managing uberboard.io dashboards

Latest version **1.0.1-beta** (published 2023-03-11) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install uberboard-cli
pnpm add uberboard-cli
yarn add uberboard-cli
bun add uberboard-cli
```

Provides the command `uberboard`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.1-beta |
| Published | 2023-03-11 |
| First published | 2023-03-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 18 |
| Unpacked size | 39.9 KB |
| Known vulnerabilities | 0 (+4 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | uberboard.io |
| Maintainers | lukian |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/uberboard-cli
- Repository: https://github.com/uberboard/uberboard-cli
- Homepage: https://github.com/uberboard.io/uberboard-cli
- Issues: https://github.com/uberboard.io/uberboard-cli/issues
- npm.io page: https://npm.io/package/uberboard-cli

## Dependencies (18)

- [arch](https://npm.io/package/arch.md) ^2.2.0
- [keyv](https://npm.io/package/keyv.md) ^4.5.2
- [axios](https://npm.io/package/axios.md) ^1.3.2
- [octokit](https://npm.io/package/octokit.md) ^2.0.14
- [unzipper](https://npm.io/package/unzipper.md) ^0.10.11
- [decompress](https://npm.io/package/decompress.md) ^4.2.1
- [handlebars](https://npm.io/package/handlebars.md) ^4.7.7
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^2
- [gunzip-file](https://npm.io/package/gunzip-file.md) ^0.1.1
- [decompress-gz](https://npm.io/package/decompress-gz.md) ^0.0.1
- [decompress-tar](https://npm.io/package/decompress-tar.md) ^4.1.1
- [decompress-targz](https://npm.io/package/decompress-targz.md) ^4.1.1
- [decompress-unzip](https://npm.io/package/decompress-unzip.md) ^4.0.1
- [decompress-tarbz2](https://npm.io/package/decompress-tarbz2.md) ^4.1.1
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^5
- [@oclif/plugin-update](https://npm.io/package/@oclif/plugin-update.md) ^3.1.6
- [@oclif/plugin-plugins](https://npm.io/package/@oclif/plugin-plugins.md) ^2.3.0
- [github-download-directory](https://npm.io/package/github-download-directory.md) ^3.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.1-beta (latest) — 2023-03-11

## README

uberboard.io CLI
=================

uberboard.io CLI

![GitHub branch checks state](https://img.shields.io/github/checks-status/uberboard/uberboard-cli/main)
![GitHub package.json version](https://img.shields.io/github/package-json/v/uberboard/uberboard-cli)
![GitHub](https://img.shields.io/github/license/uberboard/uberboard-cli)


<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ 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
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`uberboard dashboard create [NAME]`](#uberboard-dashboard-create-name)
* [`uberboard dashboard start`](#uberboard-dashboard-start)
* [`uberboard dashboard stop`](#uberboard-dashboard-stop)
* [`uberboard dashboard upgrade [DASHBOARDDIR]`](#uberboard-dashboard-upgrade-dashboarddir)
* [`uberboard help [COMMANDS]`](#uberboard-help-commands)
* [`uberboard plugins`](#uberboard-plugins)
* [`uberboard plugins:install PLUGIN...`](#uberboard-pluginsinstall-plugin)
* [`uberboard plugins:inspect PLUGIN...`](#uberboard-pluginsinspect-plugin)
* [`uberboard plugins:install PLUGIN...`](#uberboard-pluginsinstall-plugin-1)
* [`uberboard plugins:link PLUGIN`](#uberboard-pluginslink-plugin)
* [`uberboard plugins:uninstall PLUGIN...`](#uberboard-pluginsuninstall-plugin)
* [`uberboard plugins:uninstall PLUGIN...`](#uberboard-pluginsuninstall-plugin-1)
* [`uberboard plugins:uninstall PLUGIN...`](#uberboard-pluginsuninstall-plugin-2)
* [`uberboard plugins update`](#uberboard-plugins-update)
* [`uberboard shippers`](#uberboard-shippers)
* [`uberboard shippers add`](#uberboard-shippers-add)
* [`uberboard shippers create NAME`](#uberboard-shippers-create-name)
* [`uberboard shippers ls`](#uberboard-shippers-ls)
* [`uberboard update [CHANNEL]`](#uberboard-update-channel)
* [`uberboard views`](#uberboard-views)
* [`uberboard views add`](#uberboard-views-add)
* [`uberboard views create NAME`](#uberboard-views-create-name)
* [`uberboard views ls`](#uberboard-views-ls)

## `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](https://github.com/oclif/plugin-help/blob/v5.2.7/src/commands/help.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v2.3.2/src/commands/plugins/index.ts)_

## `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](https://github.com/uberboard/uberboard-cli/blob/v1.0.1-beta/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](https://github.com/oclif/plugin-update/blob/v3.1.6/src/commands/update.ts)_

## `uberboard views`

Manage uberboard views

```
USAGE
  $ uberboard views

DESCRIPTION
  Manage uberboard views
```

_See code: [dist/commands/views/index.ts](https://github.com/uberboard/uberboard-cli/blob/v1.0.1-beta/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
```
<!-- commandsstop -->

---
_Source: https://npm.io/package/uberboard-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._