Chapter 07

Gatsby CLI

これまでgatsbyコマンドを用いて来ましたが、ここではあらためて開発時に使う基本的なコマンドについて学んでいきます。

新規プロジェクトを作成する

$ gatsby new <site-name> <starter-url>
引数 説明
site-name プロジェクトのディレクトリ名となります。サイトの名前を設定しましょう。
starter-url 利用するスターターライブラリのURLを指定します。利用しない場合は指定しなくて問題ありません。指定しない場合には、gatsby-starter-defaultとよばれるスターターライブラリが自動的に適用されます。利用可能なスターターライブラリは、こちらにまとまっています。

開発サーバーの立ち上げ

開発時に多用します。おそらく、最も馴染み深いgatsbyコマンドとなるでしょう。
開発用のページのビルドとサーバーの立ち上げを行います。サーバーを立ち上げている間は、ファイルの更新を自動で検知し反映してくれるため、更新のたびにコマンドを停止し再入力する必要はありません。

$ gatsby develop
オプション 説明
-H, --host host名を設定できます。デフォルトはlocalhostになっています。
-p, --port ポートを設定できます。デフォルトは8000 もしくは 環境変数のenv.PORTを読み込みます。
-o, --open サーバーが立ち上がった際にブラウザでページを開けます。

デプロイ用のコンパイル

本番にデプロイする前に使うコマンドです。

$ gatsby build

本番サーバーの立ち上げ

$ gatsby build
オプション 説明
-H, --host host名を設定できます。デフォルトはlocalhostになっています。
-p, --port ポートを設定できます。デフォルトは9000になっています。
-o, --open サーバーが立ち上がった際にブラウザでページを開けます。

キャッシュを削除する

開発時に更新内容が反映されない場合に使います。
内容としては、.cachepublicディレクトリを削除します。

$ gatsby clean

さらに詳しくコマンドについて知りたい方は、公式ドキュメントを参考にしてみてください。

https://www.gatsbyjs.org/docs/gatsby-cli/