Xcl-feature NPM

oclif-hello-world

oclif example Hello World CLI

Usage

$ npm install -g xcl-feature
$ xcl COMMAND
running command...
$ xcl (--version)
xcl-feature/0.0.3 win32-x64 node-v16.17.0
$ xcl --help [COMMAND]
USAGE
  $ xcl COMMAND
...

Commands

`xcl`

add, remove or update a feature

USAGE
  $ xcl

DESCRIPTION
  add, remove or update a feature

EXAMPLES
  $ xcl feature [add|deinstall|install|list|remove|update|versions] #FEATURE#

See code: dist/commands/index.ts

`xcl add FEATURE [PROJECT] [USERNAME] [PASSWORD] [VERSION]`

add Feature to dependency list

USAGE
  $ xcl add FEATURE [PROJECT] [USERNAME] [PASSWORD] [VERSION] [-h] [-i] [-c]

ARGUMENTS
  FEATURE   Name of the Feature to add
  PROJECT   Name of the Project (when not in a xcl-Project path)
  USERNAME  schema name for the feature to be installed in
  PASSWORD  password for the new schema
  VERSION   Version of the Feature

FLAGS
  -c, --custom       add a custom feature
  -h, --help         Show CLI help.
  -i, --interactive  interactive mode

DESCRIPTION
  add Feature to dependency list

See code: dist/commands/add.ts

`xcl deinstall FEATURE [PROJECT]`

deinstall a Feature from Database

USAGE
  $ xcl deinstall FEATURE [PROJECT] -c <value> -s <value> [-h] [-d]

ARGUMENTS
  FEATURE  Name of the Project-Feature to be installed
  PROJECT  name of the Project (when not in a xcl-Project path)

FLAGS
  -c, --connection=<value>  (required) connection string HOST:PORT/SERVICE_NAME
  -d, --drop                drop owner schema
  -h, --help                Show CLI help.
  -s, --syspw=<value>       (required) Password of SYS-User

DESCRIPTION
  deinstall a Feature from Database

See code: dist/commands/deinstall.ts

`xcl help [COMMANDS]`

Display help for xcl.

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

See code: @oclif/plugin-help

`xcl install FEATURE PROJECT`

install a Feature to target Schema

USAGE
  $ xcl install FEATURE PROJECT [-h] [-c <value>] [-s <value>]

ARGUMENTS
  FEATURE  Name of the Project-Feature to be installed
  PROJECT  name of the Project (when not in a xcl-Project path)

FLAGS
  -c, --connection=<value>  [default: unset] connection string HOST:PORT/SERVICE_NAME
  -h, --help                Show CLI help.
  -s, --syspw=<value>       Password of SYS-User

DESCRIPTION
  install a Feature to target Schema

See code: dist/commands/install.ts

`xcl list [TYPE] [PROJECT]`

lists all available Features

USAGE
  $ xcl list [TYPE] [PROJECT] [-h] [-a]

ARGUMENTS
  TYPE     [default: all] Show all Features of type [DB or DEPLOY]
  PROJECT  [default: all] Show Features added to a Project (when not in a XCL-Directory it shows all Features available)

FLAGS
  -a, --all   show all Features available
  -h, --help  Show CLI help.

DESCRIPTION
  lists all available Features

See code: dist/commands/list.ts

`xcl plugins`

List installed plugins.

USAGE
  $ xcl plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ xcl plugins

See code: @oclif/plugin-plugins

`xcl plugins:install PLUGIN...`

Installs a plugin into the CLI.

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

EXAMPLES
  $ xcl plugins:install myplugin 

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

  $ xcl plugins:install someuser/someplugin

`xcl plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

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

`xcl plugins:install PLUGIN...`

Installs a plugin into the CLI.

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

EXAMPLES
  $ xcl plugins:install myplugin 

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

  $ xcl plugins:install someuser/someplugin

`xcl plugins:link PLUGIN`

Links a plugin into the CLI for development.

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

`xcl plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ xcl plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ xcl plugins unlink
  $ xcl plugins remove

`xcl plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ xcl plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ xcl plugins unlink
  $ xcl plugins remove

`xcl plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ xcl plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ xcl plugins unlink
  $ xcl plugins remove

`xcl plugins update`

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

`xcl remove FEATURE [PROJECT]`

remove Feature from Project

USAGE
  $ xcl remove FEATURE [PROJECT] [-h] [-d] [-c <value>] [-s <value>] [-o]

ARGUMENTS
  FEATURE  Name of the Project-Feature to be installed
  PROJECT  Name of the Project (when not in a xcl-Project path)

FLAGS
  -c, --connection=<value>  [default: unset] connection to database (required when deinstall Feature) [
                            HOST:PORT/SERVICE_NAME ]
  -d, --deinstall           deinstall Feature from database
  -h, --help                Show CLI help.
  -o, --owner               drop Feature owner schema
  -s, --syspw=<value>       password of SYS-User

DESCRIPTION
  remove Feature from Project

See code: dist/commands/remove.ts

`xcl update FEATURE [VERSION] [PROJECT]`

update Project Feature version

USAGE
  $ xcl update FEATURE [VERSION] [PROJECT] -c <value> [-h] [-s <value>]

ARGUMENTS
  FEATURE  Name of the Project-Feature to be installed
  VERSION  Version of the Feature
  PROJECT  name of the Project (when not in a xcl-Project path)

FLAGS
  -c, --connection=<value>  (required) [default: unset] connection string HOST:PORT/SERVICE_NAME
  -h, --help                shows this help
  -s, --syspw=<value>       Password of SYS-User

DESCRIPTION
  update Project Feature version

See code: dist/commands/update.ts

`xcl versions FEATURE`

lists all available Releases of the Feature

USAGE
  $ xcl versions FEATURE [-h]

ARGUMENTS
  FEATURE  name of the feature

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  lists all available Releases of the Feature

See code: dist/commands/versions.ts

oclif

@oclif/core @oclif/plugin-help xcl-core

@everything-registry/sub-chunk-3177

1 year ago

1 year ago

1 year ago

1 year ago