简介

在使用Gatsby.js，)时，我们经常使用其内置的命令行interface(CLI.)这个基本的工具允许我们做一些事情，比如从初学者创建新项目、启动带有热重新加载的开发服务器以及生成生产构建。这里有一个快速参考指南，帮助您使用它。

安装

如果您还没有进行gatsby-cli的全局安装，则需要先进行全局安装：

1npm install -g gatsby-cli

在全球安装了gatsby-cli后，您现在可以在您的计算机上的任何位置运行Gatsby的所有命令。现在，让我们来介绍一下可用的命令！

新建工程

new命令创建一个新的Gatsby站点，安装它的所有依赖项，并使用初始提交在本地初始化一个新的Git存储库。

不带参数运行命令将提示输入文件夹名称和可选启动器：

1gatsby new

可用参数：

• 站点目录：可选，指定安装目录。
• starter：可选参数，可以是repo URL，也可以是Github用户名/repo字符串。如果未设置此项，则会自动使用gatsby-starter-default。

下面是一个安装到my-site文件夹中的示例，并使用gatsby-starter-blog作为启动：

1gatsby new my-site gatsbyjs/gatsby-starter-blog

本地开发服务器

Development命令用于启动本地开发服务器并进行热重载。

1gatsby develop

可选选项：

• -H，--Host：设置主机URL/IP。默认为本地主机。
• -p，--port：设置应用端口。默认为8000。
• -o，--Open：在您的默认浏览器中自动打开站点。
• -S，--HTTPS：使用HTTPS。(有关这方面的更多信息，请访问here.)

这里还有一个在http://0.0.0.0:8888上运行并在浏览器中自动打开的示例：

1gatsby develop -H 0.0.0.0 -p 8888 -o

生成生产版本

Build命令编译您的站点以进行生产就绪部署。

1gatsby build

可选：

• -prefix-paths：构建带有链接路径前缀的站点。(但前提是您在Gatsby配置中设置了pathPrefix！)
• -no-uglify：构建站点时不会丑化JavaScript(便于调试)。
• -打开-跟踪-配置-文件：设置打开跟踪工具)的跟踪器配置文件。(更多信息请访问盖茨比的Performance Tracing页面。)

下面是一个生成带有前缀路径并禁用了uglify的构建的示例：

1gatsby build -prefix-paths -no-uglify

为本地生产建设服务

serve命令在本地运行生产构建，这有助于测试和调试。(You当然，必须在运行此命令之前运行build命令。

1gatsby serve

可选：

• -H，--Host：设置主机地址。默认为本地主机。
• -p，--port：设置应用端口。默认为9000。
• -o，--Open：在您的默认浏览器中自动打开站点。
• -prefix-paths：如果您在Gatsby配置中设置了pathPrefix值，则为站点提供前缀路径。

下面是一个为http://10.0.0.1:9999上的产品版本提供服务的示例，该版本带有前缀路径，并在浏览器中自动打开：

1gatsby serve -H 10.0.0.1 -p 9999 -prefix-paths -o

获取环境信息

info命令显示有关Gatsby项目的环境信息。

1gatsby info

可选：

• -C，--剪贴板：自动将信息复制到您的剪贴板。

运行此命令将返回一个对象，其中包括您的操作系统、CPU类型、Yarn/NPM版本、安装的语言、浏览器和安装的NPM包。

<$>[备注]备注： 向Gatsby提交官方错误报告时需要此信息。<$>

移除陈旧缓存/构建

lean命令用于从您的项目根目录中删除.cache和Public目录。

1gatsby clean

虽然这个命令可能不是你经常使用的东西，但它仍然是一个方便的快捷方式！有时会发生奇怪的缓存问题，这是一种快速安全的清除方法。（键入两个单词比键入两个文件夹删除命令更容易，并且没有意外删除错误文件夹的风险。)

REPL访问

命令打开对Gatsby的交互式REPL(Read-Eval-Print-Loop)外壳的访问。

1gatsby repl

此命令的使用远远超出了快速参考文章的范围，但您可以在Gatsby Documentation的REPL page.]中找到完整的用法详细信息

总结

希望这篇简短的指南能帮助您轻松浏览Gatsby CLI。熟悉它是很重要的，因为您将在Gatsby项目中频繁使用它！

如果需要，还可以获得更多信息：

• 官方文档中的盖茨比CLI页面太棒了！
• gatsby-cli的[Github回购]有助于跟上更新/更改。
• 盖茨比团队还创建了一个可打印的作弊sheet，]，其中包括最常用的命令行界面命令。