From 0868c71d65fae997ad43f5c1704c3de5fa25a81d Mon Sep 17 00:00:00 2001
From: Trinity Pointard <trinity.pointard@insa-rennes.fr>
Date: Sun, 2 Dec 2018 20:01:48 +0100
Subject: [PATCH] Make plm search use cwd if no directory is given and update
 doc

---
 CLI.md     | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 INSTALL.md |  7 +++++++
 2 files changed, 55 insertions(+)

diff --git a/CLI.md b/CLI.md
index 1bc495e..a5b908c 100644
--- a/CLI.md
+++ b/CLI.md
@@ -49,3 +49,51 @@ plm users new --admin -n 'kate' -N 'Kate' --bio "I'm Kate." --email 'kate@plu.me
 - `--email`, `-e`: the email adress of the user.
 - `--password`, `-p`: the password of the user. You probably want to use this option in shell scipts only, since if you don't specify it, the prompt won't show your password.
 - `--admin`, `-a`: makes the user an admin of the instance. Optional, off by default.
+
+## `plm search`
+
+Manage full text search index.
+
+### `plm search init`
+
+Initialize the search index.
+
+**Example:**
+
+```bash
+plm search init -p Plume'
+```
+
+**Arguments:**
+
+- `--path`, `-n`: path to plume working directory.
+- `--force`, `-f`: override any already existing search index.
+
+### `plm search refill`
+
+Refill the search index.
+
+**Example:**
+
+```bash
+plm search refill -p Plume'
+```
+
+**Arguments:**
+
+- `--path`, `-n`: path to plume working directory.
+
+### `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:**
+
+```bash
+plm search unlock -p Plume'
+```
+
+**Arguments:**
+
+- `--path`, `-n`: path to plume working directory.
diff --git a/INSTALL.md b/INSTALL.md
index 7cf19f4..cf2f2af 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -193,6 +193,12 @@ plm instance new
 plm users new --admin
 ```
 
+You will also need to initialise search index
+
+```
+plm search init -p path/to/plume/workingdir
+```
+
 For more information about these commands, and the arguments you can give them, check out [their documentaion](CLI.md).
 
 Finally, you can start Plume with:
@@ -224,6 +230,7 @@ docker-compose run --rm plume diesel database setup
 # Setup your instance
 docker-compose run --rm plume plm instance new
 docker-compose run --rm plume plm users new --admin
+docker-compose run --rm plume plm search init
 
 # Launch your instance for good
 docker-compose up -d