Welcome the CodeMRI(R) ® CLI Reference. The CodeMRI(R) ® Command-line Interface (CLI) provides an easy to use interface for administering and using your CodeMRI(R) ® product. To get started, see General Invocation.
General Invocation
The CodeMRI(R) ® CLI consists of a tree of commands and sub-commands, grouped by the concept or element that the command interacts with. For example, all commands that deal with logging in and logging out are nested under account as they relate to account management.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
cmri job list |
See the Command Listing section at the bottom of this document for a full listing of commands within the CodeMRI(R) ® CLI.
Common Options
In addition to command-specific options, all commands within the CodeMRI(R) ® CLI support the following common options:
| The path to the vault to connect to (run |
® CLI will fall back to the value of the | |
| One or more expressions that match elements within the vault to work with. If not provided, the CodeMRI |
® CLI use the value of the | |
| Specifies the desired format of command output, where possible. Commands that do not output any data, or certain special cases (e.g. help commands) will simply ignore the argument to |
| Specifies the path to an output file to write command output to. Commands that do not support output, or certain special cases (e.g. help commands) will simply ignore the argument to |
| Removes colored text from console output. Useful for screens where colored text is difficult to see (such as on old projectors). |
Environment Variables
| The vault path, if the |
| The selection set, if the |
Output Formats
The CodeMRI(R) ® CLI supports the following output formats:
| Human readable tabular or textual format. This is the default output format. |
| A series of newline-delimited rows with columns delimited by commas ( |
|
|
| A series of newline-delimited rows with columns delimited by tabs. The first row will be a header containing column names. |
|
|
| Either a single object or an array of JSON objects. |
Interactive Shell
The CodeMRI(R) ® CLI supports an interactive shell for running multiple commands in a single session. This is useful for situations where users need to perform a number of small operations without incurring the cost of starting up the CLI multiple times, or for working with complex selection sets not conducive to the single-line selection expressions afforded by --select and CMRI_SELECT.
To launch the CodeMRI® shell, run:
| Code Block | ||||
|---|---|---|---|---|
| ||||
cmri shell |
...
For running a script containing multiple commands within a single session, the CodeMRI(R) ® CLI supports batch scripting. To run a batch script, use:
| Code Block | ||||
|---|---|---|---|---|
| ||||
cmri batch run <script path> |
CodeMRI(R) ® can accept batch scripts through standard input on Linux platforms. Replace <script path> with /dev/stdin to process a script on standard input.
...
Batch scripts consist of a sequence of CodeMRI® commands, sans the cmri prefix. Empty lines or lines whose first non-whitespace character is # will be skipped.
...
If an error occurs during a batch script, whether due to an invalid command, invalid options, or a problem executing the command, CodeMRI(R) ® will print the error to standard error and stop processing the script.
...
By issuing the shell command within a script, users can create scripts that execute a sequence of commands, and then enter an interactive shell in the same session. This can be useful for setting up a complex selection set on which to run a set of interactive commands.
...