Référence de l'outil plm

Vous pouvez voir ces messages d'aide avec plm --help ou plm COMMAND --help (où COMMAND est la sous-commande spécifique qui vous intéresse).

Si un argument requis est omis, il vous sera demander de l'entrer manuellement.

plm instance

Gérer une instance.

plm instance new

Créer une nouvelle instance locale.

Exemple:

plm instance new --private --domain plu.me --name 'Mon Instance Plume' -l 'CC-BY'

Arguments:

• --domain, -d: le nom de domaine sur lequel l'instance sera disponible.
• --name, -n: Le nom de votre instance. Il sera afficher sur la page d'accueil.
• --default-license, -l: la licence à utiliser pour les articles écrits sur cette instance, si aucune autre licence n'est spécifiée explicitement. Optionnel, vaut CC-BY-SA par défaut.
• --private, -p: si cette argument est présent, s'enregistrer sur l'instance ne sera pas possible. Optionnel, désactivé par défaut.

Variables d’environnement:

• BASE_URL sera utiliser si --domain n'est pas spécifié.

plm users

Gérer les utilisateurs.

plm users new

Créer un. e nouvel.le utilisateur.ice sur cette instance.

Exemple:

plm users new --admin -n 'kate' -N 'Kate' --bio "Je suis Kate." --email 'kate@plu.me'

Arguments:

• --name, --username, -n: le nom de cette utilisateurice. Il sera utilisé comme identifiant lisible par les humains dans les URLs, pour la fédération et lors de la mention de cette personne. Il ne peut être changé plus tard.
• --display-name, -N: le nom de l'utilisateur, qui sera affiché partout sur l'interface.
• --bio, --biography, -b: la biographie de cet.te utilisateurice. Optionnel, vide par défaut.
• --email, -e: adresse mail de cet.te utilisateurice.
• --password, -p: le mot de passe de l'utilisateur. Cette option est surtout utile dans les scripts shell, car si vous ne la spécifiez pas l'invite n'affichera pas votre mot de passe.
• --admin, -a: fait de l'utilisateur un administrateur de l'instance. Optionnel, désactivé par défaut.

plm users reset-password

Réinitialiser le mot de passe de l'utilisateur.ice.

Exemple:

plm users reset-password -u 'alice' -p 'top_secret'

Arguments:

• --user, -p: le nom d'utilisateur.ice de la personne qui aura son mot de passe réinitialisé (pas de @ avant, pas le nom affiché).
• --password, -p: le nouveau mot de passe de l'utilisateur.ice. Cette option est surtout utile dans les scripts shell, car si vous ne la spécifiez pas l'invite n'affichera pas votre mot de passe.

plm search

Gérer l'index de recherche.

plm search init

Initialiser le moteur de recherche interne de Plume.

Exemple:

plm search init -p Plume

Arguments:

• --path, -p: chemin vers le répertoire de travail de Plume.

plm search refill

Régénèrer l'index de recherche.

Exemple:

plm search refill -p Plume

Arguments:

• --path, -p: chemin vers le répertoire de travail de Plume.

plm search unlock

Retirer le verrou sur l'index de recherche après une terminaison anormale (coupure de courant…). Ne faites cela que si vous savez qu'aucun processus n'utilise actuellement l'index.

Exemple:

plm search unlock -p Plume

Arguments:

• --path, -p: chemin vers le répertoire de travail de Plume.

plm migration

Gérer les migrations.

plm migration run

Effectuer les migrations.

Exemple:

plm migration run -p Plume

Arguments:

• --path, -p: chemin vers le répertoire de travail de Plume.

plm migration redo

Relancer la dernière migration.

Exemple:

plm migration redo -p Plume

Arguments:

• --path, -p: chemin vers le répertoire de travail de Plume.