扩展的命令行参数¶
用于管理 Blender 扩展的命令。
- 选项：
- -h, --help
显示帮助信息然后退出
子命令：
包管理¶
子命令：list¶
用法:
blender --command extension list [-h] [-s]
从所有启用的存储库列出包。
- 选项：
- -h, --help
显示帮助信息然后退出
- -s, --sync
在执行动作之前同步远程目录。
子命令：sync¶
用法:
blender --command extension sync [-h]
下载远程存储库的包信息。
- 选项：
- -h, --help
显示帮助信息然后退出
子命令：update¶
用法:
blender --command extension update [-h] [-s]
下载并更新任意过时的包。
- 选项：
- -h, --help
显示帮助信息然后退出
- -s, --sync
在执行动作之前同步远程目录。
子命令：install¶
用法:
blender --command extension install [-h] [-s] [-e] [--no-prefs]
PACKAGES
- 位置参数：
- PACKAGES:
要操作的软件包（用
,分隔，不要有空格）。
- 选项：
- -h, --help
显示帮助信息然后退出
- -s, --sync
在执行动作之前同步远程目录。
- -e, --enable
在安装后启用扩展。
- --no-prefs
将用户偏好设置视为只读，防止对其进行修改操作。这意味着删除扩展或存储库等操作不会更新用户设置。
子命令：install-file¶
用法:
blender --command extension install-file [-h] -r REPO [-e] [--no-prefs]
FILE
安装一个包文件到用户存储库。
- 位置参数：
- FILE:
包文件。
- 选项：
- -h, --help
显示帮助信息然后退出
- -r REPO, --repo REPO
存储库标识符。
- -e, --enable
在安装后启用扩展。
- --no-prefs
将用户偏好设置视为只读，防止对其进行修改操作。这意味着删除扩展或存储库等操作不会更新用户设置。
子命令：remove¶
用法:
blender --command extension remove [-h] [--no-prefs] PACKAGES
禁用 & 移除包。
- 位置参数：
- PACKAGES:
要操作的软件包（用
,分隔，不要有空格）。
- 选项：
- -h, --help
显示帮助信息然后退出
- --no-prefs
将用户偏好设置视为只读，防止对其进行修改操作。这意味着删除扩展或存储库等操作不会更新用户设置。
存储库管理¶
子命令：repo-list¶
用法:
blender --command extension repo-list [-h]
列出所有保存在 Blender 偏好设置里的存储库。
- 选项：
- -h, --help
显示帮助信息然后退出
子命令：repo-add¶
用法:
blender --command extension repo-add [-h] [--name NAME]
[--directory DIRECTORY]
[--url URL]
[--access-token ACCESS_TOKEN]
[--source SOURCE]
[--cache BOOLEAN] [--clear-all]
[--no-prefs]
ID
添加新的本地或远程存储库。
- 位置参数：
- ID:
存储库标识符。
- 选项：
- -h, --help
显示帮助信息然后退出
- --name NAME
要显示在界面内的名称（可选）。
- --directory DIRECTORY
存储库的本地文件目录（可选）。如果省略，将自动选择用户目录中的一个。
- --url URL
远程存储库的 URL（可选）。省略后，存储库将被视为 “本地” 库，因为它没有连接到外部源，软件包可以通过文件安装或手动管理。
- --access-token ACCESS_TOKEN
用于需要访问令牌的远程存储库的访问令牌。
- --source SOURCE
来源的类型（'USER'、'SYSTEM'）。系统代码库由 Blender 外部管理，且仅支持只读访问。
- --cache BOOLEAN
使用包缓存（默认为 1）。
- --clear-all
添加前清除所有存储库，可简化测试设置。
- --no-prefs
将用户偏好设置视为只读，防止对其进行修改操作。这意味着删除扩展或存储库等操作不会更新用户设置。
子命令：repo-remove¶
用法:
blender --command extension repo-remove [-h] [--no-prefs] ID
移除一个存储库。
- 位置参数：
- ID:
存储库标识符。
- 选项：
- -h, --help
显示帮助信息然后退出
- --no-prefs
将用户偏好设置视为只读，防止对其进行修改操作。这意味着删除扩展或存储库等操作不会更新用户设置。
扩展创建¶
子命令：build¶
用法:
blender --command extension build [-h] [--source-dir SOURCE_DIR]
[--output-dir OUTPUT_DIR]
[--output-filepath OUTPUT_FILEPATH]
[--valid-tags VALID_TAGS_JSON]
[--split-platforms] [--verbose]
在当前目录下构建一个包。
- 选项：
- -h, --help
显示帮助信息然后退出
- --source-dir SOURCE_DIR
包含
blender_manifest清单的包来源目录。默认为当前目录。
- --output-dir OUTPUT_DIR
包输出目录。
默认为当前目录。
- --output-filepath OUTPUT_FILEPATH
包输出文件路径（需包含一个
.zip扩展名）。默认为
{id}-{version}.zip，使用清单中的值。- --valid-tags VALID_TAGS_JSON
引用包含有效标签列表的文件路径。
如需引用自定义标签，可使用
.json文件。内容必须为列表字典，其中key与扩展类型相匹配。- 例如：
{"add-ons": ["Example", "Another"], "theme": ["Other", "Tags"]}
如需禁用标签验证，请输入空路径
--valid-tags=""。- --split-platforms
为每个平台构建独立的包。将平台名称作为文件名后缀添加（扩展名之前）。
这对于减小捆绑大型平台特定模块（
*.whl文件）的包上传体积具有实用价值。- --verbose
Include verbose output.
子命令：validate¶
用法:
blender --command extension validate [-h]
[--valid-tags VALID_TAGS_JSON]
[SOURCE_PATH]
验证当前目录中的包元数据。
- 位置参数：
- SOURCE_PATH:
包的源路径（包含包的文件目录或包的归档文件）。该路径必须包含一个
blender_manifest.toml清单。默认为当前目录。
- 选项：
- -h, --help
显示帮助信息然后退出
- --valid-tags VALID_TAGS_JSON
引用包含有效标签列表的文件路径。
如需引用自定义标签，可使用
.json文件。内容必须为列表字典，其中key与扩展类型相匹配。- 例如：
{"add-ons": ["Example", "Another"], "theme": ["Other", "Tags"]}
如需禁用标签验证，请输入空路径
--valid-tags=""。
子命令：server-generate¶
用法:
blender --command extension server-generate [-h] --repo-dir REPO_DIR
[--repo-config REPO_CONFIG]
[--html]
[--html-template HTML_TEMPLATE_FILE]
生成目录中存储的所有包列表。这适用于仅需静态文件托管的包部署场景。
- 选项：
- -h, --help
显示帮助信息然后退出
- --repo-dir REPO_DIR
远程存储库目录。
- --repo-config REPO_CONFIG
一种可选的服务器配置，用于包含无法检测到的信息。默认值为
blender_repo.toml（位于存储库目录中）。这可用于定义被阻止的扩展，例如
schema_version = "1.0.0" [[blocklist]] id = "my_example_package" reason = "Explanation for why this extension was blocked" [[blocklist]] id = "other_extension" reason = "Another reason for why this is blocked"
- --html
创建 HTML 文件（
index.html）及支持静态托管在线浏览扩展的存储库 JSON 文件。- --html-template HTML_TEMPLATE_FILE
可选 HTML 文件路径，用于用自定义模板覆盖默认 HTML 模板。
The following keys will be replaced with generated contents:
${body}将替换扩展内容。${date}将替换创建日期。