npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@brevity-builder/cli

v1.2.185

Published

CLI to work with Brevity Plugins

Downloads

64

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

nicksrandallnicksrandallryleyrandall22ryleyrandall22

Keywords

oclif

Readme

Brevity CLI

Brevity CLI

Usage

$ npm install -g @brevity-builder/cli
$ brevity COMMAND
running command...
$ brevity (--version)
@brevity-builder/cli/1.2.185 darwin-arm64 node-v22.9.0
$ brevity --help [COMMAND]
USAGE
  $ brevity COMMAND
...

Commands

brevity auth login

Login to Brevity

USAGE
  $ brevity auth login

DESCRIPTION
  Login to Brevity

EXAMPLES
  $ brevity login

See code: src/commands/auth/login.ts

brevity auth logout

Logout out from Brevity

USAGE
  $ brevity auth logout

DESCRIPTION
  Logout out from Brevity

EXAMPLES
  $ brevity logout

See code: 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

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

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

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

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

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

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

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

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