Sign inSign up
Reference
Reference / Buf CLI commands / buf config

buf config ls-lint-rules

List lint rules

Usage

$ buf config ls-lint-rules [flags]

Flags

--config string

The buf.yaml file or data to use for configuration. --configured-only must be set

--configured-only

List rules that are configured instead of listing all available rules

--format string

The format to print rules as. Must be one of [text,json]

-h, --help

help for ls-lint-rules

--include-deprecated

Also print deprecated rules. Has no effect if --configured-only is set.

--module-path string

The path to the specific module to list configured rules for as specified in the buf.yaml. If the buf.yaml has more than one module defined, this must be set. --configured-only must be set

--version string

List all the rules for the given configuration version. By default, the version in the buf.yaml in the current directory is used, or the latest version otherwise (currently v2). Cannot be set if --configured-only is set. Must be one of [v1beta1 v1 v2]

Flags inherited from parent commands

--debug

Turn on debug logging

--log-format string

The log format [text,color,json]

--timeout duration

The duration until timing out, setting it to zero means no timeout

-v, --verbose

Turn on verbose mode

Parent Command

  1. Usage
  2. Flags
    1. --config string
    2. --configured-only
    3. --format string
    4. -h, --help
    5. --include-deprecated
    6. --module-path string
    7. --version string
  3. Flags inherited from parent commands
    1. --debug
    2. --log-format string
    3. --timeout duration
    4. -v, --verbose
  4. Parent Command