OS Manuals

/usr/bin/api-linter

Linter for protobuf APIs following Google's API design guidance

From api-linter 2.4.1-r0 (enterprise-packages), captured 2026-11-08 by running api-linter --help (exit 0). permalink

Usage of api-linter:
      --config string                   The linter config file.
      --debug                           Run in debug mode. Panics will print stack.
      --descriptor-set-in stringArray   The file containing a FileDescriptorSet for searching proto imports.
                                        May be specified multiple times.
                                        Also used as the source of proto files to lint when --skip-compilation is enabled.
      --disable-rule stringArray        Disable a rule with the given name.
                                        May be specified multiple times.
      --enable-rule stringArray         Enable a rule with the given name.
                                        May be specified multiple times.
      --ignore-comment-disables         If set to true, disable comments will be ignored.
                                        This is helpful when strict enforcement of AIPs are necessary and
                                        proto definitions should not be able to disable checks.
      --list-rules                      Print the rules and exit. Honors the output-format flag.
      --output-format string            The format of the linting results.
                                        Supported formats include "yaml", "json","github" and "summary" table.
                                        YAML is the default.
  -o, --output-path string              The output file path.
                                        If not given, the linting results will be printed out to STDOUT.
  -I, --proto-path stringArray          The folder for searching proto imports.
                                        May be specified multiple times; directories will be searched in order.
                                        The current working directory is always used.
      --set-exit-status                 Return exit status 1 when lint errors are found.
      --skip-compilation                Skip the compilation of the proto files and instead use the provided descriptor set to look up the files to lint. When using this flag, the provided descriptor set must contain the files to be linted and should have been compiled with --include_source_info and --include_imports.
      --version                         Print version and exit.
Options (13)
OptionDescriptionSource
--config stringThe linter config file.help
--debugRun in debug mode.help
--descriptor-set-in stringArrayThe file containing a FileDescriptorSet for searching proto imports.help
--disable-rule stringArrayDisable a rule with the given name.help
--enable-rule stringArrayEnable a rule with the given name.help
--ignore-comment-disablesIf set to true, disable comments will be ignored.help
--list-rulesPrint the rules and exit.help
--output-format stringThe format of the linting results.help
-o, --output-path stringThe output file path.help
-I, --proto-path stringArrayThe folder for searching proto imports.help
--set-exit-statusReturn exit status 1 when lint errors are found.help
--skip-compilationSkip the compilation of the proto files and instead use the provided descriptor set to look up the files to lint.help
--versionPrint version and exit.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.