CLI Reference

-a/--autocorrect

Autocorrect offenses (only when it’s safe). See Autocorrect.

--auto-correct

Deprecated alias of -a/--autocorrect.

-A/--autocorrect-all

Autocorrect offenses (safe and unsafe). See Autocorrect.

--auto-correct-all

Deprecated alias of -A/--autocorrect-all.

--auto-gen-config

Generate a configuration file acting as a TODO list.

--[no-]color

Force color output on or off.

-c/--config

Run with specified config file.

-C/--cache

Store and reuse results for faster operation.

-d/--debug

Displays some extra debug output.

--disable-pending-cops

Run without pending cops.

--disable-uncorrectable

Used with --autocorrect to annotate any offenses that do not support autocorrect with rubocop:todo comments.

-D/--[no-]display-cop-names

Displays cop names in offense messages. Default is true.

--display-time

Display elapsed time in seconds.

--display-only-fail-level-offenses

Only output offense messages at the specified --fail-level or above.

--display-only-correctable

Only output correctable offense messages.

--display-only-safe-correctable

Only output safe correctable offense messages.

--enable-pending-cops

Run with pending cops.

--except

Run all cops enabled by configuration except the specified cop(s) and/or departments.

--exclude-limit

Limit how many individual files --auto-gen-config can list in Exclude parameters, default is 15.

-E/--extra-details

Displays extra details in offense messages.

-f/--format

Choose a formatter, see Formatters.

-F/--fail-fast

Inspect files in order of modification time and stops after first file with offenses.

--fail-level

Minimum severity for exit with error code. Full severity name or upper case initial can be given. Normally, autocorrected offenses are ignored. Use A or autocorrect if you’d like any autocorrectable offense to trigger failure, regardless of severity.

--force-exclusion

Force excluding files specified in the configuration Exclude even if they are explicitly passed as arguments.

--only-recognized-file-types

Inspect files given on the command line only if they are listed in AllCops/Include parameters of user configuration or default configuration.

-h/--help

Print usage information.

--ignore-disable-comments

Report offenses even if they have been manually disabled with a rubocop:disable or rubocop:todo directive.

--ignore-parent-exclusion

Ignores all Exclude: settings from all .rubocop.yml files present in parent folders. This is useful when you are importing submodules when you want to test them without being affected by the parent module’s rubocop settings.

--ignore-unrecognized-cops

Ignore unrecognized cops or departments in the config.

--init

Generate a .rubocop.yml file in the current directory.

-l/--lint

Run only lint cops.

-L/--list-target-files

List all files RuboCop will inspect.

--[no-]auto-gen-only-exclude

Generate only Exclude parameters and not Max when running --auto-gen-config, except if the number of files with offenses is bigger than exclude-limit. Default is false

--[no-]auto-gen-timestamp

Include the date and time when --auto-gen-config was run in the config file it generates. Default is true.

--[no-]offense-counts

Show offense counts in config file generated by --auto-gen-config. Default is true.

--only

Run only the specified cop(s) and/or cops in the specified departments.

-o/--out

Write output to a file instead of STDOUT.

--[no-]parallel

Use available CPUs to execute inspection in parallel. Default is parallel.

--raise-cop-error

Raise cop-related errors with cause and location. This is used to prevent cops from failing silently. Default is false.

--plugin

Plugin RuboCop extension file (see Loading Plugin Extensions).

-r/--require

Require Ruby file (see Loading Legacy Extensions).

--regenerate-todo

Regenerate the TODO list using the same options as the last time it was generated with --auto-gen-config (generation options can be overridden).

--safe

Run only safe cops.

--safe-auto-correct

Deprecated alias of -a/--autocorrect.

--show-cops

Shows available cops and their configuration. You can use * as a wildcard.

--show-docs-url

Shows URLs for documentation pages of supplied cops.

--stderr

Write all output to stderr except for the autocorrected source. This is especially useful when combined with --autocorrect and --stdin.

-s/--stdin

Pipe source from STDIN. This is useful for editor integration. Takes one argument, a path, relative to the root of the project. RuboCop will use this path to determine which cops are enabled (via eg. Include/Exclude), and so that certain cops like Naming/FileName can be checked.

--editor-mode

Optimize real-time feedback in editors, adjusting behaviors for editing experience. Editors that run RuboCop directly (e.g., by shelling out) encounter the same issues as with --lsp. This option is designed for such editors.

-S/--display-style-guide

Display style guide URLs in offense messages.

-x/--fix-layout

Autocorrect only code layout (formatting) offenses.

-v/--version

Displays the current version and exits.

-V/--verbose-version

Displays the current version plus the version of Parser and Ruby.