Skip to content

Commit 89cee84

Browse files
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>
1 parent 3f0f631 commit 89cee84

2 files changed

Lines changed: 616 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Created by a psychiatry resident who needed a way to get a definitive answer fro
3434
* **Web Search**: Preliminary web search support using [DuckDuckGo](https://en.wikipedia.org/wiki/DuckDuckGo) (via the [ddgs](https://pypi.org/project/ddgs/) library)
3535

3636
### Table of contents
37+
- [Comprehensive reference (SKILL.md)](#comprehensive-reference)
3738
- [Explanatory diagrams](#explanatory-diagrams)
3839
- [Ultra short guide for people in a hurry](#ultra-short-guide-for-people-in-a-hurry)
3940
- [Features](#features)
@@ -47,6 +48,10 @@ Created by a psychiatry resident who needed a way to get a definitive answer fro
4748
- [FAQ](#faq)
4849
- [Roadmap](#roadmap)
4950

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+
5055
## Explanatory diagrams
5156

5257
<p float="left" align="middle">
@@ -196,6 +201,10 @@ Refer to [examples.md](https://github.com/thiswillbeyourgithub/wdoc/blob/main/wd
196201
* Install the `wdoc[full]` version except if you have specific constraints.
197202
* try to install pdftotext with `pip install -U wdoc[pdftotext]` as well as add fasttext support with `pip install -U wdoc[fasttext]`.
198203
* 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:
205+
```bash
206+
mkdir -p ~/.claude/skills/wdoc && wget -O ~/.claude/skills/wdoc/SKILL.md https://raw.githubusercontent.com/thiswillbeyourgithub/wdoc/main/SKILL.md
207+
```
199208
2. Add the API key for the backend you want as an environment variable: for example `export OPENAI_API_KEY="***my_key***"`
200209
3. Launch is as easy as using `wdoc --task=query --path=MYDOC [ARGS]`
201210
* 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

Comments
 (0)