PWCLIENT(1)

📦 version 2.9.0, in alpine 3.24

🌸 PWCLIENT(1) — the pwclient glow-up 🌸

okay bestie, settle in 💖 this is pwclient, from the Generated Python Manual — it's your little command-line bestie for talking to Patchwork, and honestly it's giving main character energy. Let me walk you through it, no cap.

✨ NAME ✨

pwclient — that's the whole name, that's the vibe 🎀

🦋 SYNOPSIS 🦋

pwclient [-h] [--debug] {apply,git-am,get,info,projects,check-get,check-list,check-info,check-create,event-list,states,view,update,list,search} ...

so it's literally pwclient plus one of those commands, and then whatever that command wants. pick your fighter 💅

🔥 OPTIONS 🔥

  • --debug — turns on debugging logging. but bestie, read the fine print: it's only supported with the REST backend. so if you're not on REST, this flag is just doing cardio for nothing 😭

👑 COMMANDS 👑

here's the whole squad, one by one 🫶

  • pwclient apply — applies a patch in the current directory using 'patch -p1'. yes, the real patch, doing real -p1 things ✨
  • pwclient git-am — applies a patch to the current git branch using 'git am'. git girlies rise 🙈
  • pwclient get — downloads a patch and saves it locally. your filesystem says thank you 💖
  • pwclient info — shows information for a given patch ID
  • pwclient projects — lists all projects
  • pwclient check-get — gets checks for a patch
  • pwclient check-list — lists all checks
  • pwclient check-info — shows information for a given check
  • pwclient check-create — adds a check to a patch
  • pwclient event-list — lists events
  • pwclient states — shows the list of potential patch states
  • pwclient view — views a patch
  • pwclient update — updates a patch
  • pwclient list — lists patches using optional filters
  • pwclient search — an alias for 'list' (same energy, different name, we love a rebrand 💅)

🧚 COMMAND 'pwclient apply' 🧚

usage: pwclient apply [--help] [-h] [-p PROJECT] PATCH_ID [PATCH_ID ...]

PATCH_ID — the patch ID. give it one, give it many, it's not judgy 🍓

⭐ OPTIONS 'pwclient apply' ⭐

  • -h, --use-hashes — lookup by patch hash. ⚠️ bestie heads up: -h here is not help, it's --use-hashes. the audacity honestly 💀
  • -p PROJECT, --project PROJECT — lookup patch in project

🌈 COMMAND 'pwclient git-am' 🌈

usage: pwclient git-am [--help] [-h] [-p PROJECT] [-s] [-3] [-m] PATCH_ID [PATCH_ID ...]

PATCH_ID — the patch ID

⭐ OPTIONS 'pwclient git-am' ⭐

  • -h, --use-hashes — lookup by patch hash (again: not help, it's hashes, we've been through this 💀)
  • -p PROJECT, --project PROJECT — lookup patch in project
  • -s, --signoff — passes '--signoff' to 'git-am'
  • -3, --3way — passes '--3way' to 'git-am'
  • -m, --msgid — passes '--message-id' to 'git-am'

🎀 COMMAND 'pwclient get' 🎀

usage: pwclient get [--help] [-h] [-p PROJECT] PATCH_ID [PATCH_ID ...]

PATCH_ID — the patch ID

⭐ OPTIONS 'pwclient get' ⭐

  • -h, --use-hashes — lookup by patch hash
  • -p PROJECT, --project PROJECT — lookup patch in project

💜 COMMAND 'pwclient info' 💜

usage: pwclient info [--help] [-h] [-p PROJECT] PATCH_ID [PATCH_ID ...]

PATCH_ID — the patch ID

⭐ OPTIONS 'pwclient info' ⭐

  • -h, --use-hashes — lookup by patch hash
  • -p PROJECT, --project PROJECT — lookup patch in project

🌸 COMMAND 'pwclient projects' 🌸

usage: pwclient projects [-h]

that's it. that's the whole usage line. ✨ iconic, minimal, no notes ✨

🦋 COMMAND 'pwclient check-get' 🦋

usage: pwclient check-get [--help] [-h] [-p PROJECT] [-f FORMAT] PATCH_ID [PATCH_ID ...]

PATCH_ID — the patch ID

⭐ OPTIONS 'pwclient check-get' ⭐

  • -h, --use-hashes — lookup by patch hash
  • -p PROJECT, --project PROJECT — lookup patch in project
  • -f FORMAT, --format FORMAT — prints output in the given format. you can use tags matching fields, e.g. %{context}, %{state}, or %{msgid}. so customizable, so demure 💅

🍓 COMMAND 'pwclient check-list' 🍓

usage: pwclient check-list [-h] [-u USER] [PATCH_ID]

PATCH_ID — the patch ID. and listen: it's required if using the REST API backend. so with REST, no PATCH_ID, no party 🙈

⭐ OPTIONS 'pwclient check-list' ⭐

  • -u USER, --user USER — user (name or ID) to filter checks by

🌟 COMMAND 'pwclient check-info' 🌟

usage: pwclient check-info [-h] [PATCH_ID] CHECK_ID

PATCH_ID — the patch ID (required if using the REST API backend, same deal as above)

CHECK_ID — the check ID

💖 COMMAND 'pwclient check-create' 💖

usage: pwclient check-create [--help] [-h] [-p PROJECT] [-c CONTEXT] [-s {pending,success,warning,fail}] [-u TARGET_URL] [-d DESCRIPTION] PATCH_ID [PATCH_ID ...]

PATCH_ID — the patch ID

⭐ OPTIONS 'pwclient check-create' ⭐

okay so the manpage literally doesn't give blurbs for these next few — the flag names are doing all the talking, and I respect the confidence 😌

  • -h, --use-hashes — lookup by patch hash
  • -p PROJECT, --project PROJECT — lookup patch in project
  • -c CONTEXT, --context CONTEXT
  • -s {pending,success,warning,fail}, --state {pending,success,warning,fail}
  • -u TARGET_URL, --target-url TARGET_URL
  • -d DESCRIPTION, --description DESCRIPTION

💫 COMMAND 'pwclient event-list' 💫

usage: pwclient event-list [-h] [-p PROJECT] [-c CATEGORY] [--since SINCE] [-f FORMAT]

⭐ OPTIONS 'pwclient event-list' ⭐

  • -p PROJECT, --project PROJECT — filter by project name (see 'projects' for the list 👀)
  • -c CATEGORY, --category CATEGORY — filter by event category (e.g. 'series-completed')
  • --since SINCE — show only events since a given date in ISO 8601 format. dates in ISO 8601, as the universe intended ⭐
  • -f FORMAT, --format FORMAT — print output in the given format. you can use tags matching fields, e.g. %{id}, %{category}, or %{series_id}

🌱 COMMAND 'pwclient states' 🌱

usage: pwclient states [-h]

short, sweet, shows you the potential patch states. periodt 💅

👀 COMMAND 'pwclient view' 👀

usage: pwclient view [--help] [-h] [-p PROJECT] PATCH_ID [PATCH_ID ...]

PATCH_ID — the patch ID

⭐ OPTIONS 'pwclient view' ⭐

  • -h, --use-hashes — lookup by patch hash
  • -p PROJECT, --project PROJECT — lookup patch in project

🔧 COMMAND 'pwclient update' 🔧

usage: pwclient update [--help] [-h] [-p PROJECT] [-c COMMIT-REF] [-s STATE] [-a {yes,no}] PATCH_ID [PATCH_ID ...]

PATCH_ID — the patch ID

⭐ OPTIONS 'pwclient update' ⭐

  • -h, --use-hashes — lookup by patch hash
  • -p PROJECT, --project PROJECT — lookup patch in project
  • -c COMMIT-REF, --commit-ref COMMIT-REF — commit reference hash
  • -s STATE, --state STATE — set patch state (e.g., 'Accepted', 'Superseded' etc.)
  • -a {yes,no}, --archived {yes,no} — set patch archived state. it's literally yes or no, pick one bestie 🫶

📋 COMMAND 'pwclient list' 📋

usage: pwclient list [-h] [-s STATE] [-a ARCHIVED] [-p PROJECT] [-w WHO] [-d WHO] [-n MAX#] [-N MAX#] [-m MESSAGEID] [-H HASH] [-S SERIES_ID] [-f FORMAT] [STR]

STR — substring to search for patches by name

⭐ OPTIONS 'pwclient list' ⭐

  • -s STATE, --state STATE — filter by patch state (e.g., 'New', 'Accepted', etc.)
  • -a ARCHIVED, --archived ARCHIVED — filter by patch archived state
  • -p PROJECT, --project PROJECT — filter by project name (see 'projects' for the list)
  • -w WHO, --submitter WHO — filter by submitter (name, e-mail substring search)
  • -d WHO, --delegate WHO — filter by delegate (name, e-mail substring search)
  • -n MAX# — limit results to first n
  • -N MAX# — limit results to last N. yes lowercase -n and uppercase -N are different things, stay sharp 😭
  • -m MESSAGEID, --msgid MESSAGEID — filter by Message-Id
  • -H HASH, --hash HASH — filter by hash
  • -S SERIES_ID, --series SERIES_ID — filter by series ID
  • -f FORMAT, --format FORMAT — print output in the given format. you can use tags matching fields, e.g. %{id}, %{state}, or %{msgid}
usage: pwclient search [-h] [-s STATE] [-a ARCHIVED] [-p PROJECT] [-w WHO] [-d WHO] [-n MAX#] [-N MAX#] [-m MESSAGEID] [-H HASH] [-S SERIES_ID] [-f FORMAT] [STR]

STR — substring to search for patches by name

(same list, because search is literally an alias for 'list' — matching set, matching energy 🎀)

  • -s STATE, --state STATE — filter by patch state (e.g., 'New', 'Accepted', etc.)
  • -a ARCHIVED, --archived ARCHIVED — filter by patch archived state
  • -p PROJECT, --project PROJECT — filter by project name (see 'projects' for the list)
  • -w WHO, --submitter WHO — filter by submitter (name, e-mail substring search)
  • -d WHO, --delegate WHO — filter by delegate (name, e-mail substring search)
  • -n MAX# — limit results to first n
  • -N MAX# — limit results to last N
  • -m MESSAGEID, --msgid MESSAGEID — filter by Message-Id
  • -H HASH, --hash HASH — filter by hash
  • -S SERIES_ID, --series SERIES_ID — filter by series ID
  • -f FORMAT, --format FORMAT — print output in the given format. you can use tags matching fields, e.g. %{id}, %{state}, or %{msgid}

💬 COMMENTS 💬

want more deets on any single command? use:

pwclient <command> --help

and it'll spill the tea for you 🫖

now the important bit — to avoid unicode encode/decode errors, you should export the LANG or LC_ALL environment variables according to the configured locales on your system. and if those variables are already set, make sure they point to valid and installed locales. 👈 do this, fr fr, unicode errors are not the vibe 😭

bestie warning 🚨 — LANG/LC_ALL pointing at locales that aren't valid and installed on your system is exactly how you get unicode encode/decode nonsense. double-check them.

🫶 AUTHOR 🫶

Patchwork Developers patchwork@lists.ozlabs.org

🌐 DISTRIBUTION 🌐

the latest version of pwclient may be downloaded from https://github.com/getpatchwork/patchwork — go get your fresh copy, you deserve it 👑

✨ and that's the whole page, bestie ✨ this beauty is pwclient from the Generated Python Manual, dated 2026-04-10 — so recent, so fresh, so cunty in a command-line way 💅🦋💖 love u, go file some patches 🫶

📦 where this page comes from