table of contents
| GIT-OBS(1) | Generated Python Manual | GIT-OBS(1) |
NAME¶
git-obs - Git based command-line client for Open Build Service
SYNOPSIS¶
git-obs [global opts] <command> [--help] [opts] [args]
DESCRIPTION¶
git-obs is a command-line client for interacting with Git repositories within a Gitea instance that is part of an Open Build Service (OBS).
OPTIONS¶
- --gitea-config GITEA_CONFIG
- Path to gitea config. Default: $GIT_OBS_CONFIG or ~/.config/tea/config.yml.
- -G GITEA_LOGIN, --gitea-login GITEA_LOGIN
- Name of the login entry in the config file. Default: $GIT_OBS_LOGIN or the
default entry from the config file. Alternatively, you can omit this
argument and set GIT_OBS_GITEA_URL, GIT_OBS_GITEA_USER, and
GIT_OBS_GITEA_TOKEN environmental variables instead. Optional variables:
GIT_OBS_GITEA_SSH_KEY
To override the existing values from the config file, you can specify the following environmental variables:
- GIT_OBS_LOGIN_<LOGIN-NAME>_USER
- GIT_OBS_LOGIN_<LOGIN-NAME>_TOKEN
- GIT_OBS_LOGIN_<LOGIN-NAME>_SSH_KEY Setting new ``name`` or ``url`` is not possible. Please note that the login name that is part of the environmental variable name is case sensitive.
COMMANDS¶
git-obs api¶
Make an arbitrary request to API
usage: git-obs [global opts] api [-h] [-X
{GET,HEAD,POST,PATCH,PUT}]
[--data DATA]
url
arguments:
options:
git-obs login¶
Manage configured credentials to Gitea servers
git-obs [global opts] login
usage: git-obs [global opts] login [-h]
{add,gitcredentials-helper,list,remove,update} ...
git-obs login add¶
Add a Gitea credentials entry
usage: git-obs [global opts] add [-h] --url URL --user USER
[--token TOKEN]
[--ssh-key PATH] [--git-uses-http]
[--set-as-default]
name
arguments:
- name
- The name of the login entry to be added
options:
- --url URL
- Gitea URL, for example https://example.com
- --user USER
- Gitea username
- --token TOKEN
- Gitea access token; omit or set to '-' to invoke a secure interactive prompt
- --ssh-key PATH
- Path to a private SSH key
- --git-uses-http
- Git uses http(s) instead of SSH
- --set-as-default
- Set the new login entry as default
git-obs login list¶
List Gitea credentials entries
usage: git-obs [global opts] list [-h] [--show-tokens]
options:
- --show-tokens
- Show tokens in the output
git-obs login remove¶
Remove a Gitea credentials entry
usage: git-obs [global opts] remove [-h] name
arguments:
- name
- The name of the login entry to be removed
git-obs login update¶
Update a Gitea credentials entry
usage: git-obs [global opts] update [-h] [--new-name NEW_NAME]
[--new-url URL]
[--new-user USER] [--new-token TOKEN]
[--new-ssh-key PATH]
[--new-git-uses-http {0,1,yes,no}]
[--set-as-default]
name
arguments:
- name
- The name of the login entry to be updated
options:
- --new-name NEW_NAME
- New name of the login entry
- --new-url URL
- New Gitea URL, for example https://example.com
- --new-user USER
- Gitea username
- --new-token TOKEN
- Gitea access token; set to '-' to invoke a secure interactive prompt
- --new-ssh-key PATH
- Path to a private SSH key
- --new-git-uses-http {0,1,yes,no}
- Git uses http(s) instead of SSH
- --set-as-default
- Set the login entry as default
git-obs pr¶
Manage pull requests
git-obs [global opts] pr
usage: git-obs [global opts] pr [-h]
{checkout,create,get,show,list,merge,review,search,set} ...
git-obs pr checkout¶
Check out a pull request
usage: git-obs [global opts] checkout [-h] [-f] pull
arguments:
- pull
- Number of the pull request
options:
- -f, --force
- Reset the existing local branch to the latest state of the pull request
git-obs pr create¶
Create a pull request
usage: git-obs [global opts] create [-h] [--title TEXT]
[--description TEXT]
[--source-owner OWNER]
[--source-repo REPO]
[--source-branch BRANCH]
[--target-branch BRANCH]
options:
- --title TEXT
- Pull request title
- --description TEXT
- Pull request description (body)
- --source-owner OWNER
- Owner of the source repo (default: derived from remote URL in local git repo)
- --source-repo REPO
- Name of the source repo (default: derived from remote URL in local git repo)
- --source-branch BRANCH
- Source branch (default: the current branch in local git repo)
- --target-branch BRANCH
- Target branch (default: derived from the current branch in local git repo)
git-obs pr get (show)¶
Get details about the specified pull requests
usage: git-obs [global opts] get [-h] [-p]
owner_repo_pull [owner_repo_pull ...]
arguments:
- owner_repo_pull
- Owner, repo and pull request number (format: <owner>/<repo>#<pull-request-number>)
options:
- -p, --patch
- Show patches associated with the pull requests
git-obs pr list¶
List pull requests in a repository
usage: git-obs [global opts] list [-h] [--state {open,closed,all}]
[--reviewer REVIEWERS]
[--review-state {REQUEST_REVIEW,APPROVED}]
[--target-branch TARGET_BRANCHES]
[--no-draft] [--export]
owner_repo [owner_repo ...]
arguments:
- owner_repo
- Owner and repo: (format: <owner>/<repo>)
options:
- --state {open,closed,all}
- State of the pull requests (default: open)
- --reviewer REVIEWERS
- Filter by reviewer. Team reviewers start with '@'.
- --review-state {REQUEST_REVIEW,APPROVED}
- Filter by review state. Needs to be used with ``--reviewer``.
- --target-branch TARGET_BRANCHES
- Filter by target branch.
- --no-draft
- Filter by draft flag. Exclude pull requests with draft flag set.
- --export
- Show json objects instead of human readable text
git-obs pr merge¶
Merge pull requests
usage: git-obs [global opts] merge [-h] [--now] id [id ...]
arguments:
- id
- Pull request ID in <owner>/<repo>#<number> format
options:
- --now
- Merge immediately, don't wait until all checks succeed.
git-obs pr review¶
Manage pull request reviews
git-obs [global opts] review
usage: git-obs [global opts] review [-h] {approve,decline,interactive} ...
git-obs pr review approve¶
Approve pull request reviews
usage: git-obs [global opts] approve [-h] [--message MESSAGE]
[--commit COMMIT]
id [id ...]
arguments:
- id
- Pull request ID in <owner>/<repo>#<number> format
options:
- --message MESSAGE
- Justification of the review state change
- --commit COMMIT
- Pin the review to the specified commit
git-obs pr review decline¶
Decline pull request reviews (request changes)
usage: git-obs [global opts] decline [-h] --message MESSAGE
[--commit COMMIT]
id [id ...]
arguments:
- id
- Pull request ID in <owner>/<repo>#<number> format
options:
- --message MESSAGE
- Justification of the review state change
- --commit COMMIT
- Pin the review to the specified commit
git-obs pr review interactive¶
Interactive review of pull requests
usage: git-obs [global opts] interactive [-h] [id ...]
arguments:
- id
- Pull request ID in <owner>/<repo>#<number> format
git-obs pr search¶
Search pull requests in the whole gitea instance
usage: git-obs [global opts] search [-h] [--state {open,closed}]
[--title TITLE] [--owner OWNER]
[--label LABEL] [--assigned] [--created]
[--mentioned] [--review-requested]
[--export]
options:
- --state {open,closed}
- Filter by state: open, closed (default: open)
- --title TITLE
- Filter by substring in title
- --owner OWNER
- Filter by owner of the repository associated with the pull requests
- --label LABEL
- Filter by associated labels. Non existent labels are discarded. Can be specified multiple times.
- --assigned
- Filter pull requests assigned to you
- --created
- Filter pull requests created by you
- --mentioned
- Filter pull requests mentioning you
- --review-requested
- Filter pull requests requesting your review
- --export
- Show json objects instead of human readable text
git-obs pr set¶
Change a pull request
usage: git-obs [global opts] set [-h] [--title TITLE]
[--description DESCRIPTION]
[--allow-maintainer-edit ALLOW_MAINTAINER_EDIT]
owner_repo_pull [owner_repo_pull ...]
arguments:
- owner_repo_pull
- Owner, repo and pull request number (format: <owner>/<repo>#<pull-request-number>)
options:
- --title TITLE
- --description DESCRIPTION
- --allow-maintainer-edit ALLOW_MAINTAINER_EDIT
- Users with write access to the base branch can also push to the pull request's head branch
git-obs repo¶
Manage git repos
git-obs [global opts] repo
usage: git-obs [global opts] repo [-h] {clone,fork,list} ...
git-obs repo clone¶
Clone a git repo
usage: git-obs [global opts] clone [-h] [-a] [-i SSH_KEY]
[--no-ssh-strict-host-key-checking]
[--directory DIRECTORY]
owner_repo [owner_repo ...]
NOTE: Some of the options may result in setting "core.sshCommand" config option in the git repository."
arguments:
- owner_repo
- Owner and repo: (format: <owner>/<repo>)
options:
- -a, --anonymous
- Clone anonymously via the http protocol
- -i SSH_KEY, --ssh-key SSH_KEY
- Path to a private SSH key (identity file)
- --no-ssh-strict-host-key-checking
- Set 'StrictHostKeyChecking no' ssh option
- --directory DIRECTORY
- Clone into the given directory
git-obs repo fork¶
Fork a git repo
usage: git-obs [global opts] fork [-h] [--new-repo-name
NEW_REPO_NAME]
owner_repo [owner_repo ...]
arguments:
- owner_repo
- Owner and repo: (format: <owner>/<repo>)
options:
- --new-repo-name NEW_REPO_NAME
- Name of the newly forked repo
git-obs repo list¶
List repos
usage: git-obs [global opts] list [-h] [--org ORG_LIST] [--user
USER_LIST]
[--export]
Required permissions:
read:organization
read:user
options:
- --org ORG_LIST
- List repos owned by the specified organizations
- --user USER_LIST
- List repos owned by the specified users
- --export
- Show json objects instead of human readable text
git-obs ssh-key¶
Manage public SSH keys
git-obs [global opts] ssh-key
usage: git-obs [global opts] ssh-key [-h] {add,list,remove} ...
git-obs ssh-key add¶
usage: git-obs [global opts] add [-h] (--key KEY | --key-path PATH)
options:
- --key KEY
- SSH public key
- --key-path PATH
- Path to the SSH public key
git-obs ssh-key list¶
usage: git-obs [global opts] list [-h]
git-obs ssh-key remove¶
usage: git-obs [global opts] remove [-h] id
arguments:
- id
- Id of the SSH public key
AUTHOR¶
Contributors to the osc project. See the project's GIT history for the complete list.
DISTRIBUTION¶
The latest version of osc may be downloaded from https://github.com/openSUSE/osc/
| 2025-06-24 | osc |