@tinyblondman/ubivalent v1.0.0

oclif-hello-world

oclif example Hello World CLI

• oclif-hello-world
• Usage
• Commands

Usage

$ npm install -g @tinyblondman/ubivalent
$ ubi COMMAND
running command...
$ ubi (--version)
@tinyblondman/ubivalent/1.0.0 linux-x64 node-v18.0.0
$ ubi --help [COMMAND]
USAGE
  $ ubi COMMAND
...

Commands

• ubi help [COMMANDS]
• ubi idea add [IDEA] [SUMMARY]
• ubi idea delete IDEA
• ubi idea list
• ubi idea ls
• ubi idea prune
• ubi idea update IDEA
• ubi plugins
• ubi plugins:install PLUGIN...
• ubi plugins:inspect PLUGIN...
• ubi plugins:install PLUGIN...
• ubi plugins:link PLUGIN
• ubi plugins:uninstall PLUGIN...
• ubi plugins:uninstall PLUGIN...
• ubi plugins:uninstall PLUGIN...
• ubi plugins update
• ubi todo add TODO
• ubi todo delete TODO
• ubi todo list
• ubi todo ls
• ubi todo prio TODO PRIORITY
• ubi todo priority TODO PRIORITY
• ubi todo prune
• ubi todo purge
• ubi todo setp TODO PRIORITY
• ubi todo sets TODO STATUS
• ubi todo sett TODO TOPIC
• ubi todo status TODO STATUS
• ubi todo topic TODO TOPIC

ubi help [COMMANDS]

Display help for ubi.

USAGE
  $ ubi 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 ubi.

See code: @oclif/plugin-help

ubi idea add [IDEA] [SUMMARY]

Adds a new project idea

USAGE
  $ ubi idea add [IDEA] [SUMMARY] [-t tool|web|mobile|other] [-s small|medium|large|huge|unknown] [-d <value>]
    [-b]

ARGUMENTS
  IDEA     Name of the idea
  SUMMARY  Brief description of the idea

FLAGS
  -b, --business             Has business potential
  -d, --description=<value>  [default: No description] Long description with tech, language, framework, etc...
  -s, --size=<option>        [default: unknown] Size of the project at MVP stage
                             <options: small|medium|large|huge|unknown>
  -t, --type=<option>        [default: other] Type of project
                             <options: tool|web|mobile|other>

DESCRIPTION
  Adds a new project idea

ubi idea delete IDEA

Deletes a project idea

USAGE
  $ ubi idea delete [IDEA]

ARGUMENTS
  IDEA  Idea to delete. Can be the id or string slice from the todo. Won't work if it matches more than one result.

DESCRIPTION
  Deletes a project idea

ubi idea list

Lists ideas

USAGE
  $ ubi idea list [-b true|false|all] [-t tool|web|mobile|other|all] [-s small|medium|large|huge|unknown|all]

FLAGS
  -b, --business=<option>  [default: all] Filter ideas function of business compatibility
                           <options: true|false|all>
  -s, --size=<option>      [default: all] Filter ideas by size
                           <options: small|medium|large|huge|unknown|all>
  -t, --type=<option>      [default: all] Filter ideas by type
                           <options: tool|web|mobile|other|all>

DESCRIPTION
  Lists ideas

ALIASES
  $ ubi idea ls

ubi idea ls

Lists ideas

USAGE
  $ ubi idea ls [-b true|false|all] [-t tool|web|mobile|other|all] [-s small|medium|large|huge|unknown|all]

FLAGS
  -b, --business=<option>  [default: all] Filter ideas function of business compatibility
                           <options: true|false|all>
  -s, --size=<option>      [default: all] Filter ideas by size
                           <options: small|medium|large|huge|unknown|all>
  -t, --type=<option>      [default: all] Filter ideas by type
                           <options: tool|web|mobile|other|all>

DESCRIPTION
  Lists ideas

ALIASES
  $ ubi idea ls

ubi idea prune

Removes all ideas. (Hard reset -- Validation needed)

USAGE
  $ ubi idea prune [-f]

FLAGS
  -f, --force  Skips validation step.

DESCRIPTION
  Removes all ideas. (Hard reset -- Validation needed)

ubi idea update IDEA

Updates an idea

USAGE
  $ ubi idea update [IDEA]

ARGUMENTS
  IDEA  Idea to delete. Can be the id or string slice from the todo. Won't work if it matches more than one result.

DESCRIPTION
  Updates an idea

ubi plugins

List installed plugins.

USAGE
  $ ubi plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ ubi plugins

See code: @oclif/plugin-plugins

ubi plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ ubi plugins:install myplugin 

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

  $ ubi plugins:install someuser/someplugin

ubi plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

ubi plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ ubi plugins:install myplugin 

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

  $ ubi plugins:install someuser/someplugin

ubi plugins:link PLUGIN

Links a plugin into the CLI for development.

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

ubi plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ ubi plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ubi plugins unlink
  $ ubi plugins remove

ubi plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ ubi plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ubi plugins unlink
  $ ubi plugins remove

ubi plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ ubi plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ ubi plugins unlink
  $ ubi plugins remove

ubi plugins update

Update installed plugins.

USAGE
  $ ubi plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

ubi todo add TODO

Adds a new todo

USAGE
  $ ubi todo add [TODO] [-p high|medium|low] [-t dev|admin|daily|other] [-s do|doing|done]

ARGUMENTS
  TODO  Task to add

FLAGS
  -p, --priority=<option>  [default: medium] Defines priority
                           <options: high|medium|low>
  -s, --status=<option>    [default: do] Defines current status
                           <options: do|doing|done>
  -t, --topic=<option>     [default: other] Defines topic
                           <options: dev|admin|daily|other>

DESCRIPTION
  Adds a new todo

ubi todo delete TODO

Deletes a todo

USAGE
  $ ubi todo delete [TODO]

ARGUMENTS
  TODO  Task to delete. Can be the id or string slice from the todo. Won't work if it matches more than one result.

DESCRIPTION
  Deletes a todo

ubi todo list

Lists todos

USAGE
  $ ubi todo list [-p high|medium|low|all] [-t dev|admin|daily|other|all] [-s do|doing|done|all] [-l]

FLAGS
  -l, --long
  -p, --priority=<option>  [default: all] Lists todos with this priority
                           <options: high|medium|low|all>
  -s, --status=<option>    [default: all] Defines current status
                           <options: do|doing|done|all>
  -t, --topic=<option>     [default: all] Defines topic
                           <options: dev|admin|daily|other|all>

DESCRIPTION
  Lists todos

ALIASES
  $ ubi todo ls

ubi todo ls

Lists todos

USAGE
  $ ubi todo ls [-p high|medium|low|all] [-t dev|admin|daily|other|all] [-s do|doing|done|all] [-l]

FLAGS
  -l, --long
  -p, --priority=<option>  [default: all] Lists todos with this priority
                           <options: high|medium|low|all>
  -s, --status=<option>    [default: all] Defines current status
                           <options: do|doing|done|all>
  -t, --topic=<option>     [default: all] Defines topic
                           <options: dev|admin|daily|other|all>

DESCRIPTION
  Lists todos

ALIASES
  $ ubi todo ls

ubi todo prio TODO PRIORITY

Changes todo priority

USAGE
  $ ubi todo prio [TODO] [PRIORITY]

ARGUMENTS
  TODO      Task to modify. Can be the id or string slice from the todo. Won't work if it matches more than one result.
  PRIORITY  (high|medium|low) Priority to set

DESCRIPTION
  Changes todo priority

ALIASES
  $ ubi todo setp
  $ ubi todo prio

ubi todo priority TODO PRIORITY

Changes todo priority

USAGE
  $ ubi todo priority [TODO] [PRIORITY]

ARGUMENTS
  TODO      Task to modify. Can be the id or string slice from the todo. Won't work if it matches more than one result.
  PRIORITY  (high|medium|low) Priority to set

DESCRIPTION
  Changes todo priority

ALIASES
  $ ubi todo setp
  $ ubi todo prio

ubi todo prune

Removes all todos. (Hard reset -- Validation needed)

USAGE
  $ ubi todo prune [-f]

FLAGS
  -f, --force  Skips validation step.

DESCRIPTION
  Removes all todos. (Hard reset -- Validation needed)

ubi todo purge

Removes all done todos. (Validation needed)

USAGE
  $ ubi todo purge [-f]

FLAGS
  -f, --force  Skips validation step.

DESCRIPTION
  Removes all done todos. (Validation needed)

ubi todo setp TODO PRIORITY

Changes todo priority

USAGE
  $ ubi todo setp [TODO] [PRIORITY]

ARGUMENTS
  TODO      Task to modify. Can be the id or string slice from the todo. Won't work if it matches more than one result.
  PRIORITY  (high|medium|low) Priority to set

DESCRIPTION
  Changes todo priority

ALIASES
  $ ubi todo setp
  $ ubi todo prio

ubi todo sets TODO STATUS

Changes todo status

USAGE
  $ ubi todo sets [TODO] [STATUS]

ARGUMENTS
  TODO    Task to modify. Can be the id or string slice from the todo. Won't work if it matches more than one result.
  STATUS  (do|doing|done) Status to set

DESCRIPTION
  Changes todo status

ALIASES
  $ ubi todo sets
  $ ubi todo status

ubi todo sett TODO TOPIC

Changes todo topic

USAGE
  $ ubi todo sett [TODO] [TOPIC]

ARGUMENTS
  TODO   Task to modify. Can be the id or string slice from the todo. Won't work if it matches more than one result.
  TOPIC  (dev|admin|daily|other) Topic to set

DESCRIPTION
  Changes todo topic

ALIASES
  $ ubi todo sett
  $ ubi todo topic

ubi todo status TODO STATUS

Changes todo status

USAGE
  $ ubi todo status [TODO] [STATUS]

ARGUMENTS
  TODO    Task to modify. Can be the id or string slice from the todo. Won't work if it matches more than one result.
  STATUS  (do|doing|done) Status to set

DESCRIPTION
  Changes todo status

ALIASES
  $ ubi todo sets
  $ ubi todo status

ubi todo topic TODO TOPIC

Changes todo topic

USAGE
  $ ubi todo topic [TODO] [TOPIC]

ARGUMENTS
  TODO   Task to modify. Can be the id or string slice from the todo. Won't work if it matches more than one result.
  TOPIC  (dev|admin|daily|other) Topic to set

DESCRIPTION
  Changes todo topic

ALIASES
  $ ubi todo sett
  $ ubi todo topic