Skip to content

Commit

Permalink
docs: clarity around write
Browse files Browse the repository at this point in the history
  • Loading branch information
meganwolf0 committed Oct 22, 2024
1 parent 40ce060 commit eeff200
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
16 changes: 15 additions & 1 deletion docs/console/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@ lula console -f /path/to/oscal-component.yaml,/path/to/oscal-component-2.yaml,/p
The `-f` (or `--input-files`) flag can be used to specify multiple OSCAL model file paths to be loaded into the Console.

### Writing to Output
Currently, the Console supports only writing to the `component-definition` model.

#### Component Definition

The Console supports writing updated `remarks` and `description` fields to the `component-definition` model.

To include an output file to save any changes made to the component definition, use the `--component-output` or `-c`flag:
```shell
Expand All @@ -27,6 +30,17 @@ lula console -f /path/to/oscal-component.yaml -c /path/to/output.yaml

If no output file is specified and a single component definition is passed, the provided component definition will be overwritten. If multiple component definitions are passed and no output file is specified, the Console will default to `component.yaml` in the current working directory.

#### Assessment Results

The Console supports writing assessment results that are generated from the Component Definition `validate` execution.

To specify an output file to write assessment results, include `--assessment-output` or `-a`. If you provide no `-a`, but include a single assessment results file as inputs (via `--input-files`/`-f`), that will be used as the output file. If no assessment results file is provided (or multiple are provided), the Console will default to `assessment-results.yaml` in the current working directory.

Example of running console including the optionality to write assessment results to the provided file:
```shell
lula console -f /path/to/oscal-component.yaml -a /path/to/output.yaml
```

## Keys

The Console responds to the following keys for navigation and interaction (each sub-model has additional key response, see respective help views for more information):
Expand Down
2 changes: 1 addition & 1 deletion docs/console/component-definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The Validation Detail is a view that displays a somewhat curated version of the

### Validation Execution

A validation can be executed using the `ctrl+v` keycommand. This will run the validation ONLY for the currently active framework.
A validation can be executed using the `ctrl+v` keycommand. This will run the validation ONLY for the currently active framework. This also will automatically run executable validations. Future work will be added to allow for more granular control over validation execution in the console.

<img align="right" src="../../images/component-defn-console-validate.gif" alt="component definition console validation detail" style="width:100%; height:auto;">
<div style="clear: both;"></div>

0 comments on commit eeff200

Please sign in to comment.