Usage

pwclient

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

-h, --help: show this help message and exit

--debug: enable debugging logging (only supported with the REST backend)

Use ‘pwclient <command> –help’ for more info.

To avoid unicode encode/decode errors, you should export the LANG or LC_ALL environment variables according to the configured locales on your system. If these variables are already set, make sure that they point to valid and installed locales.

pwclient apply

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

patch_id: patch ID

--help: show this help message and exit

-h, --use-hashes: lookup by patch hash

-p <project>, --project <project>: lookup patch in project

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: patch ID

--help: show this help message and exit

-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>

pwclient check-get

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

patch_id: patch ID

--help: show this help message and exit

-h, --use-hashes: lookup by patch hash

-p <project>, --project <project>: lookup patch in project

-f <format>, --format <format>: print output in the given format. You can use tags matching fields, e.g. %{context}, %{state}, or %{msgid}.

pwclient check-info

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

patch_id: patch ID (required if using the REST API backend)

check_id: check ID

-h, --help: show this help message and exit

pwclient check-list

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

patch_id: patch ID (required if using the REST API backend)

-h, --help: show this help message and exit

-u <user>, --user <user>: user (name or ID) to filter checks by

pwclient event-list

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

-h, --help: show this help message and exit

-p <project>, --project <project>: filter by project name (see ‘projects’ for 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

-f <format>, --format <format>: print output in the given format. You can use tags matching fields, e.g. %{id}, %{category}, or %{series_id}.

pwclient get

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

patch_id: patch ID

--help: show this help message and exit

-h, --use-hashes: lookup by patch hash

-p <project>, --project <project>: lookup patch in project

pwclient git-am

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

patch_id: patch ID

--help: show this help message and exit

-h, --use-hashes: lookup by patch hash

-p <project>, --project <project>: lookup patch in project

-s, --signoff: pass ‘–signoff’ to ‘git-am’

-3, --3way: pass ‘–3way’ to ‘git-am’

-m, --msgid: pass ‘–message-id’ to ‘git-am’

pwclient info

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

patch_id: patch ID

--help: show this help message and exit

-h, --use-hashes: lookup by patch hash

-p <project>, --project <project>: lookup patch in project

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

-h, --help: show this help message and exit

-s <state>, --state <state>: filter by patch state (e.g., ‘New’, ‘Accepted’, etc.)

-a, --archived: filter by patch archived state

-p <project>, --project <project>: filter by project name (see ‘projects’ for 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: 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}.

pwclient projects

usage: pwclient projects [-h]

-h, --help: show this help message and exit

pwclient search

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

-h, --help: show this help message and exit

-s <state>, --state <state>: filter by patch state (e.g., ‘New’, ‘Accepted’, etc.)

-a, --archived: filter by patch archived state

-p <project>, --project <project>: filter by project name (see ‘projects’ for 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: 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}.

pwclient states

usage: pwclient states [-h]

-h, --help: show this help message and exit

pwclient update

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

patch_id: patch ID

--help: show this help message and exit

-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

using a COMMIT-REF allows for only one ID to be specified

pwclient view

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

patch_id: patch ID

--help: show this help message and exit

-h, --use-hashes: lookup by patch hash

-p <project>, --project <project>: lookup patch in project