oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

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

Commands

• xcl apply [PROJECT]
• xcl help [COMMANDS]
• xcl project apply [PROJECT]
• xcl project build [PROJECT]
• xcl project create [PROJECT]
• xcl project deploy [PROJECT]
• xcl project init [PROJECT]
• xcl project list
• xcl project plan [PROJECT]
• xcl project remove PROJECT
• xcl project reset [COMMIT] [PROJECT]

xcl apply [PROJECT]

apply a plan to a project

USAGE
  $ xcl apply [PROJECT] [-h]

ARGUMENTS
  PROJECT  name of the project that a plan should be applied to

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  apply a plan to a project

ALIASES
  $ xcl apply

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 project apply [PROJECT]

apply a plan to a project

USAGE
  $ xcl project apply [PROJECT] [-h]

ARGUMENTS
  PROJECT  name of the project that a plan should be applied to

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  apply a plan to a project

ALIASES
  $ xcl apply

xcl project build [PROJECT]

create build to deploy

USAGE
  $ xcl project build [PROJECT] [-h] [-m <value>] [-v <value>] [-c <value>]

ARGUMENTS
  PROJECT  name of the project that should be build

FLAGS
  -c, --commit=<value>   commit or tag to build the deliverable
  -h, --help             Show CLI help.
  -m, --mode=<value>     mode of build (init/patch)
  -v, --version=<value>  Version to tag build

DESCRIPTION
  create build to deploy

xcl project create [PROJECT]

creates a project including a new directory and the configured folder structure

USAGE
  $ xcl project create [PROJECT] [-h] [-w <value>] [--single-schema] [-i]

ARGUMENTS
  PROJECT  name of the project to create

FLAGS
  -h, --help               Show CLI help.
  -i, --interactive        Interactive wizard that guides you through the creation of the project
  -w, --workspace=<value>  workspace name the application should be installed in
  --single-schema          one schema instead of three, no deployment user

DESCRIPTION
  creates a project including a new directory and the configured folder structure

xcl project deploy [PROJECT]

deploy the project or build

USAGE
  $ xcl project deploy [PROJECT] -c <value> [-h] [-p <value>] [-d] [-s <value>] [--schema-only] [-m <value>] [-b
    <value>] [-y] [--ords-url <value>] [--schema <value>] [--quiet] [--nocompile]

ARGUMENTS
  PROJECT  Name of the project that should be deployed

FLAGS
  -b, --build=<value>       build-number to deploy
  -c, --connection=<value>  (required) [default: unset] connection string HOST:PORT/SERVICE_NAME
  -d, --dependencies        Deploy inclusive dependencies (you will be asked for sys-user password)
  -h, --help                Show CLI help.
  -m, --mode=<value>        [default: dev] mode of build (init/patch/dev)
  -p, --password=<value>    Password for Deployment User
  -s, --syspw=<value>       Provide sys-password for silent mode dependency installation [IMPORTANT: All existing users
                            will be overwritten!]
  -y, --yes                 Automatic proceed to the next schema without asking
  --nocompile               ignore invalid objects on deploy
  --ords-url=<value>        [IP/SERVERNAME]:PORT
  --quiet                   suppress output
  --schema=<value>          to deploy a single schema type one of the following: [data, logic, app]
  --schema-only             Deploys only schema objects

DESCRIPTION
  deploy the project or build

xcl project init [PROJECT]

initializes a project

USAGE
  $ xcl project init [PROJECT] [-h] [-s <value>] [-c <value>] [-f] [-y] [-o] [-u]

ARGUMENTS
  PROJECT  name of the project to initialze

FLAGS
  -c, --connection=<value>  [default: unset] Connectstring ex. localhost:1521/xepdb1
  -f, --force               Attention: force will drop existing schemas
  -h, --help                Show CLI help.
  -o, --objects             Install basic objects defined in setup directory
  -s, --syspw=<value>       Password of user sys
  -u, --users               Install standard schemas APP, LOGIC, DATA, DEPL
  -y, --yes                 Answers force-action with yes (Use with caution)

DESCRIPTION
  initializes a project

xcl project list

lists all xcl projects

USAGE
  $ xcl project list [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  lists all xcl projects

xcl project plan [PROJECT]

generate commands to bring the project up to date

USAGE
  $ xcl project plan [PROJECT] [-h] [--auto-apply] [--yes]

ARGUMENTS
  PROJECT  name of the project

FLAGS
  -h, --help    Show CLI help.
  --auto-apply  proceed with apply after plan
  --yes         skip all prompts with answer 'yes'

DESCRIPTION
  generate commands to bring the project up to date

xcl project remove PROJECT

removes a project

USAGE
  $ xcl project remove PROJECT [-h] [-p] [-d] [-c <value>] [-s <value>]

ARGUMENTS
  PROJECT  name of the project to remove

FLAGS
  -c, --connection=<value>
  -d, --database
  -h, --help                Show CLI help.
  -p, --path
  -s, --syspw=<value>

DESCRIPTION
  removes a project

xcl project reset [COMMIT] [PROJECT]

reset project to commit id or tag

USAGE
  $ xcl project reset [COMMIT] [PROJECT] [-h] [-y]

ARGUMENTS
  COMMIT   commit id or tag name
  PROJECT  name of the project

FLAGS
  -h, --help  Show CLI help.
  -y, --yes   proceed without confirmation

DESCRIPTION
  reset project to commit id or tag

EXAMPLES
  $ xcl project reset