HYPOTHESIS-CLIENT(1)

💖 HYPOTHESIS-CLIENT — annotations search 💖

okay bestie, listen up, this is the hypothesis-client manual, and specifically the annotations search subcommand, and it's lowkey iconic. no cap. 🦋

---

✨ NAME ✨

hypothesis-client annotations search — search for annotations, with optional filters, and yes you can filter like your life depends on it 💅

---

🌸 SYNOPSIS 🌸

hypothesis-client annotations search [OPTIONS]

like that's it. that's the whole vibe. args go in, annotations come out. 🎀

---

💜 DESCRIPTION 💜

Search for annotations with optional filters. fr fr that's the whole thing — you search, you can narrow stuff down with the flags below, and you get your annotations back. group-chat energy, but for metadata. 🌈

---

👑 OPTIONS 👑

so many options. we love options. here's every single one, no skipping, periodt.

• --limit <LIMIT> — the max number of annotations you're getting back. Default: 20. Range: [ 0 .. 200 ]. Also, [default: 20]. don't be greedy 🍓
• --sort <SORT> — the field by which annotations should be sorted. one of created, updated, id, group, user. Default: updated. Alias [default: updated] and possible values: created, updated, id, group, user. pick your fave, they're all valid ✨
• --search-after <SEARCH_AFTER> — example: "2019-01-03T19:46:09.334Z". this defines a start point for a subset (a page) of annotation search results. NOTE: make sure to set sort to Sort::Asc if using search_after. [default: ] (yes, empty). it's giving "pagination but make it elegant" 😭
• --offset <OFFSET> — the number of initial annotations to skip in the result set. Default: 0. Range: <= 9800. search_after is more efficient. [default: 0]. not me skipping the first 9800... 💀

heads up: search_after is literally the more efficient glow-up here, so use that if you can 💅

• --order <ORDER> — the order in which the results should be sorted. one of asc, desc. Default: desc. [default: desc] and possible values: asc, desc. up or down, choose your main character direction 🦋
• --uri <URI> — limit the results to annotations matching the specific URI or equivalent URIs. URI can be a URL (a web page address) or a URN representing another kind of resource such as DOI (Digital Object Identifier) or a PDF fingerprint. [default: ]
• --uri-parts <URI_PARTS> — limit the results to annotations containing the given keyword (tokenized chunk) in the URI. The value must exactly match an individual URI keyword. [default: ]
• --wildcard-uri <WILDCARD_URI> — limit the results to annotations whose URIs match the wildcard pattern. [default: ] ✨ wildcard behavior, we stan
• --user <USER> — limit the results to annotations made by the specified user (in the format acct:<username>@<authority>). [default: ]
• --group <GROUP> — limit the results to annotations made in the specified group (by group ID). This can be specified multiple times to retrieve multiple groups. yes you can stack it, go off 👑
• --tag <TAG> — limit the results to annotations tagged with the specified value. [default: ]
• --tags <TAGS> — similar to tag but allows a list of multiple tags. the "and also" of tags 🎀
• --any <ANY> — limit the results to annotations who contain the indicated keyword in any of the following fields: quote, tags, text, url. [default: ]. the search-everything button fr fr 🔥
• --quote <QUOTE> — limit the results to annotations that contain this text inside the text that was annotated. [default: ]
• --references <REFERENCES> — returns annotations that are replies to this parent annotation ID. [default: ] yes, thread hunting 🧚
• --text <TEXT> — limit the results to annotations that contain this text in their textual body. [default: ]
• -o, --file <FILE> — json file to write search results to. writes to stdout if not given. so if you don't say anything, it just yeets the JSON at your terminal, which is honestly a vibe 🌸
• -h, --help — print help (see a summary with -h). your lil cheat sheet 💖

---

and that's the whole page bestie, every option, every default, every range, nothing left behind 🫶

this was hypothesis-client annotations ... from August 2025, version vibes courtesy of the HYPOTHESIS-CLIENT(1) manual, User Commands section. go search something pretty. periodt. 💜✨