您可以使用 plm --help
或 plm COMMAND --help
查看這些幫助訊息(其中 COMMAND
是您感興趣的特定子命令)
如果省略任何必需的參數,您將被要求手動輸入。
plm 實例
管理實例
plm instance new
建立一個新的本機實例
範例:
plm instance new --private --domain plu.me --name 'My Plume Instance' -l 'CC-BY'
引數:
--domain
,-d
: 你在實例上可使用的域名--name
,-n
: 你實例的名稱 將顯示在主頁上--default-license
,-l
: 用於在實例上發表文章的許可,如果沒有明確其它指定。 可選,默認為 CC-BY-SA。--private
,-p
: 如果存在此參數,則無法在該實例上註冊。 可選,默認為關閉。
環境變數
BASE_URL
將作為備用, 如果--domain
未指定。
plm 使用者
管理使用者
plm users new
在實例上建立一個新使用者
範例:
plm users new --admin -n 'kate' -N 'Kate' --bio "I'm Kate." --email 'kate@plu.me'
引數:
--name
,--username
,-n
: the name of this user. 它將在 URL 中用作人類可讀的識別碼,用於聯邦和提及此人。 之後無法更改--display-name
,-N
:該使用者的顯示名稱,將在介面上顯示。--bio
,--biography
,-b
: 使用者的自我介紹。 可選,預設空白。--email
,-e
: 使用者信箱地址--password
,-p
: 使用者的密碼 你可能只會在shell scipts中使用這選項,如果你未指定它,提示將不會顯示你的密碼。--admin
,-a
: 讓該使用者成為實例管理者。 可選,預設為關閉。
plm users reset-password
重置使用者密碼
範例:
plm users reset-password -u 'alice' -p 'top_secret'
引數:
--user
,-p
: 想要重置密碼的使用者 (no@
之前, 不是顯示名稱).--password
,-p
: 使用者的新密碼 你可能只會在shell scipts中使用這選項,如果你未指定它,提示將不會顯示你的密碼。
plm 搜尋
管理搜尋索引
plm search init
初始化 Plume 的內部搜尋引擎
範例:
plm search init -p Plume
範例:
--path
,-p
: path to Plume’s working directory.
plm search refill
重新建立搜尋索引
範例:
plm search refill -p Plume
引數:
--path
,-p
: path to Plume’s working directory.
解鎖 plm search
異常終止後解除搜尋索引鎖定(例如斷電) 只在你清楚當前沒有處理程序正在使用該索引時才如此做
範例:
plm search unlock -p Plume
參數:
--path
,-p
: path to Plume’s working directory.
plm 遷移
管理遷移
plm 遷移運行
運行遷移
範例:
plm migration run -p Plume
參數:
--path
,-p
: path to Plume’s working directory.
plm 重新遷移
重新運行最新的遷移
範例:
plm migration redo -p Plume
引數:
--path
,-p
: path to Plume’s working directory.