コンテンツへスキップ
Lunaria

Lunaria CLI

Lunaria には、ターミナルから Lunaria を使いやすくするための組み込み lunaria コマンドラインインターフェース（CLI）プログラムが付属しています。

以下のコマンドのいずれかを実行し、必要に応じてオプションを追加することで、コマンドのデフォルト動作を変更できます。

ターミナルで lunaria --help と入力すると、利用可能なすべてのコマンドとグローバルオプションを確認できます：

ターミナルウィンドウ
npx lunaria --help

このコマンドは、ターミナルに以下のメッセージを表示します：

ターミナルウィンドウ
lunaria [command] [...options]


コマンド


    build  ダッシュボードとステータスをディスクに出力します。
     init  プロジェクト内で Lunaria を初期化します。
  preview  ビルドされたダッシュボードをローカルでプレビューします。
   stdout  コンソールに設定ファイルとステータスを出力します。
     sync  プロジェクト構造に基づいて設定ファイルのフィールドを同期します。


グローバルオプション


         --help  これに関するヘルプメッセージを表示します。
--config <path>  設定ファイルの場所を指定します。

コマンド

lunaria build

ダッシュボードとステータスをディスクにビルドします。デフォルトでは、ファイルは dist/lunaria に出力され、それぞれ index.html と status.json という名前になります。

オプション

--skip-status

ステータス生成をスキップし、ディスク上に既に存在する最新のステータスを使用します。

ステータスのビルドを待たずにダッシュボードを頻繁に再ビルドしたい場合（例：スタイルの変更をテストする場合）に推奨されます。

lunaria init

プロジェクト内に Lunaria を初期化し、いくつかの質問に答えることで、新しい lunaria.config.json ファイルを作成します。

lunaria preview

lunaria build でビルドされた最新のローカライズダッシュボードを提供するローカルサーバーを開始します。

このコマンドは本番環境での使用を想定していません。本番ホスティングについては、個別のデプロイ手順をご覧ください。

オプション

--port <number>

プレビューサーバーを開くポートを指定します。デフォルトでは 3000 が使用されます。3000 または指定したポートが利用できない場合、ランダムな空いているポートが代わりに使用されます。

lunaria stdout

コンソールに設定情報とステータスを出力します。

このコマンドは、パッケージに依存せずに Lunaria とやり取りしたい場合に適しており、たとえばリポジトリ内の既にセットアップされた Lunaria を使う GitHub Action を構築する際に役立ちます。

lunaria sync

プロジェクトの構造に基づいて、設定ファイルの files、defaultLocale、および/または locales フィールドを同期します。

このコマンドは、プロジェクトの package.json を分析し、一般的に自身の設定ファイルやデフォルトのコンテンツ構造から推測できるパッケージについて、設定を自動的に読み取ります。

lunaria sync で現在サポートされているパッケージは vitepress と @astrojs/starlight です。

オプション

--package <package>

同期対象のパッケージを指定し、同じプロジェクトに複数のサポートパッケージがある場合に選択プロンプトをスキップします。

--skip-questions

設定ファイルの files、defaultLocale、および/または locales フィールドを変更する際の個別確認プロンプトをすべてスキップします。

グローバルオプション

--help

ヘルプメッセージを表示します。

--config <path>

プロジェクトのルートからの相対パスとして、Lunaria の設定ファイルの場所を指定します。デフォルトでは、プロジェクトのルートに lunaria.config.json があることを期待しています。

設定ファイルを他のディレクトリに置くか、異なる名前で使用したい場合は、このオプションを使用してください。