@perfectiondev/cli v0.1.15

oclif-perfection

oclif Perfection CLI

• Usage
• Commands

Usage

$ npm install -g @perfectiondev/cli
$ perfection COMMAND
running command...
$ perfection (--version)
@perfectiondev/cli/0.1.15 linux-x64 node-v19.6.0
$ perfection --help [COMMAND]
USAGE
  $ perfection COMMAND
...

Commands

• perfection app components sync
• perfection app theme create
• perfection app theme delete
• perfection app theme sync
• perfection config set
• perfection help [COMMANDS]
• perfection plugins
• perfection plugins:install PLUGIN...
• perfection plugins:inspect PLUGIN...
• perfection plugins:install PLUGIN...
• perfection plugins:link PLUGIN
• perfection plugins:uninstall PLUGIN...
• perfection plugins:uninstall PLUGIN...
• perfection plugins:uninstall PLUGIN...
• perfection plugins update

perfection app components sync

Synchronize components with theme

USAGE
  $ perfection app components sync -f <value> [--json] [--config <value>] [--apiKey <value>] [--subscription <value>]
    [--baseUrl <value>]

FLAGS
  -f, --file=<value>      (required) Theme file path to be synced with
  --apiKey=<value>        Personal API access key
  --baseUrl=<value>       API base url
  --config=<value>        relative path to the configuration file
  --subscription=<value>  Subscription ID

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Synchronize components with theme

EXAMPLES
  $ perfection app components sync

perfection app theme create

Create application's theme based on key

USAGE
  $ perfection app theme create -f <value> [--json] [--config <value>] [--apiKey <value>] [--subscription <value>]
    [--baseUrl <value>] [-k <value>] [-n <value>] [-d <value>]

FLAGS
  -d, --description=<value>  Theme description
  -f, --file=<value>         (required) File path and name to be created
  -k, --key=<value>          Theme key
  -n, --name=<value>         Theme name
  --apiKey=<value>           Personal API access key
  --baseUrl=<value>          API base url
  --config=<value>           relative path to the configuration file
  --subscription=<value>     Subscription ID

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Create application's theme based on key

EXAMPLES
  $ perfection app theme create

perfection app theme delete

Delete application's theme based on key

USAGE
  $ perfection app theme delete -k <value> [--json] [--config <value>] [--apiKey <value>] [--subscription <value>]
    [--baseUrl <value>]

FLAGS
  -k, --key=<value>       (required)
  --apiKey=<value>        Personal API access key
  --baseUrl=<value>       API base url
  --config=<value>        relative path to the configuration file
  --subscription=<value>  Subscription ID

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Delete application's theme based on key

EXAMPLES
  $ perfection app theme delete --theme MY_THEME_KEY

perfection app theme sync

Sync application theme

USAGE
  $ perfection app theme sync -f <value> [--json] [--config <value>] [--apiKey <value>] [--subscription <value>]
    [--baseUrl <value>]

FLAGS
  -f, --file=<value>      (required) Path to theme file
  --apiKey=<value>        Personal API access key
  --baseUrl=<value>       API base url
  --config=<value>        relative path to the configuration file
  --subscription=<value>  Subscription ID

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Sync application theme

EXAMPLES
  $ perfection app theme sync

perfection config set

Set configuration properties

USAGE
  $ perfection config set [--json] [--config <value>] [--apiKey <value>] [--subscription <value>] [--baseUrl
    <value>]

FLAGS
  --apiKey=<value>        Personal API access key
  --baseUrl=<value>       API base url
  --config=<value>        relative path to the configuration file
  --subscription=<value>  Subscription ID

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Set configuration properties

EXAMPLES
  $ perfection config set --apiKey {API_KEY} --subscription {SUBSCRIPTION} --baseUrl {BASE_URL}

perfection help [COMMANDS]

Display help for perfection.

USAGE
  $ perfection 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 perfection.

See code: @oclif/plugin-help

perfection plugins

List installed plugins.

USAGE
  $ perfection plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ perfection plugins

See code: @oclif/plugin-plugins

perfection plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ perfection 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
  $ perfection plugins add

EXAMPLES
  $ perfection plugins:install myplugin 

  $ perfection plugins:install https://github.com/someuser/someplugin

  $ perfection plugins:install someuser/someplugin

perfection plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ perfection 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
  $ perfection plugins:inspect myplugin

perfection plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ perfection 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
  $ perfection plugins add

EXAMPLES
  $ perfection plugins:install myplugin 

  $ perfection plugins:install https://github.com/someuser/someplugin

  $ perfection plugins:install someuser/someplugin

perfection plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ perfection 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
  $ perfection plugins:link myplugin

perfection plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ perfection plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ perfection plugins unlink
  $ perfection plugins remove

perfection plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ perfection plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ perfection plugins unlink
  $ perfection plugins remove

perfection plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ perfection plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ perfection plugins unlink
  $ perfection plugins remove

perfection plugins update

Update installed plugins.

USAGE
  $ perfection plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.