Command-Line Options

Reek is invoked using command-lines of the form:

$ reek [options] files...

That is, the name of the tool (reek), optionally followed by any number of configuration switches, followed by any number of source file names.

Source Code

If the Ruby code you want to check is held in source files,, invoke Reek like this:

$ reek lib/*.rb

But occasionally you may want to quickly check a code snippet without going to the trouble of creating a file to hold it. You can pass the snippet directly to Reek’s standard input:

$ echo "def x() true end" | reek
$stdin -- 1 warning:
  x has the name 'x' (Uncommunicative Name)

Options

The Reek command-line tool has the following options:

Short form	Long form	Description
-a	--show-all --no-show-all	Show all smells, including those masked by Configuration Files (off by default)
-h	--help	Show this message and exit
-q	--quiet	Don’t display the names of files that have no smells
-v	--version	Display the version of Reek and exit