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.

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 search

Manage full text search index.

plm search init

Initialize the search index.

Example:

plm search init -p Plume'

Arguments:

plm search refill

Refill 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: