GatsbyCLI快速参考

来自菜鸟教程
跳转至:导航、​搜索

介绍

在使用 Gatsby.js 时,我们不断利用其内置的 命令行界面 (CLI)。这个必不可少的工具使我们能够做一些事情,例如从初学者创建新项目,启动具有热重载的开发服务器,并生成生产版本。 这是帮助您使用它的快速参考指南。

安装

如果您尚未执行 gatsby-cli 的全局安装,则需要先执行此操作:

npm install -g gatsby-cli

在全局安装 gatsby-cli 后,您现在可以在机器上的任何位置运行 Gatsby 的所有命令。 现在让我们介绍可用的命令!

创建一个新项目

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

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

gatsby new

可用参数:

  • site directory:可选,指定安装目录。
  • starter:可选,可以是 repo URL 或 Github 用户名/repo 字符串。 如果未设置,则自动使用 gatsby-starter-default

这是一个安装到 my-site 文件夹并使用 gatsby-starter-blog 作为启动器的示例:

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

本地开发服务器

develop 命令使用热重载启动本地开发服务器。

gatsby develop

可用选项:

  • -H, --host:设置主机 URL/IP。 默认为 localhost
  • -p, --port:设置应用端口。 默认为 8000
  • -o, --open:在您的(默认)浏览器中自动打开站点。
  • -S, --https:使用 HTTPS。 (可以在这里找到更多信息。)

下面是一个在 http://0.0.0.0:8888 上运行并在浏览器中自动打开的附加示例:

gatsby develop -H 0.0.0.0 -p 8888 -o

生成生产版本

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

gatsby build

可用选项:

  • -prefix-paths:构建带有前缀链接路径的站点。 (但前提是你在 Gatsby 配置中设置了 pathPrefix!)
  • -no-uglify:在不丑化 JavaScript 的情况下构建站点(用于调试。)
  • -open-tracing-config-file:为 OpenTracing 工具设置跟踪器配置文件。 (更多信息请参见 Gatsby 的 性能跟踪 页面。)

这是一个生成带有前缀路径并禁用 uglify 的构建的示例:

gatsby build -prefix-paths -no-uglify

为本地构建服务

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

gatsby serve

可用选项:

  • -H, --host:设置主机地址。 默认为 localhost
  • -p, --port:设置应用端口。 默认为 9000
  • -o, --open:在您的(默认)浏览器中自动打开站点。
  • -prefix-paths:如果您在 Gatsby 配置中设置了 pathPrefix 值,则使用前缀路径为站点提供服务。

这是一个示例,它在 http://10.0.0.1:9999 上提供带有前缀路径的生产构建,并在浏览器中自动打开:

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

获取环境信息

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

gatsby info

可用选项:

  • -C, --clipboard:自动将信息复制到剪贴板。

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

注意: 向 Gatsby 提交官方错误报告时需要此信息。


删除陈旧的缓存/构建

clean 命令从项目根目录中删除 .cachepublic 目录。

gatsby clean

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



REPL 访问

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

gatsby repl

此命令的使用远远超出了快速参考文章的范围,但您可以在 Gatsby 文档的 REPL 页面 中找到完整的使用详细信息。



结论

希望这个简短的指南能帮助您轻松浏览 Gatsby CLI。 熟悉它很重要,因为您会在 Gatsby 项目中频繁使用它!

如果需要,还可以提供更多信息:

  • 官方文档中的 Gatsby CLI 页面很棒!
  • gatsby-cli Github 存储库对于跟上更新/更改很有用。
  • Gatsby 团队还创建了一个可打印的 备忘单 ,其中包括最常用的 CLI 命令。