CLIリファレンス

Astro が提供するコマンドラインインターフェイス (CLI) を使用して、ターミナルウィンドウからプロジェクトの開発、ビルド、およびプレビューを行うことができます。

CLIを使用するには、このページに記載されているコマンドのいずれかを実行し、任意でいずれかのフラグを付与します。フラグはコマンドの動作をカスタマイズします。例えば、ポート 8080 で開発サーバーを起動するには、astro dev コマンドと --port フラグを astro dev --port 8080 のように組み合わせます.

ほとんどの場合、CLI はパッケージマネージャー経由で使用されます。

npx astro dev --port 8080

pnpm astro dev --port 8080

yarn astro dev --port 8080

もし create astro ウィザード を使ってプロジェクトを開始した場合、これらのコマンドの短縮版として package.json にあるスクリプトも使用することができます。どのコマンドが利用できるかを詳しく知りたい場合は、プロジェクトにある README.md をご確認ください。

# `package.json` にある `start` というスクリプトを使用して8080番ポートで開発サーバーを起動します
pnpm start --port 8080

# `package.json` にある `start` というスクリプトを使用して8080番ポートで開発サーバーを起動します
yarn start --port 8080

# `package.json` にある `start` というスクリプトを使用して8080番ポートで開発サーバーを起動します
npm run start -- --port 8080

Astro の開発サーバーを起動します。これはアセットをバンドルしないローカルの HTTP サーバーです。ホットモジュールリプレースメント (HMR) を使用して、エディターで変更を保存した際にブラウザを更新させます。

Astro の開発サーバーの動作をカスタマイズするためにこれらのフラグを使用してください。他の Astro のコマンドと共通しているフラグについては、下記の共通のフラグをご覧ください。

どのポートで起動するかを指定します。デフォルト値は 3000 です。

開発サーバーが起動しているネットワーク IP アドレス (例: localhost でない IP アドレス) を設定します。これは開発時にモバイルフォンのようなローカルの端末でプロジェクトをテストするのに便利です。

• --host - LAN やパブリックのアドレスを含むすべてのアドレスでリッスンします
• --host <指定するアドレス> - <指定するアドレス> のネットワーク IP アドレスを公開します

サイトをデプロイ用にビルドします。デフォルトでは、静的ファイルを生成し、dist/ ディレクトリに配置します。SSRが有効な場合には、サイトに必要なサーバーのファイルを生成します。

ビルドをカスタマイズするためにこれらのフラグを使用してください。他の Astro のコマンドと共通しているフラグについては、下記の共通のフラグをご覧ください。

Markdownの下書きページをビルドに含めます。

静的な dist/ ディレクトリを配信するためのローカルのファイルのサーバーを起動します。

このコマンドはデプロイ前に静的ビルドをローカルでプレビューするのに便利です。本番環境で実行するよう設計されていません。本番環境のホスティングについて知りたい方は、AstroのWebサイトをデプロイするためのガイドをご覧ください。

下記の共通のフラグと組み合わせることができます。

プロジェクトに対して診断機能 (.astro ファイル内の型チェックなど) を実行し、コンソールにエラーを報告します。もし何かエラーがあれば、終了ステータス 1 でプロセスが終了します。

このコマンドは CI ワークフローで使用されることを想定しています。

📚 詳しくはAstro の TypeScript サポートをお読みください。

設定にインテグレーションを追加します。詳しくはインテグレーションガイドをご覧ください。

ターミナルから Astro のドキュメントの Web サイトを直接起動します。

現在の CLI のユーザーに対してテレメトリーの設定を行います。テレメトリーは Astro チームが Astro のどの機能がもっともよく使われているかの調査を提供する匿名のデータです。

テレメトリーは以下の CLI コマンドから無効にすることができます。

astro telemetry disable

テレメトリーは次のようにして後から再び有効にできます。

astro telemetry enable

clear コマンドはテレメトリーのデータをリセットします。

astro telemetry clear

プロジェクトルートのパスを指定します。もし何も指定されなければ現在の作業ディレクトリがルートとみなされます。

ルートは Astro の設定ファイルを見つけるのに使用されます。

astro --root myRootFolder/myProjectFolder dev

プロジェクトルートからの相対パスで設定ファイルのパスを指定します。デフォルト値は astro.config.mjs です。異なる名前の設定ファイルを使用する場合や別のフォルダに設定ファイルがある場合はこのフラグを使用してください。

astro --config config/astro.config.mjs dev

詳細なログを有効にします。これは問題をデバッグするのに有用です。

サイレントなロギングを有効にし、コンソールの出力なしでサーバーが実行されます。

astro の CLI についての情報を取得するためにはこれらのフラグを使用してください。

Astro のバージョン番号を出力し、終了します。

ヘルプのメッセージを出力し、終了します。