https://github.com/oclif/hello-world-esm
Template repository for generating ESM oclif plugins
https://github.com/oclif/hello-world-esm
Last synced: over 1 year ago
JSON representation
Template repository for generating ESM oclif plugins
- Host: GitHub
- URL: https://github.com/oclif/hello-world-esm
- Owner: oclif
- License: mit
- Archived: true
- Created: 2023-07-26T19:35:04.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-27T11:23:45.000Z (about 2 years ago)
- Last Synced: 2024-12-28T19:02:42.516Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1.99 MB
- Stars: 5
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
oclif-hello-world
=================
oclif example Hello World CLI
[](https://oclif.io)
[](https://github.com/oclif/hello-world/blob/main/LICENSE)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g oclif-hello-world
$ oex COMMAND
running command...
$ oex (--version)
oclif-hello-world/0.0.0 darwin-x64 node-v16.13.1
$ oex --help [COMMAND]
USAGE
$ oex COMMAND
...
```
# Commands
* [`oex hello PERSON`](#oex-hello-person)
* [`oex hello world`](#oex-hello-world)
* [`oex help [COMMAND]`](#oex-help-command)
* [`oex plugins`](#oex-plugins)
* [`oex plugins:inspect PLUGIN...`](#oex-pluginsinspect-plugin)
* [`oex plugins:install PLUGIN...`](#oex-pluginsinstall-plugin)
* [`oex plugins:link PLUGIN`](#oex-pluginslink-plugin)
* [`oex plugins:uninstall PLUGIN...`](#oex-pluginsuninstall-plugin)
* [`oex plugins update`](#oex-plugins-update)
## `oex hello PERSON`
Say hello
```
USAGE
$ oex hello [PERSON] -f
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from= (required) Who is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ oex hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
```
_See code: [dist/commands/hello/index.ts](https://github.com/oclif/hello-world/blob/v0.0.0/dist/commands/hello/index.ts)_
## `oex hello world`
Say hello world
```
USAGE
$ oex hello world
DESCRIPTION
Say hello world
EXAMPLES
$ oex hello world
hello world! (./src/commands/hello/world.ts)
```
## `oex help [COMMAND]`
Display help for oex.
```
USAGE
$ oex 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 oex.
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.10/src/commands/help.ts)_
## `oex plugins`
List installed plugins.
```
USAGE
$ oex plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ oex plugins
```
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/index.ts)_
## `oex plugins:inspect PLUGIN...`
Displays installation properties of a plugin.
```
USAGE
$ oex 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
$ oex plugins:inspect myplugin
```
## `oex plugins:install PLUGIN...`
Installs a plugin into the CLI.
```
USAGE
$ oex 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
$ oex plugins add
EXAMPLES
$ oex plugins:install myplugin
$ oex plugins:install https://github.com/someuser/someplugin
$ oex plugins:install someuser/someplugin
```
## `oex plugins:link PLUGIN`
Links a plugin into the CLI for development.
```
USAGE
$ oex 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
$ oex plugins:link myplugin
```
## `oex plugins:uninstall PLUGIN...`
Removes a plugin from the CLI.
```
USAGE
$ oex plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ oex plugins unlink
$ oex plugins remove
```
## `oex plugins update`
Update installed plugins.
```
USAGE
$ oex plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
```