Agent skill

wdoc Reference

by thiswillbeyourgithub in thiswillbeyourgithub/wdoc

Quick reference for wdoc, a command-line and Python tool that summarizes, searches and answers questions over documents of many file types.

AGPL-3.0Auto-check passedAI & LLM Engineering

Install wdoc Reference

skills CLI
$ npx skills add thiswillbeyourgithub/wdoc --skill wdoc-skill -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install thiswillbeyourgithub/wdoc wdoc-skill --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/thiswillbeyourgithub/wdoc.git skills-src && mkdir -p .claude/skills && cp -r skills-src/wdoc-skill .claude/skills/wdoc-skill && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
wdoc-skill
GitHub stars
545
Token cost
~1.1k tokens
SKILL.md length
341 words
Files
3
Skills in repo
1
Repo updated
First seen
Licence
AGPL-3.0

At a glance

Quick reference for wdoc, a command-line and Python tool that summarizes, searches and answers questions over documents of many file types.

  • Running wdoc to query or summarize a PDF, video or web page
  • SKILL.md covers Quick start, The four tasks, Core mechanics worth knowing and Common patterns
  • Calls pip and uvx; needs ANTHROPIC_API_KEY
  • Looking up a wdoc CLI argument, environment variable or filetype

What it does

wdoc is a retrieval-augmented generation tool that handles more than 20 file types, among them PDF, YouTube, audio, Anki, web pages, Zotero and Karakeep, and sends every model call through LiteLLM. This skill is the orientation for wdoc version 5.1.0, with companion files REFERENCE.md and EXAMPLES.md covering every CLI argument, filetype, loader option, environment variable and the Python API.

It explains four tasks: `query` embeds documents, retrieves chunks and answers with sourced markdown; `search` returns matching documents and metadata without an LLM answer; `summarize` writes a detailed markdown summary; and `summarize_then_query` does both in one run. Other notes cover auto-detected filetypes, two models per run (a strong one to answer and a cheaper one to filter chunks), piped input, and a private mode that blocks outbound traffic for use with local models such as Ollama.

When your agent uses it

  • Running wdoc to query or summarize a PDF, video or web page
  • Looking up a wdoc CLI argument, environment variable or filetype
  • Calling wdoc from Python code

Example prompts

  • “Use wdoc to summarize this PDF and give me the result as markdown.”
  • “Query my Zotero library with wdoc and ask which papers discuss retrieval evaluation.”
  • “Show me how to run wdoc in private mode against a local Ollama model.”

Requirements

  • wdoc installed with pip, using the full extras to get every loader, or run through `uvx`
  • An API key for an LLM provider, such as `ANTHROPIC_API_KEY`

What it can do on your machine

Read from SKILL.md and the folder at commit 6a6ae50. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • pip
    • uvx

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use pip and uvx, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names these keys or tokens, usually read from environment variables:

    • ANTHROPIC_API_KEY

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

wdoc Reference loads about 1.1k tokens when it runs. Until then it costs about 116 tokens; SKILL.md has 341 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~116
When it runs · the whole SKILL.md, loaded when a task matches
~1.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from thiswillbeyourgithub/wdoc at commit 6a6ae50, republished under its AGPL-3.0 licence (© thiswillbeyourgithub). 341 words, ~1,106 tokens.

Download SKILL.mdSave it as .claude/skills/wdoc-skill/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.
name
wdoc-skill
description
Comprehensive reference for wdoc, a RAG CLI and Python library that summarizes, searches, and queries documents across 20+ filetypes (PDF, YouTube, audio, Anki, web, Zotero, Karakeep, and more) through LiteLLM (100+ LLM providers). Use when the user runs or asks about the `wdoc` command, imports `from wdoc import wdoc`, or needs help with wdoc tasks (query, search, summarize, parse), CLI arguments, environment variables, filetypes, or the Python API.

wdoc

Written for wdoc v5.1.0. On a different version, some arguments, defaults, or behaviors may differ.

wdoc is a RAG (Retrieval-Augmented Generation) system for summarizing, searching, and querying documents across 20+ file types. It works as a CLI (via Google Fire) and as a Python library (from wdoc import wdoc), routing every LLM call through LiteLLM (100+ providers).

This SKILL.md is the quick orientation. The deep material lives in two companion files:

  • REFERENCE.md: every CLI argument, filetype, loader option, environment variable, and the full Python API.
  • EXAMPLES.md: copy-pasteable shell and Python examples.

Quick start

bash
pip install -U wdoc[full]            # full install: all loaders. Plain `wdoc` ships only PDF + URL.
export ANTHROPIC_API_KEY="your_key"  # or whichever provider you use

wdoc query     paper.pdf "What are the main findings?"   # ask questions (RAG)
wdoc summarize paper.pdf                                  # detailed markdown summary
wdoc parse     paper.pdf                                  # parse to text, no LLM
wdoc web       "latest on quantum computing"             # DuckDuckGo + query

uvx wdoc[full] ... runs it without installing and sidesteps thinking about extras.

The four tasks

TaskWhat it doesPick it when
queryEmbeds docs, retrieves chunks, answers with sourced markdownYou have a question about the content
searchReturns matching docs + metadata, no LLM answerYou only need to locate relevant passages
summarizeDetailed markdown summary (author's reasoning, not vague takeaways)You want the gist of a long document
summarize_then_querySummarize first, then drop into a query promptYou want both, in one run

Core mechanics worth knowing

  • Shortcuts: wdoc query FILE, wdoc summarize FILE, wdoc parse FILE, and wdoc web "q" expand to longer --task=... forms. Positional args work too: wdoc TASK PATH [QUERY].
  • Filetype is auto-detected (--filetype=auto) but can be forced (pdf, youtube, anki, zotero, ...). Recursive filetypes (recursive_paths, zotero, karakeep, ddg, ...) fan one selector out into many documents.
  • Two models per run: a strong --model answers, a cheap --query_eval_model filters chunks. Both take LiteLLM provider/model ids.
  • kebab or snake case: --query-eval-model and --query_eval_model are equivalent.
  • Piped input is auto-detected: cat file.pdf | wdoc parse --filetype=pdf.
  • Privacy: --private (or WDOC_PRIVATE_MODE=true) blocks all outbound traffic and redacts API keys; pair it with local models (Ollama) and --llms_api_bases.
  • Reuse embeddings: --save_embeds_as=idx.pkl once, then --load_embeds_from=idx.pkl to skip re-indexing.
  • Cost guard: --dollar_limit (default 5) stops summaries/embeddings before they get expensive.

Common patterns

bash
# Query every PDF in a tree
wdoc --task=query --path="papers/" --filetype=recursive_paths \
     --pattern="**/*.pdf" --recursed_filetype=pdf --query="..."

# Fully local / private
wdoc --private --model="ollama/qwen3:8b" --query_eval_model="ollama/qwen3:8b" \
     --embed_model="ollama/snowflake-arctic-embed2" --task=query --path=secret.pdf

# Parse for use elsewhere (text, langchain, langchain_dict, xml, split_text)
wdoc parse document.pdf --format=langchain_dict
python
from wdoc import wdoc
instance = wdoc(task="query", path="paper.pdf", model="openai/gpt-4o")
answer = instance.query_task("What are the main contributions?")
print(answer["final_answer"])

For anything beyond this page (exact argument types, defaults, every filetype's loader options, all WDOC_* env vars, the full Python API surface, and more examples), read REFERENCE.md and EXAMPLES.md.

© thiswillbeyourgithub, AGPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 2 other files in wdoc-skill of thiswillbeyourgithub/wdoc.

  • SKILL.md
  • EXAMPLES.md
  • REFERENCE.md

Open the folder on GitHubat commit 6a6ae50

Compare with similar skills

wdoc Reference next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

wdoc Reference compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
wdoc Reference this skillthiswillbeyourgithub/wdoc545—~1.1kAutomated safety check: PassAGPL-3.0
Markitdownaipoch/medical-research-skills2k—~1.3kAutomated safety check: PassMIT
Sentence Transformers EmbeddingsOrchestra-Research/AI-Research-SKILLs13k3 repos~1.6kAutomated safety check: PassMIT
Scholar RAGjoshzyj/open-scholar-skill167—~7.4kAutomated safety check: NotesCustom licence
Langchain RAGlangchain-ai/langchain-skills1.3k1 repos~3.9kAutomated safety check: PassMIT
Neo4j Graphrag Skillneo4j-contrib/neo4j-skills114—~4.2kAutomated safety check: NotesMIT

Similar skills

  • Markitdown

    aipoch/medical-research-skills

    Convert files and Office documents into clean Markdown when you need LLM-friendly, token-efficient text (e.g., for summarization, search, RAG ingestion, or dataset preparation).

    2k GitHub stars~1.3k tokensUpdated 20 days ago
    Documents & OfficeAuto-check passed
  • Sentence Transformers Embeddings

    Orchestra-Research/AI-Research-SKILLs

    Generates text embeddings locally with the sentence-transformers library for RAG, semantic search, clustering and similarity, with model picks for general, multilingual and legal text.

    13k GitHub starsUsed in 3 repos~1.6k tokens
    AI & LLM EngineeringAuto-check passed
  • Scholar RAG

    joshzyj/open-scholar-skill

    Build and query a local vector database + GraphRAG over your entire reference library (Zotero or a PDF folder) for literature review.

    167 GitHub stars~7.4k tokensUpdated 19 days ago
    Research & ScienceAuto-check: notes
  • Langchain RAG

    langchain-ai/langchain-skills

    Official

    INVOKE THIS SKILL when building ANY retrieval-augmented generation (RAG) system.

    1.3k GitHub starsUsed in 1 repo~3.9k tokens
    AI & LLM EngineeringAuto-check passed
  • Neo4j Graphrag Skill

    neo4j-contrib/neo4j-skills

    Build GraphRAG retrieval pipelines on Neo4j using the neo4j-graphrag Python package (v1.22.0+).

    114 GitHub stars~4.2k tokensUpdated yesterday
    Knowledge ManagementAuto-check: notes
  • Pinecone Vector Database

    Orchestra-Research/AI-Research-SKILLs

    Shows how to use Pinecone, a managed vector database, for production RAG, semantic search and recommendations: indexes, upserts, queries, filters and namespaces.

    13k GitHub starsUsed in 6 repos~2k tokens
    DatabasesAuto-check passed

Questions about wdoc Reference

What does wdoc Reference do?

Quick reference for wdoc, a command-line and Python tool that summarizes, searches and answers questions over documents of many file types. wdoc is a retrieval-augmented generation tool that handles more than 20 file types, among them PDF, YouTube, audio, Anki, web pages, Zotero and Karakeep, and sends every model call through LiteLLM.md covering every CLI argument, filetype, loader option, environment variable and the Python API.

When should I use wdoc Reference?

wdoc Reference fits situations like: running wdoc to query or summarize a PDF, video or web page; looking up a wdoc CLI argument, environment variable or filetype; calling wdoc from Python code.

How do I install wdoc Reference in Claude Code?

Run `npx skills add thiswillbeyourgithub/wdoc --skill wdoc-skill -a claude-code`. Or copy the skill folder (wdoc-skill in thiswillbeyourgithub/wdoc) into .claude/skills/wdoc-skill in your project. Claude Code loads it when a task matches its description.

How do I install wdoc Reference in Codex?

Run `npx skills add thiswillbeyourgithub/wdoc --skill wdoc-skill -a codex`. Or copy the skill folder (wdoc-skill in thiswillbeyourgithub/wdoc) into .agents/skills/wdoc-skill in your project. Codex loads it when a task matches its description.

Can I use wdoc Reference in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add thiswillbeyourgithub/wdoc --skill wdoc-skill -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/wdoc-skill, .gemini/skills/wdoc-skill, .github/skills/wdoc-skill and .opencode/skills/wdoc-skill in your project.

What does wdoc Reference need to run?

Going by SKILL.md and its folder, wdoc Reference needs the command-line tools its instructions call (pip and uvx) and credentials named ANTHROPIC_API_KEY. Our summary lists: wdoc installed with pip, using the full extras to get every loader, or run through `uvx`; An API key for an LLM provider, such as `ANTHROPIC_API_KEY`.

Does wdoc Reference access the network?

SKILL.md contains no URLs. Its commands use pip and uvx, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is wdoc Reference safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does wdoc Reference use?

wdoc Reference is published under the AGPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does wdoc Reference use?

About 1.1k tokens (SKILL.md is roughly 4.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to wdoc Reference?

Skills that share tags, products or a category with wdoc Reference: Markitdown (aipoch/medical-research-skills, 2k stars), Sentence Transformers Embeddings (Orchestra-Research/AI-Research-SKILLs, 13k stars), Scholar RAG (joshzyj/open-scholar-skill, 167 stars) and Langchain RAG (langchain-ai/langchain-skills, 1.3k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains wdoc Reference?

thiswillbeyourgithub (a GitHub user) maintains it in thiswillbeyourgithub/wdoc, which has 545 GitHub stars. The repository was last updated on August 24, 2026.

Source: thiswillbeyourgithub/wdoc on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.