Rake 命令行用法¶ ↑

Rake 通过命令行使用以下方式调用

% rake [options ...]  [VAR=VALUE ...]  [targets ...]

选项包括

name=value

在执行 rake 命令期间将环境变量 name 设置为 value。您可以使用 ENV[‘name’] 来访问该值。

--all (-A)

与 -T 和 -D 选项结合使用，将强制这些选项显示所有任务，即使是没有注释的任务。

--backtrace{=output} (-n)

启用完整的回溯（即，像 –trace 一样，但没有任务跟踪的详细信息）。output 参数是可选的，但如果指定，它将控制回溯输出的发送位置。如果 output 为 stdout，则回溯输出将定向到标准输出。如果 output 为 stderr，或者如果它丢失，则回溯输出将发送到标准错误。

--comments

与 -W 选项结合使用，强制输出仅包含注释的选项。这与 --all 相反。

--describe pattern (-D)

描述任务（匹配可选的 PATTERN），然后退出。

--dry-run (-n)

进行空运行。打印调用的和执行的任务，但实际上不执行任何操作。

--execute code (-e)

执行一些 Ruby 代码并退出。

--execute-print code (-p)

执行一些 Ruby 代码，打印结果，然后退出。

--execute-continue code (-E)

执行一些 Ruby 代码，然后继续正常的任务处理。

--help (-H)

显示一些帮助文本并退出。

--jobs number (-j)

指定允许的最大并发线程数。Rake 将根据需要分配线程，最多达到此最大值。

如果省略，Rake 将尝试估计系统上的 CPU 数量，并将该数字加 4。

并发线程用于执行 multitask 的先决条件。另请参阅 -m 选项，该选项将所有任务转换为多任务。

示例值

(no -j)   : Allow up to (# of CPUs + 4) number of threads
--jobs    : Allow unlimited number of threads
--jobs=1  : Allow only one thread (the main thread)
--jobs=16 : Allow up to 16 concurrent threads

--job-stats level

在运行完成时显示作业统计信息。默认情况下，这将显示请求的活动线程数（来自 -j 选项）以及在任何给定时间处于活动状态的最大线程数。

如果可选的 level 为 history，则任务历史的完整跟踪将显示在标准输出上。

--libdir directory (-I)

将 directory 添加到 require 搜索的目录列表。

--multitask (-m)

将所有任务视为多任务。（‘make/drake’ 语义）

--nosearch (-N)

不要在父目录中搜索 Rakefile。

--prereqs (-P)

显示所有任务及其直接先决条件的列表。

--quiet (-q)

不要回显来自 FileUtils 的命令。

--rakefile filename (-f)

使用 filename 作为 rakefile 的名称。默认的 rakefile 名称为 rakefile 和 Rakefile（其中 rakefile 优先）。如果当前目录中未找到 rakefile，则 rake 将在父目录中搜索匹配项。找到 Rakefile 的目录将成为 Rakefile 中执行的操作的当前目录。

--rakelibdir rakelibdir (-R)

自动导入 RAKELIBDIR 中的任何 .rake 文件。（默认为 ‘rakelib’）

--require name (-r)

在执行 Rakefile 之前 require name。

--rules

跟踪规则解析。

--silent (-s)

与 –quiet 类似，但也禁止显示 ‘in directory’ 公告。

--suppress-backtrace pattern

与正则表达式 pattern 匹配的行将从回溯输出中删除。请注意，–backtrace 选项是完整的，没有这些被抑制的行。

--system (-g)

使用系统范围（全局）rakefile。项目 Rakefile 将被忽略。默认情况下，仅当未找到项目 Rakefile 时，才使用系统范围的 rakefile。在类 Unix 系统上，系统范围的 rake 文件位于 $HOME/.rake 中。在 Windows 系统上，它们存储在 $APPDATA/Rake 中。

--no-system (-G)

使用项目级别的 Rakefile，忽略系统范围（全局）的 rakefile。

--tasks pattern (-T)

显示主要任务及其注释的列表。注释使用 “desc” 命令定义。如果给出了模式，则仅显示与模式匹配的任务。

--trace{=output} (-t)

启用调用/执行跟踪。还会在错误时启用完整的回溯。output 参数是可选的，但如果指定，它将控制跟踪输出的发送位置。如果 output 为 stdout，则跟踪输出将定向到标准输出。如果 output 为 stderr，或者如果它丢失，则跟踪输出将发送到标准错误。

--verbose (-v)

将 Sys 命令回显到标准输出。

--version (-V)

显示程序版本并退出。

--where pattern (-W)

显示与 pattern 匹配的任务以及定义该任务的文件和行号。默认情况下，此选项将显示所有任务，而不仅仅是具有描述的任务。

--no-deprecation-warnings (-X)

不显示弃用警告。

此外，任何形式为 VAR=VALUE 的命令行选项都将被添加到环境哈希 ENV 中，并且可以在 Rakefile 中进行测试。