命令行接口

VuePress 命令行接口是由 @vuepress/cli 包提供的。它包含在 vuepress 包之中，当然你也可以单独安装它。

执行 vuepress --help 来获取下列帮助信息：

  1. Usage:
  2.   $ vuepress <command> [options]
  4. Commands:
  5.   dev [sourceDir]    Start development server
  6.   build [sourceDir]  Build to static site
  7.   info               Display environment information
  9. For more info, run any command with the `--help` flag:
  10.   $ vuepress dev --help
  11.   $ vuepress build --help
  12.   $ vuepress info --help
  14. Options:
  15.   -v, --version  Display version number 
  16.   -h, --help     Display this message

::: tip VuePress 使用了 debug 模块。

设置环境变量 DEBUG=vuepress* 可以启用调试日志。 :::

dev

启动一个开发服务器，在本地开发你的 VuePress 站点。

  1. Usage:
  2.   $ vuepress dev [sourceDir]
  4. Options:
  5.   -c, --config <config>  Set path to config file 
  6.   -p, --port <port>      Use specified port (default: 8080) 
  7.   -t, --temp <temp>      Set the directory of the temporary files 
  8.   --host <host>          Use specified host (default: 0.0.0.0) 
  9.   --cache <cache>        Set the directory of the cache files 
  10.   --clean-temp           Clean the temporary files before dev 
  11.   --clean-cache          Clean the cache files before dev 
  12.   --open                 Open browser when ready 
  13.   --debug                Enable debug mode 
  14.   --no-watch             Disable watching page and config files (default: true)
  15.   -v, --version          Display version number 
  16.   -h, --help             Display this message

::: tip 通过命令行设置的配置项，会覆盖你配置文件中的同名配置项。 :::

build

将你的 VuePress 站点构建成静态文件，以便你进行后续部署。

  1. Usage:
  2.   $ vuepress build [sourceDir]
  4. Options:
  5.   -c, --config <config>  Set path to config file 
  6.   -d, --dest <dest>      Set the directory build output (default: .vuepress/dist) 
  7.   -t, --temp <temp>      Set the directory of the temporary files 
  8.   --cache <cache>        Set the directory of the cache files 
  9.   --clean-temp           Clean the temporary files before build 
  10.   --clean-cache          Clean the cache files before build 
  11.   --debug                Enable debug mode 
  12.   -v, --version          Display version number 
  13.   -h, --help             Display this message

::: tip 通过命令行设置的配置项，会覆盖你配置文件中的同名配置项。 :::

info

输出当前系统和依赖相关的信息。

在你想要检查你的环境，或者提交 Issue 时候，可以使用该命令。