python-gerritclient¶

This is a CLI tool and Python API wrapper for Gerrit Code Review.

User Documentation¶

Gerrit Command Line Utility¶

python-gerritclient CLI is a command line utility for managing Gerrit Code Review environment. It allows to perform several types of operations.

For help on a specific gerrit command or subcommand, enter:

$ gerrit COMMAND [SUBCOMMAND [SUBCOMMAND ...]] --help

All gerrit commands support several options:

Usage: gerrit [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]

optional arguments:

--version: Show program’s version number and exit.
-v, --verbose: Increase verbosity of output. Can be repeated.
-q, --quiet: Suppress output except warnings and errors.
--log-file LOG_FILE: Specify a file to log output. Disabled by default.
-h, --help: Show help message and exit.
--debug: Show tracebacks on errors.

Gerrit CLI Commands¶

gerrit account * commands¶

account create¶

Creates a new account in Gerrit Code Review.

gerrit account create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--file FILE]
    account-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--file <FILE>¶: File with metadata to be uploaded.

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account disable¶

Sets the account state in Gerrit to inactive.

gerrit account disable account-identifier

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account email add¶

Registers a new email address for the user in Gerrit.

gerrit account email add
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    -e EMAIL
    [--preferred]
    [--no-confirmation]
    account-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

-e <EMAIL>, --email <EMAIL>¶: Account email.

--preferred¶: Set email address as preferred.

--no-confirmation¶: Email address confirmation. Only Gerrit administrators are allowed to add email addresses without confirmation.

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account email delete¶

Deletes an email address of an account in Gerrit.

gerrit account email delete -e EMAIL account-identifier

-e <EMAIL>, --email <EMAIL>¶: Account email.

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account email set-preferred¶

Sets an email address as preferred email address for an account.

gerrit account email set-preferred account-identifier email

account-identifier¶: Account identifier.

email¶: Account email.

This command is provided by the python-gerritclient plugin.

account enable¶

Sets the account state in Gerrit to active.

gerrit account enable account-identifier

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account list¶

Lists all accounts in Gerrit visible to the caller.

gerrit account list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [--suggest]
    [-l LIMIT]
    [-S SKIP]
    [-a]
    [--all-emails]
    query

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--suggest¶: Get account suggestions.

-l <LIMIT>, --limit <LIMIT>¶: Limit the number of accounts to be included in the results.

-S <SKIP>, --skip <SKIP>¶: Skip the given number of accounts from the beginning of the list.

-a, --all¶: Includes full name, preferred email, username and avatars for each account.

--all-emails¶: Includes all registered emails.

query¶: Query string.

This command is provided by the python-gerritclient plugin.

account membership list¶

Lists all groups that contain the specified user as a member.

gerrit account membership list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    account-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account name set¶

Sets the full name of an account in Gerrit Code Review.

gerrit account name set account-identifier name

account-identifier¶: Account identifier.

name¶: Account name.

This command is provided by the python-gerritclient plugin.

account oauth show¶

Returns a previously obtained OAuth access token.

If there is no token available, or the token has already expired, “404 Not Found” is returned as response. Requests to obtain an access token of another user are rejected with “403 Forbidden”.

gerrit account oauth show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    account-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account password delete¶

Deletes the HTTP password of an account in Gerrit.

gerrit account password delete account-identifier

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account password set¶

Sets/Generates the HTTP password of an account in Gerrit.

gerrit account password set
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    (--generate | -p PASSWORD)
    account-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--generate¶: Generate HTTP password.

-p <PASSWORD>, --password <PASSWORD>¶: HTTP password.

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account show¶

Shows information about specific account in Gerrit.

gerrit account show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-a]
    account-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

-a, --all¶: Show more details about account.

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account ssh-key add¶

Adds an SSH key for a user in Gerrit.

gerrit account ssh-key add
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    (--ssh-key SSH_KEY | --file SSH_KEY_FILE)
    account-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--ssh-key <SSH_KEY>¶: The SSH public key.

--file SSH_KEY_FILE¶: File with the SSH public key.

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account ssh-key delete¶

Deletes an SSH key of a user in Gerrit.

gerrit account ssh-key delete
    --sequence-id SEQUENCE_ID
    account-identifier

--sequence-id <SEQUENCE_ID>¶: The sequence number of the SSH key.

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account ssh-key list¶

Returns the SSH keys of an account in Gerrit.

gerrit account ssh-key list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    account-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account ssh-key show¶

Retrieves an SSH key of a user in Gerrit.

gerrit account ssh-key show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    -s SEQUENCE_ID
    account-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

-s <SEQUENCE_ID>, --sequence-id <SEQUENCE_ID>¶: The sequence number of the SSH key.

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account state show¶

Fetches the state of an account in Gerrit.

gerrit account state show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    account-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account status set¶

Sets the status of an account.

gerrit account status set account-identifier status

account-identifier¶: Account identifier.

status¶: Account status.

This command is provided by the python-gerritclient plugin.

account status show¶

Retrieves the status of an account.

gerrit account status show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    account-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

account-identifier¶: Account identifier.

This command is provided by the python-gerritclient plugin.

account username set¶

Sets the username of an account in Gerrit Code Review.

gerrit account username set account-identifier username

account-identifier¶: Account identifier.

username¶: Account username.

This command is provided by the python-gerritclient plugin.

gerrit change * commands¶

change abandon¶

Abandons a change.

gerrit change abandon
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change assignee delete¶

Deletes the assignee of a change.

gerrit change assignee delete
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change assignee history show¶

Retrieve a list of every user ever assigned to a change.

gerrit change assignee history show
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change assignee set¶

Sets the assignee of a change.

gerrit change assignee set
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    -a ACCOUNT
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

-a <ACCOUNT>, --account <ACCOUNT>¶: The ID of one account that should be added as assignee.

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change assignee show¶

Retrieves the account of the user assigned to a change.

gerrit change assignee show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change check¶

Performs consistency checks on the change.

Returns a ChangeInfo entity with the problems field.

gerrit change check
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change comment list¶

Lists the published comments of all revisions of the change.

gerrit change comment list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-t {drafts,robotcomments}]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

-t <TYPE>, --type <TYPE>¶: The type of comments. Defaults to published.

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change create¶

Creates a new change.

gerrit change create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    file

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

file¶: File with metadata of a new change.

This command is provided by the python-gerritclient plugin.

change delete¶

Deletes a change.

gerrit change delete change-identifier

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change draft publish¶

Publishes a draft change.

gerrit change draft publish change-identifier

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change fix¶

Performs consistency checks on the change.

Additionally fixes any problems that can be fixed automatically. The returned field values reflect any fixes. Only the change owner, a project owner, or an administrator may fix changes.

gerrit change fix
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--delete-patchset]
    [--expect-merged-as]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--delete-patchset¶: Delete patch sets from the database if they refer to missing commit options.

--expect-merged-as¶: Check that the change is merged into the destination branch as this exact SHA-1. If not, insert a new patch set referring to this commit.

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change included-in show¶

Retrieves the branches and tags in which a change is included.

gerrit change included-in show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change index¶

Adds or updates the change in the secondary index.

gerrit change index change-identifier

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change list¶

Queries changes visible to the caller.

gerrit change list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-l LIMIT]
    [-S SKIP]
    [-o OPTION [OPTION ...]]
    query
    [query ...]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

-l <LIMIT>, --limit <LIMIT>¶: Limit the number of changes to be included in the results.

-S <SKIP>, --skip <SKIP>¶: Skip the given number of changes from the beginning of the list.

-o <OPTION>, --option <OPTION>¶: Fetch additional data about changes.

query¶: Query string.

This command is provided by the python-gerritclient plugin.

change move¶

Moves a change.

gerrit change move
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    -b BRANCH
    [-m MESSAGE]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

-b <BRANCH>, --branch <BRANCH>¶: Destination branch.

-m <MESSAGE>, --message <MESSAGE>¶: A message to be posted in this change’s comments.

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change rebase¶

Rebases a change.

gerrit change rebase
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-p PARENT]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

-p <PARENT>, --parent <PARENT>¶: The new parent revision.

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change restore¶

Restores a change.

gerrit change restore
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change revert¶

Reverts a change.

gerrit change revert
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-m MESSAGE]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

-m <MESSAGE>, --message <MESSAGE>¶: Message to be added as review comment when reverting the change.

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change show¶

Retrieves a change.

gerrit change show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-a]
    [-o OPTION [OPTION ...]]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

-a, --all¶: Retrieves a change with labels, detailed labels, detailed accounts, reviewer updates, and messages.

-o <OPTION>, --option <OPTION>¶: Fetch additional data about a change.

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change submit¶

Submits a change.

gerrit change submit
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--on-behalf-of ON_BEHALF_OF]
    [--notify {NONE,OWNER,OWNER_REVIEWERS,ALL}]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--on-behalf-of <ON_BEHALF_OF>¶: Submit the change on behalf of the given user.

--notify <NOTIFY>¶: Notify handling that defines to whom email notifications should be sent after the change is submitted.

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change topic delete¶

Deletes the topic of a change.

gerrit change topic delete
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change topic set¶

Sets the topic of a change.

gerrit change topic set
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    -t TOPIC
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

-t <TOPIC>, --topic <TOPIC>¶: Topic of a change.

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

change topic show¶

Retrieves the topic of a change.

gerrit change topic show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    change-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

change-identifier¶: Change identifier.

This command is provided by the python-gerritclient plugin.

gerrit group * commands¶

group create¶

Creates a new group in Gerrit Code Review.

gerrit group create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--file FILE]
    group-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--file <FILE>¶: File with metadata to be uploaded.

group-identifier¶: Group identifier.

This command is provided by the python-gerritclient plugin.

group description delete¶

Deletes the description of a specified Gerrit internal group.

gerrit group description delete group-identifier

group-identifier¶: Group identifier.

This command is provided by the python-gerritclient plugin.

group description set¶

Sets the description of a specified Gerrit internal group.

gerrit group description set group-identifier description

group-identifier¶: Group identifier.

description¶: Group description.

This command is provided by the python-gerritclient plugin.

group exclude¶

Deletes one or several included groups from a Gerrit internal group.

gerrit group exclude
    --group group-identifier
    [group-identifier ...]
    group-identifier

--group group-identifier¶: Group(s) identifier(s).

group-identifier¶: Group identifier.

This command is provided by the python-gerritclient plugin.

group include¶

Includes one or several groups into a Gerrit internal group.

gerrit group include
    --group group-identifier
    [group-identifier ...]
    group-identifier

--group group-identifier¶: Group(s) identifier(s).

group-identifier¶: Group identifier.

This command is provided by the python-gerritclient plugin.

group list¶

Lists all groups in Gerrit Code Review.

gerrit group list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

This command is provided by the python-gerritclient plugin.

group member add¶

Adds a user or several users as member(s) to a Gerrit internal group.

gerrit group member add
    --account account-identifier
    [account-identifier ...]
    group-identifier

--account account-identifier¶: Account(s) identifier(s).

group-identifier¶: Group identifier.

This command is provided by the python-gerritclient plugin.

group member delete¶

Removes a user or several users from a Gerrit internal group.

gerrit group member delete
    --account account-identifier
    [account-identifier ...]
    group-identifier

--account account-identifier¶: Account(s) identifier(s).

group-identifier¶: Group identifier.

This command is provided by the python-gerritclient plugin.

group member list¶

Lists all members of specific group in Gerrit Code Review.

gerrit group member list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-a]
    group-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

-a, --all¶: Show members from included groups.

group-identifier¶: Group identifier.

This command is provided by the python-gerritclient plugin.

group options set¶

Sets the options of a Gerrit internal group.

gerrit group options set
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    (--visible | --no-visible)
    group-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--visible¶: Set group visible to all registered users.

--no-visible¶: Set group not visible to all registered users.

group-identifier¶: Group identifier.

This command is provided by the python-gerritclient plugin.

group owner set¶

Sets the owner group of a Gerrit internal group.

gerrit group owner set group-identifier owner

group-identifier¶: Group identifier.

owner¶: Group owner.

This command is provided by the python-gerritclient plugin.

group rename¶

Renames a Gerrit internal group.

gerrit group rename group-identifier new_name

group-identifier¶: Group identifier.

new_name¶: New group name.

This command is provided by the python-gerritclient plugin.

group show¶

Shows information about specific group in Gerrit Code Review.

gerrit group show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [-a]
    group-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

-a, --all¶: Show more details about group.

group-identifier¶: Group identifier.

This command is provided by the python-gerritclient plugin.

gerrit plugin * commands¶

plugin disable¶

Disables a plugin on the Gerrit server.

gerrit plugin disable plugin-identifier

plugin-identifier¶: Plugin identifier.

This command is provided by the python-gerritclient plugin.

plugin enable¶

Enables a plugin on the Gerrit server.

gerrit plugin enable plugin-identifier

plugin-identifier¶: Plugin identifier.

This command is provided by the python-gerritclient plugin.

plugin install¶

Installs a new plugin on the Gerrit server.

gerrit plugin install
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    (--url URL | --file FILE)
    plugin-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--url <URL>¶: URL to the plugin jar.

--file <FILE>¶: File path to the plugin jar.

plugin-identifier¶: Plugin identifier.

This command is provided by the python-gerritclient plugin.

plugin list¶

Lists all installed plugins in Gerrit Code Review.

gerrit plugin list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-a]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

-a, --all¶: Show all plugins (including disabled).

This command is provided by the python-gerritclient plugin.

plugin reload¶

Reloads a plugin on the Gerrit server.

gerrit plugin reload
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    plugin-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

plugin-identifier¶: Plugin identifier.

This command is provided by the python-gerritclient plugin.

plugin show¶

Shows information about specific plugin in Gerrit Code Review.

gerrit plugin show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    plugin-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

plugin-identifier¶: Plugin identifier.

This command is provided by the python-gerritclient plugin.

gerrit project * commands¶

project branch create¶

Creates a new branch.

gerrit project branch create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    -b BRANCH
    [-r REVISION]
    project-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

-b <BRANCH>, --branch <BRANCH>¶: The name of a branch or HEAD. The prefix refs/heads/ can be omitted.

-r <REVISION>, --revision <REVISION>¶: The base revision of the new branch. If not set, HEAD will be used as base revision.

project-identifier¶: Project identifier.

This command is provided by the python-gerritclient plugin.

project branch delete¶

Deletes one or more branches.

gerrit project branch delete -b BRANCH [BRANCH ...] name

-b <BRANCH>, --branch <BRANCH>¶: The branches that should be deleted.

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project branch list¶

Lists the branches of a project.

gerrit project branch list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    name

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project branch reflog show¶

Gets the reflog of a certain branch.

The caller must be project owner.

gerrit project branch reflog show
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    -b BRANCH
    name

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

-b <BRANCH>, --branch <BRANCH>¶: The name of a branch or HEAD. The prefix refs/heads/ can be omitted.

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project branch show¶

Retrieves a branch of a project.

gerrit project branch show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    -b BRANCH
    project-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

-b <BRANCH>, --branch <BRANCH>¶: The name of a branch or HEAD. The prefix refs/heads/ can be omitted.

project-identifier¶: Project identifier.

This command is provided by the python-gerritclient plugin.

project child list¶

Lists the direct child projects of a project.

Child projects that are not visible to the calling user are ignored and are not resolved further.

gerrit project child list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-r]
    name

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

-r, --recursively¶: Resolve the child projects of a project recursively.

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project commit file-content show¶

Gets the content of a file from a certain commit.

gerrit project commit file-content show
    --commit COMMIT
    --file-id FILE_ID
    name

--commit <COMMIT>¶: Commit ID.

--file-id <FILE_ID>¶: The path to the file.

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project commit included-in¶

Retrieves the branches and tags in which a change is included.

gerrit project commit included-in
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    --commit COMMIT
    project-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--commit <COMMIT>¶: Commit ID.

project-identifier¶: Project identifier.

This command is provided by the python-gerritclient plugin.

project commit show¶

Retrieves a commit of a project.

The commit must be visible to the caller.

gerrit project commit show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    --commit COMMIT
    project-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--commit <COMMIT>¶: Commit ID.

project-identifier¶: Project identifier.

This command is provided by the python-gerritclient plugin.

project configuration download¶

Gets some configuration information about a project.

Note that this config info is not simply the contents of project.config; it generally contains fields that may have been inherited from parent projects.

gerrit project configuration download
    [-f {json,yaml}]
    [-d DIRECTORY]
    name

-f <FORMAT>, --format <FORMAT>¶: Format of serialization.

-d <DIRECTORY>, --directory <DIRECTORY>¶: Destination directory. Defaults to the current directory.

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project configuration set¶

Sets the configuration of a project.

gerrit project configuration set --file FILE name

--file <FILE>¶: File with metadata to be uploaded.

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project create¶

Creates a new project in Gerrit Code Review.

gerrit project create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--file FILE]
    project-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--file <FILE>¶: File with metadata to be uploaded.

project-identifier¶: Project identifier.

This command is provided by the python-gerritclient plugin.

project delete¶

Deletes specified project from Gerrit Code Review.

Note, ‘deleteproject’ plugin must be installed.

gerrit project delete [-f] [--preserve-git-repository] name

-f, --force¶: Delete project even if it has open changes.

--preserve-git-repository¶: Do not delete git repository directory.

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project description set¶

Retrieves the description of a project.

gerrit project description set [-d DESCRIPTION] [-m MESSAGE] name

-d <DESCRIPTION>, --description <DESCRIPTION>¶: The project description. The project description will be deleted if not set.

-m <MESSAGE>, --message <MESSAGE>¶: Message that should be used to commit the change of the project description in the project.config file to the refs/meta/config branch.

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project description show¶

Retrieves the description of a project.

gerrit project description show name

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project gc-run¶

Runs the Git garbage collection for the repository of a project.

In case of asynchronous execution the –show-progress option is ignored.

gerrit project gc-run [--show-progress] [--aggressive] name

--show-progress¶: Show progress information.

--aggressive¶: Do aggressive garbage collection.

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project head set¶

Sets HEAD for a project.

gerrit project head set -b BRANCH name

-b <BRANCH>, --branch <BRANCH>¶: The name of the branch to which HEAD should point.

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project head show¶

Retrieves for a project the name of the branch to which HEAD points.

gerrit project head show name

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project list¶

Lists all projects accessible by the caller.

gerrit project list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]
    [-a]
    [-d]
    [-b BRANCHES [BRANCHES ...]]
    [-l LIMIT]
    [-S SKIP]
    [--type {code,permissions,all}]
    [-p PREFIX | -m MATCH | -r REGEX]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

-a, --all¶: Include hidden projects in the results.

-d, --description¶: Include project description in the results.

-b <BRANCHES>, --branches <BRANCHES>¶: Limit the results to the projects having the specified branches and include the sha1 of the branches in the results.

-l <LIMIT>, --limit <LIMIT>¶: Limit the number of projects to be included in the results.

-S <SKIP>, --skip <SKIP>¶: Skip the given number of projects from the beginning of the list.

--type <TYPE>¶: Display only projects of the specified type.

-p <PREFIX>, --prefix <PREFIX>¶: Limit the results to those projects that start with the specified prefix.

-m <MATCH>, --match <MATCH>¶: Limit the results to those projects that match the specified substring.

-r <REGEX>, --regex <REGEX>¶: Limit the results to those projects that match the specified regex.

This command is provided by the python-gerritclient plugin.

project parent set¶

Sets the parent project for a project.

gerrit project parent set -p PARENT [-m MESSAGE] name

-p <PARENT>, --parent <PARENT>¶: The name of the parent project.

-m <MESSAGE>, --message <MESSAGE>¶: Message that should be used to commit the change of the project parent in the project.config file to the refs/meta/config branch.

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project parent show¶

Retrieves the name of a project’s parent project.

gerrit project parent show name

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project repo-statistics show¶

Return statistics for the repository of a project.

gerrit project repo-statistics show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    project-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

project-identifier¶: Project identifier.

This command is provided by the python-gerritclient plugin.

project show¶

Shows information about specific project in Gerrit Code Review.

gerrit project show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    project-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

project-identifier¶: Project identifier.

This command is provided by the python-gerritclient plugin.

project tag create¶

Creates a new tag on the project.

If a message is provided in the input, the tag is created as an annotated tag with the current user as tagger. Signed tags are not supported.

gerrit project tag create
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    -t TAG
    [-r REVISION]
    [-m MESSAGE]
    project-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

-t <TAG>, --tag <TAG>¶: The name of the tag. The leading refs/tags/ is optional.

-r <REVISION>, --revision <REVISION>¶: The revision to which the tag should point. If not specified, the project’s HEAD will be used.

-m <MESSAGE>, --message <MESSAGE>¶: The tag message. When set, the tag will be created as an annotated tag.

project-identifier¶: Project identifier.

This command is provided by the python-gerritclient plugin.

project tag delete¶

Deletes one or more tags of the project.

gerrit project tag delete -t TAG [TAG ...] name

-t <TAG>, --tag <TAG>¶: The tags to be deleted.

name¶: Name of the project.

This command is provided by the python-gerritclient plugin.

project tag show¶

Retrieves a tag of a project.

gerrit project tag show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    project-identifier
    tag

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

project-identifier¶: Project identifier.

tag¶: Name of the tag.

This command is provided by the python-gerritclient plugin.

gerrit server * commands¶

server cache flush¶

Flushes a cache.

gerrit server cache flush (-a | -n NAME [NAME ...])

-a, --all¶: All available caches.

-n <NAME>, --name <NAME>¶: Caches names.

This command is provided by the python-gerritclient plugin.

server cache list¶

Show the cache names as a list.

gerrit server cache list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

This command is provided by the python-gerritclient plugin.

server cache show¶

Retrieves information about a cache.

gerrit server cache show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    name

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

name¶: Cache name.

This command is provided by the python-gerritclient plugin.

server capabilities download¶

Downloads a list of the capabilities available in the system.

gerrit server capabilities download [-f {json,yaml}] [-d DIRECTORY]

-f <FORMAT>, --format <FORMAT>¶: Format of serialization.

-d <DIRECTORY>, --directory <DIRECTORY>¶: Destination directory. Defaults to the current directory.

This command is provided by the python-gerritclient plugin.

server configuration download¶

Downloads the information about the Gerrit server configuration.

gerrit server configuration download [-f {json,yaml}] [-d DIRECTORY]

-f <FORMAT>, --format <FORMAT>¶: Format of serialization.

-d <DIRECTORY>, --directory <DIRECTORY>¶: Destination directory. Defaults to the current directory.

This command is provided by the python-gerritclient plugin.

server state show¶

Retrieves a summary of the current server state.

gerrit server state show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    [--jvm]
    [--gc]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

--jvm¶: Includes a JVM summary.

--gc¶: Requests a Java garbage collection before computing the information about the Java memory heap.

This command is provided by the python-gerritclient plugin.

server task delete¶

Kills a task from the background work queue that the Gerrit daemon

is currently performing, or will perform in the near future.

gerrit server task delete task-identifier

task-identifier¶: The ID of the task (hex string).

This command is provided by the python-gerritclient plugin.

server task list¶

Lists the tasks from the background work queues that the Gerrit daemons

is currently performing, or will perform in the near future.

gerrit server task list
    [-f {csv,json,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--quote {all,minimal,none,nonnumeric}]
    [--sort-column SORT_COLUMN]

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--quote <QUOTE_MODE>¶: when to include quotes, defaults to nonnumeric

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

This command is provided by the python-gerritclient plugin.

server task show¶

Retrieves a task from the background work queue that the Gerrit daemon

is currently performing, or will perform in the near future.

gerrit server task show
    [-f {json,shell,table,value,yaml}]
    [-c COLUMN]
    [--max-width <integer>]
    [--fit-width]
    [--print-empty]
    [--noindent]
    [--prefix PREFIX]
    task-identifier

-f <FORMATTER>, --format <FORMATTER>¶: the output format, defaults to table

-c COLUMN, --column COLUMN¶: specify the column(s) to include, can be repeated

--max-width <integer>¶: Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width¶: Fit the table to the display width. Implied if –max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty¶: Print empty table if there is no data to show.

--noindent¶: whether to disable indenting the JSON

--prefix <PREFIX>¶: add a prefix to all variable names

task-identifier¶: The ID of the task (hex string).

This command is provided by the python-gerritclient plugin.

server version¶

Returns the version of the Gerrit server.

gerrit server version

This command is provided by the python-gerritclient plugin.