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 list¶
Lists the tags of a project.
Only includes tags under the refs/tags/ namespace.
gerrit project tag 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]
[-m MATCH | -r REGEX]
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
-
-l
<LIMIT>
,
--limit
<LIMIT>
¶ Limit the number of tags to be included in the results.
-
-S
<SKIP>
,
--skip
<SKIP>
¶ Skip the given number of tags from the beginning of the list.
-
-m
<MATCH>
,
--match
<MATCH>
¶ Limit the results to those tags that match the specified substring. The match is case insensitive.
-
-r
<REGEX>
,
--regex
<REGEX>
¶ Limit the results to those tags that match the specified regex. The match is case sensitive.
-
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.