README.md in inspec_tools-1.7.3 vs README.md in inspec_tools-1.8.2

- old
+ new

@@ -184,11 +184,11 @@ example: inspec_tools inspec2xccdf -j example.json -a attributes.yml -o xccdf.xml ``` ## csv2inspec -Convert a csv export of STIG controls to an InSpec profile +csv2inspec translates CSV to Inspec controls using a mapping file. ``` USAGE: inspec_tools csv2inspec [OPTIONS] -c <stig-csv> -m <map-yml> FLAGS: @@ -197,11 +197,11 @@ -V --verbose : verbose run [optional] -o --output <profile-path> : path to the InSpec profile output (default: profile) [optional] -f --format [ruby | hash] : the format you would like (default: ruby) [optional] -s --separate-files [true | false] : separate the controls into different files (default: true) [optional] -example: inspec_tools csv2inspec -c stig.csv -m map.yml -o mydir -f ruby -s true # To map stig.csv to InSpec via map.yml +example: inspec_tools csv2inspec -c examples/csv2inspec/stig.csv -m examples/csv2inspec/mapping.yml -o mydir -f ruby -s true # To map stig.csv to InSpec via mapping.yml ``` ## inspec2csv Convert an InSpec json to a csv file @@ -254,20 +254,20 @@ ``` Usage: inspec_tools xlsx2inspec -m, --mapping=MAPPING -p, --control-name-prefix=CONTROL_NAME_PREFIX -x, --xlsx=XLSX Options: - -x, --xlsx=XLSX - -m, --mapping=MAPPING - -p, --control-name-prefix=CONTROL_NAME_PREFIX - -V, [--verbose], [--no-verbose] - -o, [--output=OUTPUT] + -x, --xlsx=XLSX + -m, --mapping=MAPPING + -p, --control-name-prefix=CONTROL_NAME_PREFIX + -V, [--verbose], [--no-verbose] + -o, [--output=OUTPUT] # Default: profile - -f, [--format=FORMAT] + -f, [--format=FORMAT] # Default: ruby # Possible values: ruby, hash - -s, [--separate-files], [--no-separate-files] + -s, [--separate-files], [--no-separate-files] # Default: true [--log-level=LOG_LEVEL] # Set the logging level: ["debug", "info", "warn", "error", "fatal"] [--log-location=LOG_LOCATION] # Location to send diagnostic log messages to. (default: $stdout or Inspec::Log.error) l, [--log-directory=LOG_DIRECTORY] # Provie log location @@ -283,9 +283,17 @@ Prints out the gem version ``` USAGE: inspec_tools version ``` + +# Format of Input and Output Files + +InspecTools will make a best effort approach when converting various legacy terms and values in input files. If some terminology is not supported, please open an issue. + +InspecTools is opinionated about the output of its profiles. Profiles generated by InspecTools generally attempt to adhere to latest National Institute of Standards and Technology (NIST) terms and values, such as the Common Vulnerability Scoring System (CVSS). + +View our wiki pages on [expected](https://github.com/mitre/inspec_tools/wiki/Expected-Input) input and [expected output](https://github.com/mitre/inspec_tools/wiki/Expected-Output) for more information about what is currently supported input and expected output. # `inspec_tools` Development View our [wiki page](https://github.com/mitre/inspec_tools/wiki/Development) for more information on contributing.