plm CLI reference

plm is a little CLI tool that can help you to manage your instance from the command line if you are admin of an instance.

You can see these help messages with plm --help or plm COMMAND --help (where COMMAND is the specific subcommand you are interested in).

If any required argument is ommitted, you will be asked to input manually.

plm instance

Manage instances.

plm instance new

Create a new local instance.

Example:

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

Arguments:

Environment variables:

plm users

Manage users.

plm users new

Creates a new user on this instance.

Example:

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

Arguments:

plm users reset-password

Resets user password.

Example:

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

Arguments:

plm search

Manage search index.

plm search init

Initialize Plume’s internal search engine.

Example:

plm search init -p Plume

Arguments:

plm search refill

Regenerates the search index.

Example:

plm search refill -p Plume

Arguments:

plm search unlock

Remove lock on the search index, after abnormal termination such as power loss. Only do this if you know no processus is currently using the index.

Example:

plm search unlock -p Plume

Arguments:

plm migration

Manage migrations.

plm migration run

Run migrations.

Example:

plm migration run -p Plume

Arguments:

plm migration redo

Rerun latest migration.

Example:

plm migration redo -p Plume

Arguments: