Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

rake (1)

Name

rake - like build utility for Ruby

Synopsis

rake [-f rakefile] [options] targets ...

Description

RAKE(1)                   BSD General Commands Manual                  RAKE(1)

NAME
     rake -- make-like build utility for Ruby

SYNOPSIS
     rake [-f rakefile] [options] targets ...

DESCRIPTION
     rake is a make(1)-like build utility for Ruby.  Tasks and dependencies
     are specified in standard Ruby syntax.

OPTIONS
     -m, --multitask
             Treat all tasks as multitasks.

     -B, --build-all
             Build all prerequisites, including those which are up-to-date.

     -j, --jobs num_jobs
             Specifies the maximum number of tasks to execute in parallel
             (default is number of CPU cores + 4).

   Modules
     -I, --libdir libdir
             Include libdir in the search path for required modules.

     -r, --require module
             Require module before executing rakefile.

   Rakefile location
     -f, --rakefile filename
             Use filename as the rakefile to search for.

     -N, --no-search, --nosearch
             Do not search parent directories for the Rakefile.

     -G, --no-system, --nosystem
             Use standard project Rakefile search paths, ignore system wide
             rakefiles.

     -R, --rakelib rakelibdir, --rakelibdir rakelibdir
             Auto-import any .rake files in rakelibdir (default is `rakelib')

     -g, --system
             Use system-wide (global) rakefiles (usually ~/.rake/*.rake).

   Debugging
     --backtrace=out
             Enable full backtrace.  out can be stderr (default) or stdout.

     -t, --trace=out
             Turn on invoke/execute tracing, enable full backtrace.  out can
             be stderr (default) or stdout.

     --suppress-backtrace pattern
             Suppress backtrace lines matching regexp pattern.  Ignored if
             --trace is on.

     --rules
             Trace the rules resolution.

     -n, --dry-run
             Do a dry run without executing actions.

     -T, --tasks [pattern]
             Display the tasks (matching optional pattern) with descriptions,
             then exit.

     -D, --describe [pattern]
             Describe the tasks (matching optional pattern), then exit.

     -W, --where [pattern]
             Describe the tasks (matching optional pattern), then exit.

     -P, --prereqs
             Display the tasks and dependencies, then exit.

     -e, --execute code
             Execute some Ruby code and exit.

     -p, --execute-print code
             Execute some Ruby code, print the result, then exit.

     -E, --execute-continue code
             Execute some Ruby code, then continue with normal task process-
             ing.

   Information
     -v, --verbose
             Log message to standard output.

     -q, --quiet
             Do not log messages to standard output.

     -s, --silent
             Like --quiet, but also suppresses the `in directory' announce-
             ment.

     -X, --no-deprecation-warnings
             Disable the deprecation warnings.

     --comments
             Show commented tasks only

     -A, --all
             Show all tasks, even uncommented ones (in combination with -T or
             -D)

     --job-stats [level]
             Display job statistics.  If level is `history', displays a com-
             plete job list.

     -V, --version
             Display the program version.

     -h, -H, --help
             Display a help message.


ATTRIBUTES
     See attributes(7) for descriptions of the following attributes:

     +---------------+------------------+
     |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
     +---------------+------------------+
     |Availability   | runtime/ruby-31  |
     +---------------+------------------+
     |Stability      | Uncommitted      |
     +---------------+------------------+

SEE ALSO
     The complete documentation for rake has been installed at
     /usr/share/doc/rake-doc/html/index.html.  It is also available online at
           https://ruby.github.io/rake.

AUTHORS
     rake was written by Jim Weirich <jim@weirichhouse.org>.

     This manual was created by Caitlin Matos <caitlin.matos@zoho.com> for the
     Debian project (but may be used by others).  It was inspired by the man-
     ual by Jani Monoses <jani@iv.ro> for the Ubuntu project.



NOTES
     Source code for open source software components in Oracle Solaris can be
     found at https://www.oracle.com/downloads/opensource/solaris-source-code-
     downloads.html.

     This software was built from source available at https://github.com/ora-
     cle/solaris-userland.  The original community source was downloaded from
     http://cache.ruby-lang.org/pub/ruby/3.1/ruby-3.1.2.tar.gz.

     Further information about this software can be found on the open source
     community website at http://www.ruby-lang.org/.

rake 11.2.2                      June 12, 2016                     rake 11.2.2