跳转到内容
Lunaria

Lunaria CLI

Lunaria 自带内置的 lunaria 命令行界面（CLI）程序，帮助您在终端中使用 Lunaria。

通过运行以下列出的命令之一来使用 CLI，可选择性地包含任何选项以修改命令的默认行为。

您可以通过在终端中输入 lunaria --help 来查看所有可用命令和全局选项：

Terminal window
npx lunaria --help

此命令将在您的终端窗口中显示以下信息：

Terminal window
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 进行交互，例如构建一个使用仓库中已配置好的 Lunaria 的 GitHub Action。

lunaria sync

根据您的项目结构，同步配置文件中的 files、defaultLocale 和/或 locales 字段。

该命令通过分析项目中的 package.json 来推断 Lunaria 可以识别的配置，通常来自其自身的配置文件或默认内容结构。

目前支持的包包括 vitepress 和 @astrojs/starlight。

选项

--package <package>

指定您想要同步的包，当同一项目中存在多个支持的包时，跳过选择提示。

--skip-questions

跳过对 files、defaultLocale 和/或 locales 字段的所有单独确认提示。

全局选项

--help

打印帮助消息。

--config <path>

指定相对于项目根目录的 Lunaria 配置文件路径。默认情况下，Lunaria 期望在项目根目录下找到 lunaria.config.json 文件。

如果您希望将配置文件放置在其他目录或使用不同名称，请使用此选项。