https://github.com/clerk/cli-auth-unofficial-example
https://github.com/clerk/cli-auth-unofficial-example
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/clerk/cli-auth-unofficial-example
- Owner: clerk
- Created: 2023-06-09T03:10:01.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-02T15:07:38.000Z (almost 3 years ago)
- Last Synced: 2024-06-14T05:45:55.225Z (about 2 years ago)
- Language: TypeScript
- Size: 45.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
oclif-hello-world
=================
oclif example Hello World CLI
[](https://oclif.io)
[](https://circleci.com/gh/oclif/hello-world/tree/main)
[](https://github.com/oclif/hello-world/blob/main/LICENSE)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g mycli
$ mycli COMMAND
running command...
$ mycli (--version)
mycli/0.0.0 darwin-arm64 node-v18.16.0
$ mycli --help [COMMAND]
USAGE
$ mycli COMMAND
...
```
# Commands
* [`mycli hello PERSON`](#mycli-hello-person)
* [`mycli hello world`](#mycli-hello-world)
* [`mycli help [COMMANDS]`](#mycli-help-commands)
* [`mycli plugins`](#mycli-plugins)
* [`mycli plugins:install PLUGIN...`](#mycli-pluginsinstall-plugin)
* [`mycli plugins:inspect PLUGIN...`](#mycli-pluginsinspect-plugin)
* [`mycli plugins:install PLUGIN...`](#mycli-pluginsinstall-plugin-1)
* [`mycli plugins:link PLUGIN`](#mycli-pluginslink-plugin)
* [`mycli plugins:uninstall PLUGIN...`](#mycli-pluginsuninstall-plugin)
* [`mycli plugins:uninstall PLUGIN...`](#mycli-pluginsuninstall-plugin-1)
* [`mycli plugins:uninstall PLUGIN...`](#mycli-pluginsuninstall-plugin-2)
* [`mycli plugins update`](#mycli-plugins-update)
## `mycli hello PERSON`
Say hello
```
USAGE
$ mycli 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/nikosdouvlis/mycli/blob/v0.0.0/dist/commands/hello/index.ts)_
## `mycli hello world`
Say hello world
```
USAGE
$ mycli hello world
DESCRIPTION
Say hello world
EXAMPLES
$ mycli hello world
hello world! (./src/commands/hello/world.ts)
```
## `mycli help [COMMANDS]`
Display help for mycli.
```
USAGE
$ mycli 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 mycli.
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
## `mycli plugins`
List installed plugins.
```
USAGE
$ mycli plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ mycli plugins
```
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.7/src/commands/plugins/index.ts)_
## `mycli plugins:install PLUGIN...`
Installs a plugin into the CLI.
```
USAGE
$ mycli 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
$ mycli plugins add
EXAMPLES
$ mycli plugins:install myplugin
$ mycli plugins:install https://github.com/someuser/someplugin
$ mycli plugins:install someuser/someplugin
```
## `mycli plugins:inspect PLUGIN...`
Displays installation properties of a plugin.
```
USAGE
$ mycli 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
$ mycli plugins:inspect myplugin
```
## `mycli plugins:install PLUGIN...`
Installs a plugin into the CLI.
```
USAGE
$ mycli 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
$ mycli plugins add
EXAMPLES
$ mycli plugins:install myplugin
$ mycli plugins:install https://github.com/someuser/someplugin
$ mycli plugins:install someuser/someplugin
```
## `mycli plugins:link PLUGIN`
Links a plugin into the CLI for development.
```
USAGE
$ mycli 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
$ mycli plugins:link myplugin
```
## `mycli plugins:uninstall PLUGIN...`
Removes a plugin from the CLI.
```
USAGE
$ mycli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ mycli plugins unlink
$ mycli plugins remove
```
## `mycli plugins:uninstall PLUGIN...`
Removes a plugin from the CLI.
```
USAGE
$ mycli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ mycli plugins unlink
$ mycli plugins remove
```
## `mycli plugins:uninstall PLUGIN...`
Removes a plugin from the CLI.
```
USAGE
$ mycli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ mycli plugins unlink
$ mycli plugins remove
```
## `mycli plugins update`
Update installed plugins.
```
USAGE
$ mycli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
```