CLI Reference

Generated from falcon's argument parser (v0.4.6). A fast Dart linter.

usagebash

falcon [OPTIONS] <COMMAND>

Global options

Accepted by every subcommand.

--log-format <FORMAT>

Log output format

default: textvalues: text | json

--verbose

flag

`falcon check`

Lint one or more Dart files or directories

usagebash

falcon check [OPTIONS] [PATHS]...

<PATHS>positional

Paths to lint (defaults to the current directory)

--config <CONFIG>

Path to falcon.json config

--format <FORMAT>

Output format for diagnostics

--write

Apply safe fixes to selected Dart files

flag

--unsafe

Also apply fixes classified as unsafe (requires --write)

flag

--dry-run

Preview fixes as a unified diff without modifying files (requires --write)

flag

--exclude <GLOB>

Config-relative glob patterns to exclude (repeatable)

--max-errors <N>

Limit the number of printed diagnostics without changing the exit status

--error-on-warnings

Fail on warnings as well as errors

flag

--baseline <PATH>

Suppress existing findings recorded in this baseline

--write-baseline <PATH>

Record current findings (defaults to the configured baseline or project-root falcon-baseline.json)

--quiet

Suppress all diagnostic output

flag

--no-errors-on-unmatched

Do not report missing paths or runs that process no files

flag

--exit-code <N>

Exit code to use when violations are found (default: 1)

default: 1

`falcon lsp`

Start the LSP server (reads JSON-RPC 2.0 from stdin)

usagebash

falcon lsp [OPTIONS]

No options.

`falcon migrate`

Migrate to falcon.json. Converts a `dart_code_linter` / `pyramid_lint` `analysis_options.yaml`, or upgrades an existing falcon.json by rewriting legacy rule ids to their canonical form (auto-detected from the input)

usagebash

falcon migrate [OPTIONS]

--input <PATH>

Path to the input: an `analysis_options.yaml` to convert, or an existing falcon.json to upgrade (default: ./`analysis_options.yaml`)

--write

Write falcon.json instead of printing to stdout

flag

--output <PATH>

Output path when --write is set (default: ./falcon.json)

`falcon version`

Print version information and exit

usagebash

falcon version [OPTIONS]

No options.