CLI Options
Complete reference for all command-line options.
Global Options
Section titled “Global Options”--help, -h
Section titled “--help, -h”Print help information for the command.
fsh-lint --helpfsh-lint lint --help--version, -V
Section titled “--version, -V”Print version information.
fsh-lint --version# Output: fsh-lint 0.1.0--verbose, -v
Section titled “--verbose, -v”Enable verbose logging output.
fsh-lint --verbose lint **/*.fsh--color <WHEN>
Section titled “--color <WHEN>”Control color output:
auto- Automatic (default)always- Always colorizenever- Never colorize
fsh-lint --color always lint **/*.fshfsh-lint --color never lint **/*.fsh > output.txtLint Options
Section titled “Lint Options”Automatically apply safe fixes.
fsh-lint lint --fix **/*.fsh--severity <LEVEL>
Section titled “--severity <LEVEL>”Filter diagnostics by minimum severity:
hintinfowarnerror
fsh-lint lint --severity error **/*.fsh--format <FORMAT>
Section titled “--format <FORMAT>”Output format:
human- Human-readable (default)json- JSON formatsarif- SARIF formatgithub- GitHub Actions annotations
fsh-lint lint --format json **/*.fshfsh-lint lint --format github **/*.fsh--config <PATH>
Section titled “--config <PATH>”Specify configuration file path.
fsh-lint lint --config custom-config.json **/*.fsh--no-config
Section titled “--no-config”Ignore all configuration files.
fsh-lint lint --no-config **/*.fsh--max-diagnostics <N>
Section titled “--max-diagnostics <N>”Limit number of diagnostics shown.
fsh-lint lint --max-diagnostics 50 **/*.fsh--rule <RULE>
Section titled “--rule <RULE>”Enable only specific rules.
fsh-lint lint --rule style/naming-convention **/*.fshfsh-lint lint --rule correctness/** **/*.fsh--ignore-pattern <PATTERN>
Section titled “--ignore-pattern <PATTERN>”Ignore files matching pattern.
fsh-lint lint --ignore-pattern "**/*.generated.fsh" **/*.fshFormat Options
Section titled “Format Options”--check
Section titled “--check”Check formatting without modifying files.
fsh-lint format --check **/*.fsh--diff
Section titled “--diff”Show formatting differences.
fsh-lint format --diff **/*.fshInit Options
Section titled “Init Options”--full
Section titled “--full”Generate full example configuration.
fsh-lint init --full--output <PATH>
Section titled “--output <PATH>”Specify output path for configuration.
fsh-lint init --output .fshlintrc.jsonRules Options
Section titled “Rules Options”--detailed
Section titled “--detailed”Show detailed rule information.
fsh-lint rules --detailed--category <CATEGORY>
Section titled “--category <CATEGORY>”Filter rules by category:
styledocumentationcorrectnesssuspicious
fsh-lint rules --category style--search <QUERY>
Section titled “--search <QUERY>”Search rules by name or description.
fsh-lint rules --search namingEnvironment Variables
Section titled “Environment Variables”FSH_LINT_CONFIG
Section titled “FSH_LINT_CONFIG”Override configuration file path.
export FSH_LINT_CONFIG=custom-config.jsonfsh-lint lint **/*.fshFSH_LINT_NO_COLOR
Section titled “FSH_LINT_NO_COLOR”Disable color output.
export FSH_LINT_NO_COLOR=1fsh-lint lint **/*.fshFSH_LINT_CACHE_DIR
Section titled “FSH_LINT_CACHE_DIR”Set cache directory location.
export FSH_LINT_CACHE_DIR=.fsh-lint-cachefsh-lint lint **/*.fsh