A simple oclif-cli boilerplate for making lot of things happen. 🔥
- Zero configuration typescript setup with oclif
- Automatic trunk-based release pipeline using GitHub Workflow and Semantic Versioning.
- Table of Contents
- Development
- Links
- Usage
- Commands
ocliftsdx goodbye PERSONocliftsdx hello PERSONocliftsdx hello dumpocliftsdx hello worldocliftsdx help [COMMAND]ocliftsdx pluginsocliftsdx plugins:inspect PLUGIN...ocliftsdx plugins:install PLUGIN...ocliftsdx plugins:link PLUGINocliftsdx plugins:uninstall PLUGIN...ocliftsdx plugins update- LICENSE
To run the CLI:
yarn start ARGS_AND_FLAGSTo build the files:
yarn buildStaging will also automatically update this README using husky precommit hooks.
To run the executable:
./bin/run ARGS_AND_FLAGS- How to publish packages using GitHub Packages
- How to use auto to publish GitHub Packages
- Use semantic release to release packages like oclif cli.
- Add access control and visibility to GitHub Packages
$ npm install -g @murshidazher/oclif-tsdx-boilerplate
$ ocliftsdx COMMAND
running command...
$ ocliftsdx (--version)
@murshidazher/oclif-tsdx-boilerplate/0.0.0 darwin-x64 node-v17.0.0
$ ocliftsdx --help [COMMAND]
USAGE
$ ocliftsdx COMMAND
...ocliftsdx goodbye PERSONocliftsdx hello PERSONocliftsdx hello dumpocliftsdx hello worldocliftsdx help [COMMAND]ocliftsdx pluginsocliftsdx plugins:inspect PLUGIN...ocliftsdx plugins:install PLUGIN...ocliftsdx plugins:link PLUGINocliftsdx plugins:uninstall PLUGIN...ocliftsdx plugins update
Say goodbye
USAGE
$ ocliftsdx goodbye [PERSON] -f <value>
ARGUMENTS
PERSON Person to say goodbye to when signing off
FLAGS
-f, --from=<value> (required) Whom is saying goodbye
DESCRIPTION
Say goodbye
EXAMPLES
$ ocliftsdx goodbye friend --from oclif
goodbye friend from oclif! (./src/commands/goodbye/index.ts)
See code: dist/commands/goodbye/index.ts
Say hello
USAGE
$ ocliftsdx hello [PERSON] -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Whom is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ ocliftsdx hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
See code: dist/commands/hello/index.ts
Say hello dump
USAGE
$ ocliftsdx hello dump
DESCRIPTION
Say hello dump
EXAMPLES
$ ocliftsdx hello dump
hello dump! (./src/commands/hello/dump.ts)
Say hello world
USAGE
$ ocliftsdx hello world
DESCRIPTION
Say hello world
EXAMPLES
$ ocliftsdx hello world
hello world! (./src/commands/hello/world.ts)
Display help for ocliftsdx.
USAGE
$ ocliftsdx 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 ocliftsdx.
See code: @oclif/plugin-help
List installed plugins.
USAGE
$ ocliftsdx plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ ocliftsdx plugins
See code: @oclif/plugin-plugins
Displays installation properties of a plugin.
USAGE
$ ocliftsdx plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ ocliftsdx plugins:inspect myplugin
Installs a plugin into the CLI.
USAGE
$ ocliftsdx 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
$ ocliftsdx plugins add
EXAMPLES
$ ocliftsdx plugins:install myplugin
$ ocliftsdx plugins:install https://github.com/someuser/someplugin
$ ocliftsdx plugins:install someuser/someplugin
Links a plugin into the CLI for development.
USAGE
$ ocliftsdx 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
$ ocliftsdx plugins:link myplugin
Removes a plugin from the CLI.
USAGE
$ ocliftsdx plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ocliftsdx plugins unlink
$ ocliftsdx plugins remove
Update installed plugins.
USAGE
$ ocliftsdx plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
MIT © 2021-2022 Murshid Azher.