An open API service indexing awesome lists of open source software.

https://github.com/kodie/bitbar-cli

A command line tool for managing your BitBar plugins.
https://github.com/kodie/bitbar-cli

bitbar cli command-line command-line-tool javascript macos nodejs plugins

Last synced: 11 months ago
JSON representation

A command line tool for managing your BitBar plugins.

Awesome Lists containing this project

README

          

# bitbar-cli [![npm version](https://badge.fury.io/js/bitbar-cli.svg)](https://badge.fury.io/js/bitbar-cli)
A command line tool for managing your [BitBar](https://github.com/matryer/bitbar) plugins.

## Installation
```
$ npm i -g bitbar-cli
```

## Help
```
$ bitbar --help

Usage: bitbar [options] [command]

Commands:

install|i Install plugins
uninstall|u Uninstall plugins
list|l List all currently installed plugins
meta|m Display plugin meta info
refresh|r [plugin] Refresh a plugin
search|s [plugin] Search the online database for a plugin

Options:

-h, --help output usage information
-V, --version output the version number
```

## Plugin Dependencies
When using the `install` command, the CLI tool will search the plugin's `bitbar.dependencies` and `bitbar.dependencies.npm` meta fields for dependencies that start with `npm/` or `npm-g/` and install them via npm.

For example, a plugin containing the follow meta field:
```
node, npm, npm-g/jq, npm/https://github.com/y-a-v-a/easy-gd.git, npm/fs, npm/home-config, npm/node-time-ago, npm/request, npm/sync-request
```

Results in the CLI tool running this command during installation:
```
$ cd '${pluginsPath}' && npm install https://github.com/y-a-v-a/easy-gd.git fs home-config node-time-ago request sync-request && npm install -g jq
```

As you can see, any dependencies that start with `npm/` will be installed to the BitBar plugins directory, and dependencies that start with `npm-g/` will be installed on the system globally.

## License
MIT. See the License file for more info.