Document toolboxDocument toolbox

CLI Plugins

CLI Structure

The MettleCI Command Line Interface comprises a Command Shell which provides a command line interface into a set of MettleCI CLI Plugins (delivered as a set of .jar files) which provide the various MettleCI CLI capabilities. Some of those plugins rely on using third party capabilities, such as DataStage client tools (such as istool), for example.

The MettleCI Command Shell (accessed with the command mettleci UNIX or mettleci.cmd Windows) is used to execute the commands made available by the installed CLI plugins. Each command exists within a Namespace which is required to fully qualify the required command. The compliance and unittest namespaces, for example, both feature a test command, each of which perform unrelated functions. The Command Shell is used like this:

# Windows C:\> mettleci.cmd {namespace} {command} {parameters} # UNIX $> mettleci {namespace} {command} {parameters} # e.g. $> mettleci datastage deploy \ -domain services-tier.myorg.com:59445 -server engine-tier.myorg.com \ -project dstage1 \ -username isadmin -password isadminpwd \ -assets assets_dir -project-cache project_cache_dir -include-job-in-test-name

Directory Structure

The MettleCI CLI directory structure looks like this. Plugins are supplied as .jar files which are installed in the .plugins directory.

. ├── bin │   └── <implementation>.jar ├── config.properties ├── docs │   ├── namespace1 │   │   ├── <command1-documentation> │   │   ├── <command2-documentation> │   │   ├── <command3-documentation> │   │   └── <command4-documentation> │   ├── namespace2 │   │   ├── <command1-documentation> │   │   └── <command2-documentation> │   ├── namespace3 │   │   ├── <command1-documentation> │   │   ├── <command2-documentation> │   │   └── <command4-documentation> ├── lib │   └── <implementation>.jar ├── log ├── mettleci ├── mettleci.cmd └── plugins ├── <filename1>-plugin-<major-version>-<build-number>.jar ├── <filename2>-plugin-<major-version>-<build-number>.jar ├── <filename3>-plugin-<major-version>-<build-number>.jar └── <filename4>-plugin-<major-version>-<build-number>.jar

Available Commands

The following namespaces and commands are currently available. More details are available here.

© 2015-2024 Data Migrators Pty Ltd.