# Brevity CLI

Brevity CLI

<!-- toc -->
* [Brevity CLI](#brevity-cli)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->
```sh-session
$ npm install -g @brevity-builder/cli
$ brevity COMMAND
running command...
$ brevity (--version)
@brevity-builder/cli/1.4.4 darwin-arm64 node-v22.18.0
$ brevity --help [COMMAND]
USAGE
  $ brevity COMMAND
...
```
<!-- usagestop -->

# Commands

<!-- commands -->
* [`brevity auth login`](#brevity-auth-login)
* [`brevity auth logout`](#brevity-auth-logout)
* [`brevity help [COMMAND]`](#brevity-help-command)
* [`brevity plugin publish SEMVER`](#brevity-plugin-publish-semver)
* [`brevity plugins`](#brevity-plugins)
* [`brevity plugins add PLUGIN`](#brevity-plugins-add-plugin)
* [`brevity plugins:inspect PLUGIN...`](#brevity-pluginsinspect-plugin)
* [`brevity plugins install PLUGIN`](#brevity-plugins-install-plugin)
* [`brevity plugins link PATH`](#brevity-plugins-link-path)
* [`brevity plugins remove [PLUGIN]`](#brevity-plugins-remove-plugin)
* [`brevity plugins reset`](#brevity-plugins-reset)
* [`brevity plugins uninstall [PLUGIN]`](#brevity-plugins-uninstall-plugin)
* [`brevity plugins unlink [PLUGIN]`](#brevity-plugins-unlink-plugin)
* [`brevity plugins update`](#brevity-plugins-update)

## `brevity auth login`

Login to Devize

```
USAGE
  $ brevity auth login

DESCRIPTION
  Login to Devize

EXAMPLES
  $ devize login
```

_See code: [src/commands/auth/login.ts](https://github.com/brevitybuilder/cli/blob/v1.4.4/src/commands/auth/login.ts)_

## `brevity auth logout`

Logout out from Devize

```
USAGE
  $ brevity auth logout

DESCRIPTION
  Logout out from Devize

EXAMPLES
  $ devize logout
```

_See code: [src/commands/auth/logout.ts](https://github.com/brevitybuilder/cli/blob/v1.4.4/src/commands/auth/logout.ts)_

## `brevity help [COMMAND]`

Display help for brevity.

```
USAGE
  $ brevity 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 brevity.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.32/src/commands/help.ts)_

## `brevity plugin publish SEMVER`

describe the command here

```
USAGE
  $ brevity plugin publish SEMVER -c <value> [-b]

ARGUMENTS
  SEMVER  (major|minor|patch) semver version to publish

FLAGS
  -b, --buildOnly       only build the plugin
  -c, --config=<value>  (required) config file to use

DESCRIPTION
  describe the command here

EXAMPLES
  $ brevity plugin publish
```

_See code: [src/commands/plugin/publish.ts](https://github.com/brevitybuilder/cli/blob/v1.4.4/src/commands/plugin/publish.ts)_

## `brevity plugins`

List installed plugins.

```
USAGE
  $ brevity plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ brevity plugins
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/index.ts)_

## `brevity plugins add PLUGIN`

Installs a plugin into brevity.

```
USAGE
  $ brevity plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into brevity.

  Uses npm to install plugins.

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

  Use the BREVITY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the BREVITY_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ brevity plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ brevity plugins add myplugin

  Install a plugin from a github url.

    $ brevity plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ brevity plugins add someuser/someplugin
```

## `brevity plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

```
USAGE
  $ brevity 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
  $ brevity plugins inspect myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/inspect.ts)_

## `brevity plugins install PLUGIN`

Installs a plugin into brevity.

```
USAGE
  $ brevity plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into brevity.

  Uses npm to install plugins.

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

  Use the BREVITY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the BREVITY_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ brevity plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ brevity plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ brevity plugins install someuser/someplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/install.ts)_

## `brevity plugins link PATH`

Links a plugin into the CLI for development.

```
USAGE
  $ brevity plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

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
  $ brevity plugins link myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/link.ts)_

## `brevity plugins remove [PLUGIN]`

Removes a plugin from the CLI.

```
USAGE
  $ brevity plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ brevity plugins unlink
  $ brevity plugins remove

EXAMPLES
  $ brevity plugins remove myplugin
```

## `brevity plugins reset`

Remove all user-installed and linked plugins.

```
USAGE
  $ brevity plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/reset.ts)_

## `brevity plugins uninstall [PLUGIN]`

Removes a plugin from the CLI.

```
USAGE
  $ brevity plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ brevity plugins unlink
  $ brevity plugins remove

EXAMPLES
  $ brevity plugins uninstall myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/uninstall.ts)_

## `brevity plugins unlink [PLUGIN]`

Removes a plugin from the CLI.

```
USAGE
  $ brevity plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ brevity plugins unlink
  $ brevity plugins remove

EXAMPLES
  $ brevity plugins unlink myplugin
```

## `brevity plugins update`

Update installed plugins.

```
USAGE
  $ brevity plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/update.ts)_
<!-- commandsstop -->