You can see these help messages with plm --help
or plm COMMAND --help
(where COMMAND
is the specific subcommand you are interested in).
Wenn ein benötigtes Argument übertragen wird, wirst du aufgefordert es manuell einzugeben.
plm-Instanz
Instanzen verwalten.
plm instance new
Neue lokale Instanz erstellen.
Beispiel:
plm instance new --private --domain plu.me --name 'My Plume Instance' -l 'CC-BY'
Argumente:
--domain
,-d
: der Domain-Name, auf dem Ihre Instanz verfügbar sein wird.--name
,-n
: Der Name Ihrer Instanz. Es wird auf der Homepage angezeigt.--default-license
,-l
: die Lizenz für Artikel, die in dieser Instanz geschrieben werden, wenn keine andere Lizenz explizit angegeben ist. Optional, Standard ist CC-BY-SA.--private
,-p
: Wenn dieses Argument vorhanden ist, wird die Registrierung auf dieser Instanz’nicht möglich sein. Optional, standardmäßig deaktiviert.
Umgebungsvariablen:
BASE_URL
wird als Fallback verwendet, wenn--domain
nicht angegeben ist.
plm Benutzer
Benutzer verwalten.
plm users new
Erstellt einen neuen Benutzer in dieser Instanz.
Beispiel:
plm users new --admin -n 'kate' -N 'Kate' --bio "I'm Kate." --email 'kate@plu.me'
Argumente:
--name
,--username
,-n
: der Name dieses Benutzers. Sie wird als Mensch lesbarer Identifikator in URLs, für die Föderation und bei der Erwähnung dieser Person verwendet. Es kann’nicht danach geändert werden.--display-name
,-N
: Der Anzeigename dieses Benutzers, der überall auf der Schnittstelle angezeigt wird.--name
,--username
,-n
: der Name dieses Benutzers. Optional, standardmäßig deaktiviert.--email
,-e
: die E-Mail-Adresse des Benutzers.--email
,-e
: die E-Mail-Adresse des Benutzers. Sie möchten diese Option wahrscheinlich nur in Shell scipts verwenden, da der Prompt’es nicht angibt,’kein Passwort zeigt.--admin
,-a
: macht den Benutzer zu einem Administrator der Instanz. Optional, standardmäßig deaktiviert.
plm users reset-password
Resets user password.
Beispiel:
plm users reset-password -u 'alice' -p 'top_secret'
Argumente:
--user
,-p
: the username of the person which will have their password reset (no@
before, not the display name).--password
,-p
: the new password of the user. Sie möchten diese Option wahrscheinlich nur in Shell scipts verwenden, da der Prompt’es nicht angibt,’kein Passwort zeigt.
plm Suche
Manage search index.
plm search init
Initialize Plume’s internal search engine.
Beispiel:
plm search init -p Plume
Argumente:
--path
,-p
: path to Plume’s working directory.
plm search refill
Regenerates the search index.
Beispiel:
plm search refill -p Plume
Argumente:
--path
,-p
: path to Plume’s working directory.
plm search unlock
Entfernen Sie die Sperre auf dem Suchindex, nach abnormalen Abbruch wie z. B. durch einen Stromausfall. Machen Sie dies nur, wenn sie wissen das kein anderer Prozessor den Index verwendet.
Beispiel:
plm search unlock -p Plume
Argumente:
--path
,-p
: path to Plume’s working directory.
plm Migration
Migration verwalten.
plm migration run
Migration ausführen.
Beispiel:
plm migration run -p Plume
Argumente:
--path
,-p
: path to Plume’s working directory.
plm migration redo
Lasse die letzte Migration nochmal durchlaufen.
Beispiel:
plm migration redo -p Plume
Argumente:
--path
,-p
: path to Plume’s working directory.