|
| 1 | +--- |
| 2 | +status: reviewed |
| 3 | +owner: John McKeever |
| 4 | +tags: |
| 5 | + - DATASTAGE |
| 6 | + - TESTING |
| 7 | +--- |
| 8 | +# MettleCI Command Shell |
| 9 | + |
| 10 | +The MettleCI Command Line Interface is available from either your Windows command line or Unix shell. It provides one way of accessing MettleCI's build and deployment functions, and supports two different modes of operation: console or command line. MettleCI commands accept various parameters which can optionally be sourced from a command file. |
| 11 | + |
| 12 | +## Console Mode |
| 13 | + |
| 14 | +To enter console mode start the MettleCI Command Line Interface by entering `mettleci` (UNIX) or `mettleci.cmd` (Windows). |
| 15 | + |
| 16 | +```bat |
| 17 | +C:\> mettleci.cmd |
| 18 | +MettleCI Command Line |
| 19 | +(C)2019 Data Migrators Pty Ltd |
| 20 | +Enter [namespace] [command] {options} |
| 21 | +or 'help', 'exit', or 'quit'. |
| 22 | +mettleci> |
| 23 | +``` |
| 24 | + |
| 25 | +In console mode MettleCI prints a command prompt and waits for a command. Each command is processed without exiting MettleCI. You may need to provide authentication options for a commands which invoke functionality in third party systems. You can enter help to get assistance, or exit the console mode by entering exit, or quit at the prompt. |
| 26 | + |
| 27 | +## Command mode |
| 28 | + |
| 29 | +In command mode you can enter commands one at a time at your operating system's command line. Start each command (omitting the quotes) with `mettleci` (unix) or `mettleci.cmd` (Windows) followed by a namespace and command, then the parameters. |
| 30 | + |
| 31 | +Open image2019-10-25_22-51-19.png |
| 32 | + |
| 33 | +Some of the available commands (listed below) use IBM DataStage client components, and so are platform specific. For example, job compilation requires access to Windows-only components, and so will not be supported on Unix environments. The MettleCI command is followed by a namespace, which groups a collection of build and deployment operations. Each of these commands accepts a number of mandatory and/or optional parameters. |
| 34 | + |
| 35 | + |
| 36 | +``` |
| 37 | +mettleci [namespace] [command] {commandoptions} |
| 38 | +``` |
| 39 | + |
| 40 | +Here's an example of the MettleCI Command Line being used to compile an entire DataStage project (using the ['compile' command provided by the 'datastage' namespace](link.md)) : |
| 41 | + |
| 42 | +```shell |
| 43 | +# Note that the example below uses the line continuation charactere ('\' on Unix or '^' on Windows) |
| 44 | +# to aid readability, but your mettleci command line can all be on a single line if you prefer |
| 45 | +$> mettleci datastage compile \ |
| 46 | + -domain test1-svcs.datamigrators.io:59445 \ |
| 47 | + -server test1-engn.datamigrators.io -project dstage1 \ |
| 48 | + -username isadmin -password isadminpwd |
| 49 | +Analyzing assets to compile |
| 50 | +Compilation folder location = C:\Apps\command-shell\log\compiliation |
| 51 | +Attempting to compile with 4 working threads. |
| 52 | +Compiling DataStage jobs... |
| 53 | + * Compile 'test2-engn.datamigrators.io/dstage1/Jobs/Load/EX_Account.pjb' - COMPLETED |
| 54 | + [SNIP] |
| 55 | + * Compile 'test2-engn.datamigrators.io/dstage1/Jobs/Load/TX_StockHolding.pjb' - COMPLETED |
| 56 | +Compilation complete |
| 57 | +$> |
| 58 | +``` |
| 59 | + |
| 60 | +Note that MettleCI Command Line namespaces, commands, and options are all case sensitive. |
| 61 | + |
| 62 | +## Use a password containing special characters |
| 63 | + |
| 64 | +If the password contains special characters, you will need to wrap it with single or double quote or by using escape characters. |
| 65 | + |
| 66 | +| Password contains | Windows-based | Unix-based | |
| 67 | +|-------------------|---------------|------------| |
| 68 | +| ! (exclamation) | Use password without modification. For example: MyPassword! | Wrap password with single quote. For example: 'MyPassword!' | |
| 69 | +| “ (double quote) | Use escape character \. For example: My\”Password | Wrap password with single quote. For example: 'My"Password' | |
| 70 | +| ' (single quote) | Wrap password with double quote. For example: “My'Password” | Wrap password with single quote and use escape character \. For example: 'My'\''Password' | |
| 71 | +| * (asterisk) | Use password without modification. For example: My*Password | Wrap password with single quote. For example: 'My*Password' | |
| 72 | +| <space> | Wrap password with double quote. For example: “My Password” | Wrap password with single quote. For example: 'My Password' | |
| 73 | + |
| 74 | +## Using external command files with the MettleCI CLI |
| 75 | + |
| 76 | +MettleCI allows you to define a MettleCI command in a text-based ‘command file’ and pass the file as parameter to the MettleCI command. This is accomplished using the '@' command syntax: |
| 77 | + |
| 78 | +```shell |
| 79 | +# Here's a typical command file |
| 80 | +$> cat file mycommand.txt |
| 81 | +datastage |
| 82 | +compile |
| 83 | +-domain |
| 84 | +test1-svcs.datamigrators.io:59445 |
| 85 | +-username |
| 86 | +isadmin |
| 87 | +-password |
| 88 | +isadminpwd |
| 89 | +-server |
| 90 | +test1-engn.datamigrators.io |
| 91 | +-project |
| 92 | +dstage1 |
| 93 | +# ... and here's how to invoke it |
| 94 | +$> mettleci @mycommand.txt |
| 95 | +``` |
| 96 | + |
| 97 | +Note: |
| 98 | + |
| 99 | +* Each element of a command file needs to be on an individual line (i.e. separated by your operating system’s newline ASCII character combination) |
| 100 | +* A command file can only contain the definition of a single MettleCI command |
| 101 | +* You can run the MettleCI Command Line with multiple commands by invoking it with individual command files from a shell script with one command per line. E.g. |
| 102 | + |
| 103 | +```bash |
| 104 | +#!/usr/bin/env bash |
| 105 | +mettleci @mycommand1.txt |
| 106 | +mettleci @mycommand2.txt |
| 107 | +mettleci @mycommand3.txt |
| 108 | +# etc. |
| 109 | +``` |
0 commit comments