@carlos-daniel/utils
v1.0.0
Published
oclif example Hello World CLI
Downloads
1
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g @carlos-daniel/utils
$ cdu COMMAND
running command...
$ cdu (--version)
@carlos-daniel/utils/1.0.0 darwin-arm64 node-v16.19.1
$ cdu --help [COMMAND]
USAGE
$ cdu COMMAND
...
Commands
cdu check-missing-files-dirs
cdu copy-envs
cdu hello world
cdu help [COMMANDS]
cdu plugins
cdu plugins:install PLUGIN...
cdu plugins:inspect PLUGIN...
cdu plugins:install PLUGIN...
cdu plugins:link PLUGIN
cdu plugins:uninstall PLUGIN...
cdu plugins:uninstall PLUGIN...
cdu plugins:uninstall PLUGIN...
cdu plugins update
cdu check-missing-files-dirs
Will compare the files and directories of the source and target directories and will output the missing files and directories.
USAGE
$ cdu check-missing-files-dirs -o <value> -t <value>
FLAGS
-o, --origin=<value> (required) Path to the base dir
-t, --target=<value> (required) Path to the target dir
DESCRIPTION
Will compare the files and directories of the source and target directories and will output the missing files and
directories.
EXAMPLES
$ cdu check-missing-files-dirs
See code: dist/commands/check-missing-files-dirs.ts
cdu copy-envs
Are you moving to a new machine and wants to get all the env files you might have around?
USAGE
$ cdu copy-envs -p <value> [-t <value>] [-c]
FLAGS
-c, --compress Compress the envs directory into a zip file
-p, --path=<value> (required) Path to the directory where your .env files are located
-t, --target=<value> Custom path to the directory where your .env files will be copied to
DESCRIPTION
Are you moving to a new machine and wants to get all the env files you might have around?
This script is for you! Or at least for me for all the times I had to go through all my projects and copy the .env
files to the new machine.
This will copy all the .env files to a new directory whilst recreating the folders structure.
EXAMPLES
$ cdu copy-envs
hello world! (./src/commands/hello/world.ts)
See code: dist/commands/copy-envs.ts
cdu hello world
Say hello world
USAGE
$ cdu hello world
DESCRIPTION
Say hello world
EXAMPLES
$ cdu hello world
hello world! (./src/commands/hello/world.ts)
cdu help [COMMANDS]
Display help for cdu.
USAGE
$ cdu 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 cdu.
See code: @oclif/plugin-help
cdu plugins
List installed plugins.
USAGE
$ cdu plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ cdu plugins
See code: @oclif/plugin-plugins
cdu plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ cdu 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
$ cdu plugins add
EXAMPLES
$ cdu plugins:install myplugin
$ cdu plugins:install https://github.com/someuser/someplugin
$ cdu plugins:install someuser/someplugin
cdu plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ cdu 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
$ cdu plugins:inspect myplugin
cdu plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ cdu 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
$ cdu plugins add
EXAMPLES
$ cdu plugins:install myplugin
$ cdu plugins:install https://github.com/someuser/someplugin
$ cdu plugins:install someuser/someplugin
cdu plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ cdu 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
$ cdu plugins:link myplugin
cdu plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ cdu plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cdu plugins unlink
$ cdu plugins remove
cdu plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ cdu plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cdu plugins unlink
$ cdu plugins remove
cdu plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ cdu plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ cdu plugins unlink
$ cdu plugins remove
cdu plugins update
Update installed plugins.
USAGE
$ cdu plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.