@ksidharth8/tasks-cli
v1.0.0
Published
A Tasks CLI Tool
Readme
@ksidharth8/tasks-cli
A Salesforce Tasks CLI Tool
Usage
$ npm install -g @ksidharth8/tasks-cli
$ tasks COMMAND
running command...
$ tasks (--version)
@ksidharth8/tasks-cli/1.0.0 darwin-arm64 node-v22.13.1
$ tasks --help [COMMAND]
USAGE
$ tasks COMMAND
...Commands
tasks help [COMMAND]tasks pluginstasks plugins add PLUGINtasks plugins:inspect PLUGIN...tasks plugins install PLUGINtasks plugins link PATHtasks plugins remove [PLUGIN]tasks plugins resettasks plugins uninstall [PLUGIN]tasks plugins unlink [PLUGIN]tasks plugins updatetasks tasks listtasks tasks new [SUBJECT] [COMMENT]tasks tasks sync
tasks help [COMMAND]
Display help for tasks.
USAGE
$ tasks 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 tasks.See code: @oclif/plugin-help
tasks plugins
List installed plugins.
USAGE
$ tasks plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ tasks pluginsSee code: @oclif/plugin-plugins
tasks plugins add PLUGIN
Installs a plugin into tasks.
USAGE
$ tasks 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 tasks.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the TASKS_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the TASKS_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ tasks plugins add
EXAMPLES
Install a plugin from npm registry.
$ tasks plugins add myplugin
Install a plugin from a github url.
$ tasks plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ tasks plugins add someuser/someplugintasks plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ tasks 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
$ tasks plugins inspect mypluginSee code: @oclif/plugin-plugins
tasks plugins install PLUGIN
Installs a plugin into tasks.
USAGE
$ tasks 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 tasks.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the TASKS_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the TASKS_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ tasks plugins add
EXAMPLES
Install a plugin from npm registry.
$ tasks plugins install myplugin
Install a plugin from a github url.
$ tasks plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ tasks plugins install someuser/somepluginSee code: @oclif/plugin-plugins
tasks plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ tasks 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
$ tasks plugins link mypluginSee code: @oclif/plugin-plugins
tasks plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ tasks 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
$ tasks plugins unlink
$ tasks plugins remove
EXAMPLES
$ tasks plugins remove myplugintasks plugins reset
Remove all user-installed and linked plugins.
USAGE
$ tasks 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
tasks plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ tasks 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
$ tasks plugins unlink
$ tasks plugins remove
EXAMPLES
$ tasks plugins uninstall mypluginSee code: @oclif/plugin-plugins
tasks plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ tasks 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
$ tasks plugins unlink
$ tasks plugins remove
EXAMPLES
$ tasks plugins unlink myplugintasks plugins update
Update installed plugins.
USAGE
$ tasks plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
tasks tasks list
List all tasks
USAGE
$ tasks tasks list [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List all tasks
EXAMPLES
$ tasks tasks listSee code: src/commands/tasks/list.ts
tasks tasks new [SUBJECT] [COMMENT]
Creates a new Task
USAGE
$ tasks tasks new [SUBJECT] [COMMENT] [-p <value>] [-s <value>]
ARGUMENTS
[SUBJECT] (Call|Email|Send Letter|Send Quote|Other) subject of the task
[COMMENT] comment for the task
FLAGS
-p, --priority=<value> [default: Normal] Priority of the task
-s, --status=<value> [default: Not Started] Status of the task
DESCRIPTION
Creates a new Task
EXAMPLES
$ tasks tasks new "Email" --priority "Normal" --status "Not Started"
$ tasks tasks new "Call" "This is a comment" --p "Urgent" -s "Completed"See code: src/commands/tasks/new.ts
tasks tasks sync
Sync tasks to GitHub README
USAGE
$ tasks tasks sync
DESCRIPTION
Sync tasks to GitHub READMESee code: src/commands/tasks/sync.ts
