0.0.8 • Published 5 months ago
prof-of-config v0.0.8
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g prof-of-config
$ prof-of-config COMMAND
running command...
$ prof-of-config (--version)
prof-of-config/0.0.8 darwin-arm64 node-v18.13.0
$ prof-of-config --help [COMMAND]
USAGE
$ prof-of-config COMMAND
...
Commands
prof-of-config create-config
prof-of-config help [COMMANDS]
prof-of-config plugins
prof-of-config plugins:install PLUGIN...
prof-of-config plugins:inspect PLUGIN...
prof-of-config plugins:install PLUGIN...
prof-of-config plugins:link PLUGIN
prof-of-config plugins:uninstall PLUGIN...
prof-of-config plugins:uninstall PLUGIN...
prof-of-config plugins:uninstall PLUGIN...
prof-of-config plugins update
prof-of-config create-config
Generate a config file
USAGE
$ prof-of-config create-config -s approvals|webFrontend [-e dev|tst|acc|prd|demo|tst-integration] [-t <value>]
FLAGS
-e, --env=<option> [default: dev] Name of environment
<options: dev|tst|acc|prd|demo|tst-integration>
-s, --service=<option> (required) Name of services
<options: approvals|webFrontend>
-t, --accessToken=<value> [default: ATCTT3xFfGN0JY-tyfz1zcLGxmUMLv-keAEcVBvdkYp7_nkhOGuXR_waDhWzekBFczzq9mJwHCWLrysxP
Wh61HitXqvUvSLKyJDE1wV11kEF32BJU-IdFhRlkTgYIYzF9phsJPY_JpXQFJ3UuHIjKqAncb3bjvwHPJ4Cde6AIkpO
Uk6mqfyRk-E=B96DB6E0] Token for bitbucket repo
DESCRIPTION
Generate a config file
EXAMPLES
$ prof-of-config create-config
See code: src/commands/create-config.ts
prof-of-config help [COMMANDS]
Display help for prof-of-config.
USAGE
$ prof-of-config 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 prof-of-config.
See code: @oclif/plugin-help
prof-of-config plugins
List installed plugins.
USAGE
$ prof-of-config plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ prof-of-config plugins
See code: @oclif/plugin-plugins
prof-of-config plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ prof-of-config 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
$ prof-of-config plugins add
EXAMPLES
$ prof-of-config plugins:install myplugin
$ prof-of-config plugins:install https://github.com/someuser/someplugin
$ prof-of-config plugins:install someuser/someplugin
prof-of-config plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ prof-of-config 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
$ prof-of-config plugins:inspect myplugin
See code: @oclif/plugin-plugins
prof-of-config plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ prof-of-config 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
$ prof-of-config plugins add
EXAMPLES
$ prof-of-config plugins:install myplugin
$ prof-of-config plugins:install https://github.com/someuser/someplugin
$ prof-of-config plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
prof-of-config plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ prof-of-config 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
$ prof-of-config plugins:link myplugin
See code: @oclif/plugin-plugins
prof-of-config plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ prof-of-config plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ prof-of-config plugins unlink
$ prof-of-config plugins remove
prof-of-config plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ prof-of-config plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ prof-of-config plugins unlink
$ prof-of-config plugins remove
See code: @oclif/plugin-plugins
prof-of-config plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ prof-of-config plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ prof-of-config plugins unlink
$ prof-of-config plugins remove
prof-of-config plugins update
Update installed plugins.
USAGE
$ prof-of-config plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins