CLI 参考 - MoPress Doc

本页是 mopress 可执行程序命令行用法的完整参考。日常上手请优先阅读快速开始（Book 模式）或开始（Site 模式），本页仅作查阅之用。

mopress <command>

<command> 缺省或无法识别时，会回退到显示帮助信息，等同于执行 mopress help，不会报错退出。命令分发的完整实现如下：

async fn command_handler() -> Unit {
  let args = @env.args()
  match (if args.length() > 1 { args[1] } else { "" }) {
    "init" => handle_init()
    "build" => handle_build()
    "serve" => handle_serve()
    _ => handle_help()
  }
}

命令	作用
`init`	初始化一个新项目
`build`	构建站点
`serve`	在本地启动开发服务器预览站点
`help`	打印帮助信息

mopress init

对应实现：

fn handle_init() -> Unit raise {
  if @fs.path_exists(@config.file_name) {
    println("Config file already exists, skipping initialization.")
    return
  }
  @fs.write_string_to_file(
    @config.file_name,
    @config.BookConfig::default().to_toml(),
  )
  if !@fs.path_exists("templates") {
    @fs.create_dir("templates")
  }
  if !@fs.path_exists("styles") {
    @fs.create_dir("styles")
  }
  if !@fs.path_exists("scripts") {
    @fs.create_dir("scripts")
  }
  @fs.write_string_to_file("templates/default.html", templates_default_html)
  @fs.write_string_to_file("styles/index.css", styles_index_css)
  @fs.write_string_to_file("scripts/main.js", scripts_main_js)
  println("Initialization complete.")
}

若当前目录下已存在配置文件，会打印提示信息后直接结束，不做任何修改，不会覆盖已有配置。否则会依次写入一份带默认值的配置文件；若模板、样式、脚本三个目录尚不存在，则分别创建；写入默认的模板文件、样式文件与脚本文件。

init 命令是幂等的：对一个已经初始化过的目录重复执行，只会因为配置文件已存在而提前退出，不会产生副作用。但这一判断只检查配置文件是否存在，如果手动删除了模板、样式、脚本目录中的某一个、但保留了配置文件，重新运行 init 并不会补齐这些被删除的目录与文件，因为 handle_init 的逻辑在检测到配置文件存在时会整体短路返回，不会继续往下逐项检查。

mopress build

对应实现：

async fn handle_build() -> Unit {
  load_config() |> run
}

读取当前目录下的配置文件，解析后交给 run 执行完整的 Book 模式构建流程：解析导航结构、生成 404 页面、渲染所有 Markdown 内容并应用模板，最终将结果写入配置中指定的输出目录。构建过程中的任何失败都会中止整个构建。

mopress serve

对应实现：

async fn handle_serve() -> Unit {
  @core.mo_serve(load_config() |> @core.Options::from_config)
}

读取当前目录下的配置文件，转换为构建选项后启动一个本地开发服务器，用于预览站点效果。

mopress help

对应实现：

fn handle_help() -> Unit {
  println(
    (
      #|Usage: mopress <command>
      #|
      #|Commands:
      #|  build    Build the site
      #|  init     Initialize a new project
      #|  serve    Serve the site locally
      #|  help     Print this help message
    ),
  )
}

打印用法说明与四个命令的简要描述。不带任何参数运行 mopress，或者传入一个无法识别的命令，都会得到与显式运行 mopress help 完全相同的输出，这一点在上面“基本用法”一节的 command_handler 实现中可以直接看到：match 的默认分支（_）就是回退到 handle_help()。

以上命令均针对 mopress 这个预置的可执行程序，服务于 Book 模式。Site 模式下并不存在与之对应的固定命令集，构建脚本是一份独立的 MoonBit 程序，通过如下方式运行：

moon run site.mbt <args>

<args> 具体支持哪些子命令、参数，完全取决于在构建脚本的入口函数中如何解析命令行参数，可以参考上面 command_handler 的写法自行实现一套类似的命令分发逻辑，MoPress 本身不对 Site 模式的命令行约定做任何强制规定，具体请阅读开始。

← Prev

Glob 匹配

Api 参考