https://github.com/oclif/plugin-test-core-v1
https://github.com/oclif/plugin-test-core-v1
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/oclif/plugin-test-core-v1
- Owner: oclif
- Created: 2023-09-18T16:08:20.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-09-07T03:25:01.000Z (11 months ago)
- Last Synced: 2025-09-07T05:38:44.991Z (11 months ago)
- Language: JavaScript
- Size: 2.16 MB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
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 @oclif/plugin-test-core-v1
$ corev1 COMMAND
running command...
$ corev1 (--version)
@oclif/plugin-test-core-v1/0.2.16 linux-x64 node-v20.20.0
$ corev1 --help [COMMAND]
USAGE
$ corev1 COMMAND
...
```
# Commands
* [`corev1 core-v1 [OPTIONALARG] [DEFAULTARG] [DEFAULTFNARG]`](#corev1-core-v1-optionalarg-defaultarg-defaultfnarg)
* [`corev1 help [COMMANDS]`](#corev1-help-commands)
* [`corev1 plugins`](#corev1-plugins)
* [`corev1 plugins:inspect PLUGIN...`](#corev1-pluginsinspect-plugin)
* [`corev1 plugins:install PLUGIN...`](#corev1-pluginsinstall-plugin)
* [`corev1 plugins:link PLUGIN`](#corev1-pluginslink-plugin)
* [`corev1 plugins:uninstall PLUGIN...`](#corev1-pluginsuninstall-plugin)
* [`corev1 plugins update`](#corev1-plugins-update)
## `corev1 core-v1 [OPTIONALARG] [DEFAULTARG] [DEFAULTFNARG]`
```
USAGE
$ corev1 core-v1 [OPTIONALARG] [DEFAULTARG] [DEFAULTFNARG] [--json] [--optionalString ]
[--defaultString ] [--defaultFnString ]
FLAGS
--defaultFnString= [default: async fn default]
--defaultString= [default: simple string default]
--optionalString=
GLOBAL FLAGS
--json Format output as json.
```
_See code: [src/commands/core-v1.ts](https://github.com/oclif/plugin-test-core-v1/blob/0.2.16/src/commands/core-v1.ts)_
## `corev1 help [COMMANDS]`
Display help for corev1.
```
USAGE
$ corev1 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 corev1.
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/5.2.20/src/commands/help.ts)_
## `corev1 plugins`
List installed plugins.
```
USAGE
$ corev1 plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ corev1 plugins
```
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/3.10.1/src/commands/plugins/index.ts)_
## `corev1 plugins:inspect PLUGIN...`
Displays installation properties of a plugin.
```
USAGE
$ corev1 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
$ corev1 plugins:inspect myplugin
```
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/3.10.1/src/commands/plugins/inspect.ts)_
## `corev1 plugins:install PLUGIN...`
Installs a plugin into the CLI.
```
USAGE
$ corev1 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
$ corev1 plugins add
EXAMPLES
$ corev1 plugins:install myplugin
$ corev1 plugins:install https://github.com/someuser/someplugin
$ corev1 plugins:install someuser/someplugin
```
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/3.10.1/src/commands/plugins/install.ts)_
## `corev1 plugins:link PLUGIN`
Links a plugin into the CLI for development.
```
USAGE
$ corev1 plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
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
$ corev1 plugins:link myplugin
```
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/3.10.1/src/commands/plugins/link.ts)_
## `corev1 plugins:uninstall PLUGIN...`
Removes a plugin from the CLI.
```
USAGE
$ corev1 plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ corev1 plugins unlink
$ corev1 plugins remove
```
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/3.10.1/src/commands/plugins/uninstall.ts)_
## `corev1 plugins update`
Update installed plugins.
```
USAGE
$ corev1 plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
```
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/3.10.1/src/commands/plugins/update.ts)_