Arguments de la ligne de commande des extensions

Commande pour gérer les extensions Blender.

options:

-h, --help

Afficher ce message d’aide et quitter.

sous-commandes :

Gestion des paquets

list:

Répertorier tous les packages.

sync:

Synchroniser avec les dépots distants.

update:

Mettre à niveau tous les packages obsolètes.

install:

Installer les packages.

install-file:

Installer le package à partir du fichier.

remove:

Supprimer des packages.

Repository Management

repo-list:

Répertorier les dépôts.

repo-add:

Ajouter un dépôt.

repo-remove:

Supprimer le dépôt.

Création d’extensions

build:

Créer un package.

validate:

Valider un package.

server-generate:

Créer une liste de tous les packages.

Package Management

Sous-commande: list

usage:

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

Répertorier les packages de tous les dépôts activés.

options:

-h, --help

Afficher ce message d’aide et quitter.

-s, --sync

Définir le terme avant de fournir toute autre information.

Sous-commande: sync

usage:

blender --command extension sync [-h]

Télécharger les informations sur le package pour les dépôts distants.

options:

-h, --help

Afficher ce message d’aide et quitter.

Sous-commande: update

usage:

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

Télécharger et mettre à jour tous les packages obsolètes.

options:

-h, --help

Afficher ce message d’aide et quitter.

-s, --sync

Définir le terme avant de fournir toute autre information.

Sous-commande: install

usage:

blender --command extension install [-h] [-s] [-e] [--no-prefs]
                                    PACKAGES

positional arguments:

PACKAGES:

Les packages sur lesquels opérer (séparés par , sans espaces).

options:

-h, --help

Afficher ce message d’aide et quitter.

-s, --sync

Définir le terme avant de fournir toute autre information.

-e, --enable

Activer l’extension après l’installation.

--no-prefs

Traiter les préférences utilisateur en lecture seule, empêchant les mises à jour pour les opérations qui autrement les modifieraient. Cela signifie supprimer des extensions ou des dépôts par exemple, cela ne mettra pas à jour les préférences utilisateur.

Sous-commande: install-file

usage:

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

Installer un fichier de package dans un dépôt utilisateur.

positional arguments:

FILE:

Le fichier des packages.

options:

-h, --help

Afficher ce message d’aide et quitter.

-r REPO, --repo REPO

L’identifiant du dépôt.

-e, --enable

Activer l’extension après l’installation.

--no-prefs

Traiter les préférences utilisateur en lecture seule, empêchant les mises à jour pour les opérations qui autrement les modifieraient. Cela signifie supprimer des extensions ou des dépôts par exemple, cela ne mettra pas à jour les préférences utilisateur.

Sous-commande: remove

usage:

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

Désactiver et supprimer un/des package(s).

positional arguments:

PACKAGES:

Les packages sur lesquels opérer (séparés par , sans espaces).

options:

-h, --help

Afficher ce message d’aide et quitter.

--no-prefs

Traiter les préférences utilisateur en lecture seule, empêchant les mises à jour pour les opérations qui autrement les modifieraient. Cela signifie supprimer des extensions ou des dépôts par exemple, cela ne mettra pas à jour les préférences utilisateur.

Repository Management

Sous-commande: repo-list

usage:

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

Lister tous les dépôts stockés dans les préférences de Blender.

options:

-h, --help

Afficher ce message d’aide et quitter.

Sous-commande: repo-add

usage:

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

Ajouter un nouveau dépôt local ou distant.

positional arguments:

ID:

L’identifiant du dépôt.

options:

-h, --help

Afficher ce message d’aide et quitter.

--name NAME

Le nom à afficher dans l’interface (facultatif).

--directory DIRECTORY

Le répertoire dans lequel le dépôt stocke les fichiers locaux (facultatif). Lorsqu’il est omis, un répertoire dans le répertoire des utilisateurs est automatiquement sélectionné.

--url URL

L’URL, pour les dépôts distants (facultatif). Lorsqu’il est omis, le référentiel est considéré comme “local” car il n’est pas connecté à un dépôt externe, où les packages peuvent être installés par fichier ou gérés manuellement.

--access-token ACCESS_TOKEN

Le jeton (token) d’accès à utiliser pour les dépôts distants qui en nécessitent un.

--source SOURCE

Le type de source dans (“USER”, “SYSTEM”). Les dépôts système sont gérés en dehors de Blender et sont considérés comme en lecture seule.

--cache BOOLEAN

Utiliser le cache des packages (par défaut=1).

--clear-all

Effacer tous les dépôts avant de les ajouter, simplifie la configuration des tests.

--no-prefs

Traiter les préférences utilisateur en lecture seule, empêchant les mises à jour pour les opérations qui autrement les modifieraient. Cela signifie supprimer des extensions ou des dépôts par exemple, cela ne mettra pas à jour les préférences utilisateur.

Sous-commande: repo-remove

usage:

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

Supprimer un dépôt.

positional arguments:

ID:

L’identifiant du dépôt.

options:

-h, --help

Afficher ce message d’aide et quitter.

--no-prefs

Traiter les préférences utilisateur en lecture seule, empêchant les mises à jour pour les opérations qui autrement les modifieraient. Cela signifie supprimer des extensions ou des dépôts par exemple, cela ne mettra pas à jour les préférences utilisateur.

Création d’extensions

Sous-commande: build

usage:

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]

Construire un package dans le répertoire courant.

options:

-h, --help

Afficher ce message d’aide et quitter.

--source-dir SOURCE_DIR

Le répertoire source du package contenant un manifeste blender_manifest.toml.

Par défaut, c’est le répertoire courant.

--output-dir OUTPUT_DIR

Le répertoire de sortie du package.

Par défaut, c’est le répertoire courant.

--output-filepath OUTPUT_FILEPATH

Le chemin du fichier de sortie du package (doit inclure une extension .zip).

La valeur par défaut est {id}-{version}.zip en utilisant les valeurs du manifeste.

--valid-tags VALID_TAGS_JSON

Référence un chemin de fichier contenant des listes de balises valides.

Si vous souhaitez référencer des balises personnalisées, un fichier .json peut être utilisé. Le contenu doit être un dictionnaire de listes où key correspond au type d’extension.

Par exemple :

{"add-ons": ["Example", "Another"], "theme": ["Other", "Tags"]}

Pour désactiver la validation des balises, transmettre un chemin vide --valid-tags="".

--split-platforms

Crée un package distinct pour chaque plate-forme. Ajout de la plateforme comme suffixe de nom de fichier (avant l’extension).

Peut être utile pour réduire la taille de téléchargement des packages qui regroupent de gros modules spécifiques à la plateforme (fichiers *.whl).

--verbose

Inclure une sortie verbeuse.

Sous-commande: validate

usage:

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

Valider les métadonnées du package dans le répertoire courant.

positional arguments:

SOURCE_PATH:

Le chemin source du package (soit le répertoire contenant les fichiers du package, soit l’archive du package). Ce chemin doit contenir un manifeste blender_manifest.toml.

Par défaut, le répertoire courant.

options:

-h, --help

Afficher ce message d’aide et quitter.

--valid-tags VALID_TAGS_JSON

Référence un chemin de fichier contenant des listes de balises valides.

Si vous souhaitez référencer des balises personnalisées, un fichier .json peut être utilisé. Le contenu doit être un dictionnaire de listes où key correspond au type d’extension.

Par exemple :

{"add-ons": ["Example", "Another"], "theme": ["Other", "Tags"]}

Pour désactiver la validation des balises, transmettre un chemin vide --valid-tags="".

Sous-commande: server-generate

usage:

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

Générer une liste de tous les packages stockés dans un répertoire. Cela peut être utilisé pour héberger des packages qui nécessitent uniquement un hébergement de fichiers statiques.

options:

-h, --help

Afficher ce message d’aide et quitter.

--repo-dir REPO_DIR

Le répertoire du dépôt distant.

--repo-config REPO_CONFIG

Une configuration de serveur facultative pour inclure des informations qui ne peuvent pas être détectées. La valeur par défaut est blender_repo.toml (dans le répertoire du dépôt).

Peut être utilisé pour définir des extensions bloquées, par exemple.

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

Créer un fichier HTML (index.html) ainsi que le dépôt JSON pour prendre en charge les extensions de navigation en ligne avec un hébergement statique.

--html-template HTML_TEMPLATE_FILE

Un chemin de fichier HTML optionnel pour remplacer le modèle HTML par défaut par le vôtre.

Les clés suivantes seront remplacées par le contenu généré :

• ${body} remplace le contenu de l’extension.

• ${date} remplace la date de création.