介绍
在使用Gatsby.js 时,我们不断地使用其内置的命令行界面(CLI)。这个必不可少的工具使我们能够执行诸如从初学者创建新项目、通过热重载启动开发服务器以及生成生产等操作建立。这是帮助您使用它的快速参考指南。
安装
如果您尚未执行 的全局安装gatsby-cli
,则需要先执行此操作:
- npm install -g gatsby-cli
随着gatsby-cli
全球的装机量,您现在可以从你的机器上的任何地方运行所有盖茨的命令。现在让我们介绍可用的命令!
创建新项目
该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
: 以链接路径为前缀构建站点。(但前提是您已经pathPrefix
在 Gatsby 配置中进行了设置!) -
-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
:如果您pathPrefix
在 Gatsby 配置中设置了一个值,则使用前缀路径为站点提供服务。
这是一个示例,它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
命令从项目根目录中删除.cache
和public
目录。
- gatsby clean
虽然这个命令可能不是你经常使用的东西,但它仍然是一个方便的快捷方式!有时会发生奇怪的缓存问题,这是一种快速且安全的清除方法。(输入两个单词比输入两个文件夹删除命令更容易,并且没有意外删除错误文件夹的风险。)
REPL 访问
该repl
命令打开对 Gatsby 交互式 REPL ( Read-Eval-Print-Loop ) shell 的访问。
- gatsby repl
该命令的使用远远超出了快速参考文章的范围,但您可以在Gatsby 文档的 REPL 页面中找到完整的使用详细信息。
结论
希望这个简短的指南可以帮助您轻松浏览 Gatsby CLI。适应它很重要,因为您将在 Gatsby 项目中如此频繁地使用它!
如果需要,还可以提供更多信息:
- 官方文档中 的Gatsby CLI页面很棒!
- 在Github上回购的
gatsby-cli
是跟上更新/改变有用。 - Gatsby 团队还创建了一个可打印的备忘单,其中包括最常用的 CLI 命令。