HYPOTHESIS-CLIENT(1)

📦
version 0.12.0 · 3 versions
, in ubuntu resolute, ubuntu stonking

💖 HYPOTHESIS-CLIENT(1) 💖

okay bestie, welcome to the User Commands section of the manual, and specifically to the part that is all about hypothesis-client groups list. pull up a chair, grab a strawberry, we're listing groups 🍓✨

✨ NAME ✨

hypothesis-client groups list — Retrieve a list of applicable Groups, filtered by authority and target document (document_uri). Also retrieve user's private Groups

like. it gets you the groups. the applicable ones. filtered by authority and by the target document, and also it grabs the user's own private groups. slay. 👑

🌸 SYNOPSIS 🌸

hypothesis-client groups list [OPTIONS]

that's it. that's the whole vibe. you run it with some options and it gives you groups. 💅

🦋 DESCRIPTION 🦋

Retrieve a list of applicable Groups, filtered by authority and target document (document_uri). Also retrieve user's private Groups

no fr fr, that's the entire job description. it pulls the applicable Groups, it filters them by authority, it filters them by the target document you're annotating, and it also pulls your private Groups. main character behaviour honestly. 💜

🎀 OPTIONS 🎀

  • --authority <AUTHORITY> — Filter returned groups to this authority. For authenticated requests, the user's associated authority will supersede any provided value. Default: "hypothes.is" — and yes the default gets repeated, it's listed as [default: hypothes.is] so there you go, twice the hypothes.is, twice the fun. ⭐
ngl bestie, if you're authenticated then your user's own authority supersedes whatever you pass here. so what you type... might not be what you get. just so you know. 🙈
  • --document-uri <DOCUMENT_URI> — Only retrieve public (i.e. non-private) groups that apply to a given document URI (i.e. the target document being annotated). Default: "" (empty, empty, a whole lotta nothing) 🌸
  • --expand <EXPAND> — One or more relations to expand for a group resource. Possible values: organization, scopes

Possible values:

  • organization: Expand organization field to Org
  • scopes: Expand scopes field to Scope

so you can expand one relation, or many, and these are the two doors you can open. 🚪✨

  • -o, --file <FILE> — json file to write filtered groups to, writes to stdout if not given. so if you don't hand it a file, it just vibes straight into stdout and you can pipe it wherever you want. 🫶
  • -h, --help — Print help (see a summary with '-h')
💀 friendly reminder bestie: all of these are literally just groups, groups, groups. if you wanted something else you're in the wrong manpage, no cap.

🌈 that's the whole page 🌈

this gem of a document came out of the hypothesis-client manual, User Commands flavour, and it's dated August 2025. i'm obsessed with it, tbh. go forth and list those groups, bestie, you're gonna eat. 💖🧚✨

📦 where this page comes from