Skip to content

Commit

Permalink
Convert env doc to a table
Browse files Browse the repository at this point in the history
  • Loading branch information
nikonhub committed Oct 22, 2024
1 parent 1c0c0e8 commit 4d922df
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,13 +120,15 @@ optional flags:

The config-file-validator supports setting options via environment variables. If both command-line flags and environment variables are set, the command-line flags will take precedence. The supported environment variables are as follows:

- `CFV_DEPTH`: Equivalent to the `-depth` flag
- `CFV_EXCLUDE_DIRS`: Equivalent to the `-exclude-dirs` flag
- `CFV_EXCLUDE_FILE_TYPES`: Equivalent to the `-exclude-file-types` flag
- `CFV_OUTPUT`: Equivalent to the `-output` flag
- `CFV_REPORTER`: Equivalent to the `-reporter` flag
- `CFV_GROUPBY`: Equivalent to the `-groupby` flag
- `CFV_QUIET`: Equivalent to the `-quiet` flag
| Environment Variable | Equivalent Flag |
|----------------------|-----------------|
| `CFV_DEPTH` | `-depth` |
| `CFV_EXCLUDE_DIRS` | `-exclude-dirs` |
| `CFV_EXCLUDE_FILE_TYPES` | `-exclude-file-types` |
| `CFV_OUTPUT` | `-output` |
| `CFV_REPORTER` | `-reporter` |
| `CFV_GROUPBY` | `-groupby` |
| `CFV_QUIET` | `-quiet` |

### Examples
#### Standard Run
Expand Down

0 comments on commit 4d922df

Please sign in to comment.