Copy page

• Copy page
• View source

📜 CLI 参考手册

本页面提供可用命令的快速参考。使用此手册可快速查阅命令及其用法，无需深入详细文档。

Command	描述	参数/选项
🔍 check	Check project requirements and metadata.	无参数。
📑 update	Update project metadata changes.	无参数。
🔗 link	将生成的资源包链接至 Minecraft。详细信息参见此文档。	[world], --minecraft, --data-pack, --resource-pack - 指向对应目录的路径。
📝 docs build	构建静态 HTML 文档。	[output] - 构建目录（可选，默认值 _build）
📝 docs watch	构建并实时预览文档。	[output] - 构建目录（可选，默认值 _build）
📖 examples build	构建指定示例。	[examples...] - 需构建的示例列表（可选）
📖 examples watch	监听变更并自动重建指定示例。	[examples...] - 需监听的示例列表（可选）
🧩 modules build	构建指定模块。	[modules...] - 需构建的模块列表（可选）
🧩 modules release	构建用于发布的模块压缩包。	无参数。
🧩 modules test	构建并测试指定模块。	[modules...] - 需测试的模块列表（可选）
🧩 modules watch	监听变更并自动重建指定模块。	[modules...] - 需监听的模块列表（可选）

To run any command, type uv run before the command itself. Alternatively, you can activate the virtual environment (venv) manually and run the command directly. Some commands also have aliases:

别名	等效命令
uv run build	uv run modules build
uv run watch	uv run modules watch