CLI Reference

Generated from falcon's argument parser (v0.3.0). 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

--config <CONFIG>

Path to falcon.json config

--format <FORMAT>

Output format for diagnostics

default: textvalues: text | json

--exclude <GLOB>

Glob patterns to exclude (repeatable)

--max-errors <N>

Stop after this many diagnostics

--quiet

Suppress all diagnostic output

flag

--exit-code <N>

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

default: 1

--parallel

Use Rayon parallel file analysis instead of sequential

flag

`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.