You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
doc: add comprehensive SKILL.md reference and link it from README
Single-page reference covering all CLI arguments, environment variables,
filetypes, and Python API with examples.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+9Lines changed: 9 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,6 +34,7 @@ Created by a psychiatry resident who needed a way to get a definitive answer fro
34
34
***Web Search**: Preliminary web search support using [DuckDuckGo](https://en.wikipedia.org/wiki/DuckDuckGo) (via the [ddgs](https://pypi.org/project/ddgs/) library)
-[Ultra short guide for people in a hurry](#ultra-short-guide-for-people-in-a-hurry)
39
40
-[Features](#features)
@@ -47,6 +48,10 @@ Created by a psychiatry resident who needed a way to get a definitive answer fro
47
48
-[FAQ](#faq)
48
49
-[Roadmap](#roadmap)
49
50
51
+
## Comprehensive reference
52
+
53
+
A single-page comprehensive reference covering every CLI argument, environment variable, filetype, and the full Python API can be found in **[SKILL.md](./SKILL.md)**.
54
+
50
55
## Explanatory diagrams
51
56
52
57
<pfloat="left"align="middle">
@@ -196,6 +201,10 @@ Refer to [examples.md](https://github.com/thiswillbeyourgithub/wdoc/blob/main/wd
196
201
* Install the `wdoc[full]` version except if you have specific constraints.
197
202
* try to install pdftotext with `pip install -U wdoc[pdftotext]` as well as add fasttext support with `pip install -U wdoc[fasttext]`.
198
203
* If you plan on contributing, you will also need `wdoc[dev]` for the commit hooks.
204
+
***Claude Code users**: to give Claude Code knowledge of `wdoc`'s CLI and Python API, install the [SKILL.md](./SKILL.md) reference file:
2. Add the API key for the backend you want as an environment variable: for example `export OPENAI_API_KEY="***my_key***"`
200
209
3. Launch is as easy as using `wdoc --task=query --path=MYDOC [ARGS]`
201
210
* If for some reason this fails, maybe try with `python -m wdoc`. And if everything fails, try with `uvx wdoc@latest`, or as last resort clone this repo and try again after `cd` inside it? Don't hesitate to open an issue.
0 commit comments