Argumentos de extensiones en la línea de comandos

Command for managing Blender extensions.

opciones:
-h, --help

show this help message and exit

sub comandos:

Administración de paquetes
list:

Listará todos los paquetes.

sync:

Synchronize with remote repositories.

update:

Upgrade any outdated packages.

install:

Install packages.

install-file:

Instalará un paquete desde un archivo.

remove:

Eliminar paquetes.

Administración de repositorios
repo-list:

Listará los repositorios.

repo-add:

Agregará un repositorio.

repo-remove:

Eliminará un repositorio.

Creación de extensiones
build:

Build a package.

validate:

Validate a package.

server-generate:

Create a listing from all packages.

Administración de paquetes

Sub comando: list

uso:

blender --command extension list [-h] [-s]

List packages from all enabled repositories.

opciones:
-h, --help

show this help message and exit

-s, --sync

Sincronizará la carpeta remota antes de realizar la acción.

Sub comando: sync

uso:

blender --command extension sync [-h]

Download package information for remote repositories.

opciones:
-h, --help

show this help message and exit

Sub comando: update

uso:

blender --command extension update [-h] [-s]

Download and update any outdated packages.

opciones:
-h, --help

show this help message and exit

-s, --sync

Sincronizará la carpeta remota antes de realizar la acción.

Sub comando: install

uso:

blender --command extension install [-h] [-s] [-e] [--no-prefs]
                                    PACKAGES
argumentos posicionales:
PAQUETES:

The packages to operate on (separated by , without spaces).

opciones:
-h, --help

show this help message and exit

-s, --sync

Sincronizará la carpeta remota antes de realizar la acción.

-e, --enable

Enable the extension after installation.

--no-prefs

Treat the user-preferences as read-only, preventing updates for operations that would otherwise modify them. This means removing extensions or repositories for example, wont update the user-preferences.

Sub comando: install-file

uso:

blender --command extension install-file [-h] -r REPO [-e] [--no-prefs]
                                         FILE

Install a package file into a user repository.

argumentos posicionales:
ARCHIVO:

El archivo de los paquetes.

opciones:
-h, --help

show this help message and exit

-r REPO, --repo REPO

El identificador del repositorio.

-e, --enable

Enable the extension after installation.

--no-prefs

Treat the user-preferences as read-only, preventing updates for operations that would otherwise modify them. This means removing extensions or repositories for example, wont update the user-preferences.

Sub comando: remove

uso:

blender --command extension remove [-h] [--no-prefs] PACKAGES

Disable & remove package(s).

argumentos posicionales:
PAQUETES:

The packages to operate on (separated by , without spaces).

opciones:
-h, --help

show this help message and exit

--no-prefs

Treat the user-preferences as read-only, preventing updates for operations that would otherwise modify them. This means removing extensions or repositories for example, wont update the user-preferences.

Administración de repositorios

Sub comando: repo-list

uso:

blender --command extension repo-list [-h]

List all repositories stored in Blender’s preferences.

opciones:
-h, --help

show this help message and exit

Sub comando: repo-add

uso:

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

Agregará un repositorio local o remoto.

argumentos posicionales:
ID:

El identificador del repositorio.

opciones:
-h, --help

show this help message and exit

--name NAME

El nombre a ser mostrado en la interfaz (opcional).

--directory DIRECTORY

The directory where the repository stores local files (optional). When omitted a directory in the users directory is automatically selected.

--url URL

The URL, for remote repositories (optional). When omitted the repository is considered «local» as it is not connected to an external repository, where packages may be installed by file or managed manually.

--access-token ACCESS_TOKEN

The access token to use for remote repositories which require a token.

--source SOURCE

The type of source in (“USER”, “SYSTEM”). System repositories are managed outside of Blender and are considered read-only.

--cache BOOLEAN

Use package cache (default=1).

--clear-all

Clear all repositories before adding, simplifies test setup.

--no-prefs

Treat the user-preferences as read-only, preventing updates for operations that would otherwise modify them. This means removing extensions or repositories for example, wont update the user-preferences.

Sub comando: repo-remove

uso:

blender --command extension repo-remove [-h] [--no-prefs] ID

Remove a repository.

argumentos posicionales:
ID:

El identificador del repositorio.

opciones:
-h, --help

show this help message and exit

--no-prefs

Treat the user-preferences as read-only, preventing updates for operations that would otherwise modify them. This means removing extensions or repositories for example, wont update the user-preferences.

Creación de extensiones

Sub comando: build

uso:

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]

Compilará un paquete en la carpeta actual.

opciones:
-h, --help

show this help message and exit

--source-dir SOURCE_DIR

The package source directory containing a blender_manifest.toml manifest.

De forma predefinida en la carpeta actual.

--output-dir OUTPUT_DIR

La carpeta de salida del paquete.

De forma predefinida en la carpeta actual.

--output-filepath OUTPUT_FILEPATH

The package output filepath (should include a .zip extension).

Defaults to {id}-{version}.zip using values from the manifest.

--valid-tags VALID_TAGS_JSON

Reference a file path containing valid tags lists.

If you wish to reference custom tags a .json file can be used. The contents must be a dictionary of lists where the key matches the extension type.

Por ejemplo:

{"add-ons": ["Ejemplo", "Otro_ejemplo"], "theme": ["Otro_más", "Etiquetas"]}

To disable validating tags, pass in an empty path --valid-tags="".

--split-platforms

Build a separate package for each platform. Adding the platform as a file name suffix (before the extension).

This can be useful to reduce the upload size of packages that bundle large platform-specific modules (*.whl files).

--verbose

Incluirá mensajes más extensos.

Sub comando: validate

uso:

blender --command extension validate [-h]
                                     [--valid-tags VALID_TAGS_JSON]
                                     [SOURCE_PATH]

Validate the package meta-data in the current directory.

argumentos posicionales:
RUTA_DE_ORIGEN:

The package source path (either directory containing package files or the package archive). This path must containing a blender_manifest.toml manifest.

De forma predefinida en la carpeta actual.

opciones:
-h, --help

show this help message and exit

--valid-tags VALID_TAGS_JSON

Reference a file path containing valid tags lists.

If you wish to reference custom tags a .json file can be used. The contents must be a dictionary of lists where the key matches the extension type.

Por ejemplo:

{"add-ons": ["Ejemplo", "Otro_ejemplo"], "theme": ["Otro_más", "Etiquetas"]}

To disable validating tags, pass in an empty path --valid-tags="".

Sub comando: server-generate

uso:

blender --command extension server-generate [-h] --repo-dir REPO_DIR
                                            [--repo-config REPO_CONFIG]
                                            [--html]
                                            [--html-template HTML_TEMPLATE_FILE]

Generate a listing of all packages stored in a directory. This can be used to host packages which only requires static-file hosting.

opciones:
-h, --help

show this help message and exit

--repo-dir REPO_DIR

The remote repository directory.

--repo-config REPO_CONFIG

An optional server configuration to include information which can’t be detected. Defaults to blender_repo.toml (in the repository directory).

This can be used to defined blocked extensions, for example

schema_version = "1.0.0"

[[blocklist]]
id = "my_example_package"
reason = "Explanation for why this extension was blocked"
[[blocklist]]
id = "other_extenison"
reason = "Another reason for why this is blocked"
--html

Create a HTML file (index.html) as well as the repository JSON to support browsing extensions online with static-hosting.

--html-template HTML_TEMPLATE_FILE

An optional HTML file path to override the default HTML template with your own.

Los claves siguientes serán reemplazados con contenido generado:

  • ${body} is replaced the extensions contents.

  • ${date} is replaced the creation date.