# xcl-feature

> xcl feature plugin

Latest version **0.0.8** (published 2023-03-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install xcl-feature
pnpm add xcl-feature
yarn add xcl-feature
bun add xcl-feature
```

Provides the command `xcl`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2023-03-20 |
| First published | 2023-03-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 3 |
| Unpacked size | 42.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | jaw @jwinkels |
| Maintainers | jan.winkels |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/xcl-feature
- Repository: https://github.com/jwinkels/xcl-feature
- Issues: https://github.com/jwinkels/xcl-feature/issues
- npm.io page: https://npm.io/package/xcl-feature

## Dependencies (3)

- [xcl-core](https://npm.io/package/xcl-core.md) ^1.0.7
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^2
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^5

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.8 (latest) — 2023-03-20
- 0.0.7 — 2023-03-20
- 0.0.6 — 2023-03-20
- 0.0.5 — 2023-03-20
- 0.0.4 — 2023-03-20
- 0.0.3 — 2023-03-20
- 0.0.2 — 2023-03-20
- 0.0.1 — 2023-03-20
- 0.0.0 — 2023-03-20

## README

oclif-hello-world
=================

oclif example Hello World CLI

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)
[![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main)
[![Downloads/week](https://img.shields.io/npm/dw/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)
[![License](https://img.shields.io/npm/l/oclif-hello-world.svg)](https://github.com/oclif/hello-world/blob/main/package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ 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
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`xcl`](#xcl)
* [`xcl add FEATURE [PROJECT] [USERNAME] [PASSWORD] [VERSION]`](#xcl-add-feature-project-username-password-version)
* [`xcl deinstall FEATURE [PROJECT]`](#xcl-deinstall-feature-project)
* [`xcl help [COMMANDS]`](#xcl-help-commands)
* [`xcl install FEATURE PROJECT`](#xcl-install-feature-project)
* [`xcl list [TYPE] [PROJECT]`](#xcl-list-type-project)
* [`xcl plugins`](#xcl-plugins)
* [`xcl plugins:install PLUGIN...`](#xcl-pluginsinstall-plugin)
* [`xcl plugins:inspect PLUGIN...`](#xcl-pluginsinspect-plugin)
* [`xcl plugins:install PLUGIN...`](#xcl-pluginsinstall-plugin-1)
* [`xcl plugins:link PLUGIN`](#xcl-pluginslink-plugin)
* [`xcl plugins:uninstall PLUGIN...`](#xcl-pluginsuninstall-plugin)
* [`xcl plugins:uninstall PLUGIN...`](#xcl-pluginsuninstall-plugin-1)
* [`xcl plugins:uninstall PLUGIN...`](#xcl-pluginsuninstall-plugin-2)
* [`xcl plugins update`](#xcl-plugins-update)
* [`xcl remove FEATURE [PROJECT]`](#xcl-remove-feature-project)
* [`xcl update FEATURE [VERSION] [PROJECT]`](#xcl-update-feature-version-project)
* [`xcl versions FEATURE`](#xcl-versions-feature)

## `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](https://github.com/jwinkels/xcl-feature/blob/v0.0.3/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](https://github.com/jwinkels/xcl-feature/blob/v0.0.3/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](https://github.com/jwinkels/xcl-feature/blob/v0.0.3/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](https://github.com/oclif/plugin-help/blob/v5.2.8/src/commands/help.ts)_

## `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](https://github.com/jwinkels/xcl-feature/blob/v0.0.3/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](https://github.com/jwinkels/xcl-feature/blob/v0.0.3/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](https://github.com/oclif/plugin-plugins/blob/v2.4.3/src/commands/plugins/index.ts)_

## `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](https://github.com/jwinkels/xcl-feature/blob/v0.0.3/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](https://github.com/jwinkels/xcl-feature/blob/v0.0.3/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](https://github.com/jwinkels/xcl-feature/blob/v0.0.3/dist/commands/versions.ts)_
<!-- commandsstop -->

---
_Source: https://npm.io/package/xcl-feature · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._