Skip to content

Commit 0e07b75

Browse files
update completions
1 parent 772bfd3 commit 0e07b75

3 files changed

Lines changed: 372 additions & 372 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,9 +192,9 @@ WDoc is a powerful RAG (Retrieval-Augmented Generation) system designed to summa
192192
* `dev` branch: `pip install git+https://github.com/thiswillbeyourgithub/WDoc.git@dev`
193193
* `main` branch: `pip install git+https://github.com/thiswillbeyourgithub/WDoc.git@main`
194194
2. Add the API key for the backend you want as an environement variable: for example `export OPENAI_API_KEY="***my_key***"`
195-
3. Launch using `wdoc query [ARGS]`
195+
3. Launch using `wdoc query [ARGS]` (you can use `WDoc` instead of `wdoc`)
196196
* If for some reason this fails, maybe try with `python -m WDoc`. And if everything fails, clone this repo and try again after `cd` inside it.
197-
* To get shell autocompletion: if you're using zsh: `eval $(cat completion.cli.zsh)` and `eval $(cat completion.m.zsh)`. You can generate your own with `eval "$(wdoc -- --completion)"` and `eval "$(python -m WDoc -- --completion)"`.
197+
* To get shell autocompletion: if you're using zsh: `eval $(cat wdoc_completion.cli.zsh)` and `eval $(cat WDoc_completion.m.zsh)`. You can generate your own with `wdoc -- --completion > my_completion_file"` and `WDoc -- --completion > my_completion_file.2"`.
198198
4. To ask questions about a local document: `wdoc query --path="PATH/TO/YOUR/FILE" --filetype="auto"`
199199
* If you want to reduce the startup time by directly loading the embeddings from a previous run (although the embeddings are always cached anyway): add `--saveas="some/path"` to the previous command to save the generated embeddings to a file and replace with `--loadfrom "some/path"` on every subsequent call.
200200
5. For more: read the documentation at `wdoc --help`

0 commit comments

Comments
 (0)