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.