Skip to content

Commit

Permalink
docs: Include the --config argument in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
felipebz committed Jul 14, 2024
1 parent 9df9c51 commit 1e674fc
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ Currently, the zpa-cli supports these options:
* `--extensions`: File extensions to analyze, separated by comma. The default value is `sql,pkg,pks,pkb,fun,pcd,tgg,prc,tpb,trg,typ,tab,tps`.
* `--output-format`: Format of the output. The default value is `console`.
* `--output-file`: Path to the output file.
* `--config`: Path to the configuration file. The file format must comply with the [provided JSON schema](schema.json).
You can refer to the example [zpa-config-example.json](zpa-config-example.json) for guidance. If the configuration
file is not provided, only the rules marked as "activated by default" will be executed.

Output formats:
* `console`: writes the analysis result on the standard output
Expand Down

0 comments on commit 1e674fc

Please sign in to comment.