@bud-tools/btk-cli
v0.0.9
Published
Bud Toolkit CLI
Downloads
21
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ 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
...
Commands
btk create [SUBJECT] [COMMENT]
btk help [COMMANDS]
btk list
btk ls
btk new [SUBJECT] [COMMENT]
btk plugins
btk plugins:install PLUGIN...
btk plugins:inspect PLUGIN...
btk plugins:install PLUGIN...
btk plugins:link PLUGIN
btk plugins:uninstall PLUGIN...
btk plugins:uninstall PLUGIN...
btk plugins:uninstall PLUGIN...
btk plugins update
btk tasks list
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
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
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"