Skip to content

Commit

Permalink
Update NX Runner documentation
Browse files Browse the repository at this point in the history
* Add documentation for CMake generation.
* Improve description for each of the commands.
* Add examples for using each of the commands.

Fixes #731
  • Loading branch information
mmarineBlueQuartz committed Dec 15, 2023
1 parent 1d80548 commit e89dd91
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions src/nxrunner/docs/NX_CLI.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# NX Runner (NX CLI)

NX Runner is an executable that allows preflighting and executing complex pipelines from the command line. The executable is created as part of the default complex CMake project and created alongside the complex library file.

In addition, NX Runner contains commands for porting SIMPL pipeline files to complex pipelines. One of these commands prints the converted pipeline to the terminal, and the other saves the converted pipeline to a new file using the complex pipeline extension.

## Commands

### Help
Expand All @@ -19,7 +23,9 @@ Lists available commands or displays details regarding a specific command.
-e <pipeline filepath> [--logfile | -l]
```

Execute the pipeline at the target filepath. Optionally, create a log file at the specified path.
Executes the pipeline at the target filepath while printing the output to the terminal. Optionally, a log file is created at the specified filepath where the output is saved.

For example, ```--execute bash D:/Directory/pipeline.d3pipeline -l D:/Logs/pipeline.log``` will attempt to execute the pipeline at `D:/Directory/pipeline.d3pipeline` and saves the output to `D:/Logs/pipeline.log`.

### Preflight

Expand All @@ -28,7 +34,9 @@ Execute the pipeline at the target filepath. Optionally, create a log file at th
-p <pipeline filepath> [--logfile | -l]
```

Preflight the pipeline at the target filepath. Optionally, create a log file at the specified path.
Preflights the pipeline at the target filepath while printing the output to the terminal. Optionally, a log file is created at the specified filepath where the output is saved.

For example, ```--preflight bash D:/Directory/pipeline.d3pipeline -l D:/Logs/pipeline.log``` will attempt to preflight the pipeline at `D:/Directory/pipeline.d3pipeline` and saves the output to `D:/Logs/pipeline.log`.

### Convert

Expand All @@ -40,7 +48,8 @@ Preflight the pipeline at the target filepath. Optionally, create a log file at
-co <pipeline filepath> [--logfile | -l]
```

Convert the SIMPL pipeline at the target filepath. Optionally, create a log file at the specified path.
Both options print the converted pipeline to the console. The second option (convert-output / co) also saves the converted pipeline to file based on the name of the converted pipeline.
Converts a SIMPL pipeline at the target filepath to a complex pipeline. If any errors are encountered during the process, they are printed to the console. Otherwise, the converted pipeline is printed to the console. Optionally, a log file is created at the specified filepath where the output is saved.

The second option (convert-output / co) also saves the converted pipeline to file based on the name of the converted pipeline using the complex pipeline extension (`.d3pipeline`).

For example, ```--convert-output bash D:/Directory/SIMPL.json``` will attempt to convert the SIMPL pipeline at `D:/Directory/SIMPL.json` and save the converted pipeline to `D:/Directory/SIMPL.d3pipeline`

0 comments on commit e89dd91

Please sign in to comment.