# @bud-tools/btk-cli

> Bud Toolkit CLI

Latest version **0.0.9** (published 2023-02-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @bud-tools/btk-cli
pnpm add @bud-tools/btk-cli
yarn add @bud-tools/btk-cli
bun add @bud-tools/btk-cli
```

Provides the command `btk`.

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.9 |
| Published | 2023-02-21 |
| First published | 2023-02-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=14.16 |
| Dependencies | 5 |
| Unpacked size | 31.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | andyrow37 |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/@bud-tools/btk-cli
- npm.io page: https://npm.io/package/@bud-tools/btk-cli

## Dependencies (5)

- [inquirer](https://npm.io/package/inquirer.md) ^9.1.4
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^2
- [better-sqlite3](https://npm.io/package/better-sqlite3.md) ^8.1.0
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^5
- [@oclif/plugin-plugins](https://npm.io/package/@oclif/plugin-plugins.md) ^2.3.2

## 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

- 0.0.9 (latest) — 2023-02-21
- 0.0.8 — 2023-02-21
- 0.0.7 — 2023-02-21
- 0.0.6 — 2023-02-21
- 0.0.5 — 2023-02-21
- 0.0.4 — 2023-02-21
- 0.0.3 — 2023-02-21
- 0.0.2 — 2023-02-21

## README

oclif-hello-world
=================

oclif example Hello World CLI

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)
[![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main)
[![Downloads/week](https://img.shields.io/npm/dw/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)
[![License](https://img.shields.io/npm/l/oclif-hello-world.svg)](https://github.com/oclif/hello-world/blob/main/package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @bud-tools/btk-cli
$ btk COMMAND
running command...
$ btk (--version)
@bud-tools/btk-cli/0.0.9 darwin-x64 node-v16.18.1
$ btk --help [COMMAND]
USAGE
  $ btk COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`btk create [SUBJECT] [COMMENT]`](#btk-create-subject-comment)
* [`btk help [COMMANDS]`](#btk-help-commands)
* [`btk list`](#btk-list)
* [`btk ls`](#btk-ls)
* [`btk new [SUBJECT] [COMMENT]`](#btk-new-subject-comment)
* [`btk plugins`](#btk-plugins)
* [`btk plugins:install PLUGIN...`](#btk-pluginsinstall-plugin)
* [`btk plugins:inspect PLUGIN...`](#btk-pluginsinspect-plugin)
* [`btk plugins:install PLUGIN...`](#btk-pluginsinstall-plugin-1)
* [`btk plugins:link PLUGIN`](#btk-pluginslink-plugin)
* [`btk plugins:uninstall PLUGIN...`](#btk-pluginsuninstall-plugin)
* [`btk plugins:uninstall PLUGIN...`](#btk-pluginsuninstall-plugin-1)
* [`btk plugins:uninstall PLUGIN...`](#btk-pluginsuninstall-plugin-2)
* [`btk plugins update`](#btk-plugins-update)
* [`btk tasks list`](#btk-tasks-list)
* [`btk tasks new [SUBJECT] [COMMENT]`](#btk-tasks-new-subject-comment)

## `btk create [SUBJECT] [COMMENT]`

Create a new Salesforce Task

```
USAGE
  $ btk create [SUBJECT] [COMMENT] [-p <value>] [-s <value>]

FLAGS
  -p, --priority=<value>  [default: Normal] Priority of the task
  -s, --status=<value>    [default: Not Started] Status of the task

DESCRIPTION
  Create a new Salesforce Task

ALIASES
  $ btk new
  $ btk create

EXAMPLES
  $ btk create "Email" --priority "Normal" --status "Not Started"

  $ btk create "Call" "This is a comment" -p "Urgent" -s "Not Started"
```

## `btk help [COMMANDS]`

Display help for btk.

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

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

## `btk list`

List all tasks

```
USAGE
  $ btk list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  |
    [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -x, --extended     show extra columns
  --columns=<value>  only show provided columns (comma-separated)
  --csv              output is csv format [alias: --output=csv]
  --filter=<value>   filter property by partial string matching, ex: name=foo
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen
  --output=<option>  output in a more machine friendly format
                     <options: csv|json|yaml>
  --sort=<value>     property to sort by (prepend '-' for descending)

DESCRIPTION
  List all tasks

ALIASES
  $ btk list
  $ btk ls

EXAMPLES
  $ btk list --filter priority=Urgent
```

## `btk ls`

List all tasks

```
USAGE
  $ btk ls [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  |
    [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -x, --extended     show extra columns
  --columns=<value>  only show provided columns (comma-separated)
  --csv              output is csv format [alias: --output=csv]
  --filter=<value>   filter property by partial string matching, ex: name=foo
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen
  --output=<option>  output in a more machine friendly format
                     <options: csv|json|yaml>
  --sort=<value>     property to sort by (prepend '-' for descending)

DESCRIPTION
  List all tasks

ALIASES
  $ btk list
  $ btk ls

EXAMPLES
  $ btk ls --filter priority=Urgent
```

## `btk new [SUBJECT] [COMMENT]`

Create a new Salesforce Task

```
USAGE
  $ btk new [SUBJECT] [COMMENT] [-p <value>] [-s <value>]

FLAGS
  -p, --priority=<value>  [default: Normal] Priority of the task
  -s, --status=<value>    [default: Not Started] Status of the task

DESCRIPTION
  Create a new Salesforce Task

ALIASES
  $ btk new
  $ btk create

EXAMPLES
  $ btk new "Email" --priority "Normal" --status "Not Started"

  $ btk new "Call" "This is a comment" -p "Urgent" -s "Not Started"
```

## `btk plugins`

List installed plugins.

```
USAGE
  $ btk plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ btk plugins
```

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

## `btk plugins:install PLUGIN...`

Installs a plugin into the CLI.

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

EXAMPLES
  $ btk plugins:install myplugin 

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

  $ btk plugins:install someuser/someplugin
```

## `btk plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

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

## `btk plugins:install PLUGIN...`

Installs a plugin into the CLI.

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

EXAMPLES
  $ btk plugins:install myplugin 

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

  $ btk plugins:install someuser/someplugin
```

## `btk plugins:link PLUGIN`

Links a plugin into the CLI for development.

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

## `btk plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ btk plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ btk plugins unlink
  $ btk plugins remove
```

## `btk plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ btk plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ btk plugins unlink
  $ btk plugins remove
```

## `btk plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ btk plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ btk plugins unlink
  $ btk plugins remove
```

## `btk plugins update`

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.
```

## `btk tasks list`

List all tasks

```
USAGE
  $ btk tasks list [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  |
    [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -x, --extended     show extra columns
  --columns=<value>  only show provided columns (comma-separated)
  --csv              output is csv format [alias: --output=csv]
  --filter=<value>   filter property by partial string matching, ex: name=foo
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen
  --output=<option>  output in a more machine friendly format
                     <options: csv|json|yaml>
  --sort=<value>     property to sort by (prepend '-' for descending)

DESCRIPTION
  List all tasks

ALIASES
  $ btk list
  $ btk ls

EXAMPLES
  $ btk tasks list --filter priority=Urgent
```

## `btk tasks new [SUBJECT] [COMMENT]`

Create a new Salesforce Task

```
USAGE
  $ btk tasks new [SUBJECT] [COMMENT] [-p <value>] [-s <value>]

FLAGS
  -p, --priority=<value>  [default: Normal] Priority of the task
  -s, --status=<value>    [default: Not Started] Status of the task

DESCRIPTION
  Create a new Salesforce Task

ALIASES
  $ btk new
  $ btk create

EXAMPLES
  $ btk tasks new "Email" --priority "Normal" --status "Not Started"

  $ btk tasks new "Call" "This is a comment" -p "Urgent" -s "Not Started"
```
<!-- commandsstop -->

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