OSC(1)

πŸ’– OSC(1) πŸ’– β€” the Open Build Service command-line bestie

Generated Python Manual ✨ (yes bestie, that's literally the section the manual says we're in, and we're staying in it)


✨ NAME ✨

osc β€” Command-line client for Open Build Service


🌸 SYNOPSIS 🌸

osc [global opts] <command> [--help] [opts] [args]

That's the whole vibe. Global opts first, command next, then whatever that command wants. 🫢


πŸ’… OPTIONS πŸ’…

These are the global ones β€” they go before the command, okay? Like a little outfit you put on before you leave the house. πŸŽ€

  • -v, --verbose β€” crank the verbosity up πŸ’¬ (heads up: this conflicts with --quiet)
  • -q, --quiet β€” be quiet, not verbose 🀫 (and yeah, it conflicts with --verbose)
  • --debug β€” print info useful for debugging πŸ”
  • --debugger β€” jump into the debugger before executing anything πŸ›
  • --post-mortem β€” jump into the debugger when stuff goes wrong πŸ’€
  • --traceback β€” print the call trace when errors happen πŸ“œ
  • -H, --http-debug β€” debug HTTP traffic (it filters out some headers) 🌐
  • --http-full-debug β€” debug HTTP traffic, and this one filters no headers at all πŸ‘€
  • -A URL, --apiurl URL β€” the Open Build Service API URL, or a configured alias πŸ”—
  • --config FILE β€” point at an alternate config file πŸ—‚οΈ
  • --setopt KEY=VALUE β€” set a config option just for the current program run βš™οΈ
  • --no-keyring β€” disable usage of the desktop keyring system πŸ”
  • --no-pager β€” disable the pager in stdout output πŸ“„

πŸ‘‘ COMMANDS πŸ‘‘

Okay so this is the big part. Every command, no skipping, we're doing this properly. πŸ’ͺ

πŸ“ osc fork

Fork a scmsync project or a package with sources managed in Gitea 🍴

usage: osc [global opts] fork [-h] [-q] [--gitea-config GITEA_CONFIG]
                              [-G GITEA_LOGIN]
                              [--target-project TARGET_PROJECT]
                              [--target-package TARGET_PACKAGE]
                              [--gitea-fork-org GITEA_FORK_ORG]
                              [--new-repo-name NEW_REPO_NAME]
                              [--git-branch GIT_BRANCH]
                              [--no-devel-project]
                              project [package]

Make a local checkout to be reviewed and pushed to the target branch, and here's why bestie:

  • The target branch may or may not exist.
  • If the target branch exists, it may contain outdated or unrelated contents.
  • The branch may be used in scmsync packages or linked to git projects as a submodule, changing the branch impacts them all.

arguments:

  • project β€” Name of the project
  • package β€” Name of the package

options:

  • -q, --quiet β€” Mute unnecessary output 🀐
  • --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 use gitea url as long as there's only a single matching entry in the config file.

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. ⚠️ And please note that the login name that is part of the environmental variable name is case sensitive (iykyk, casing will humble you).

  • --target-project TARGET_PROJECT β€” Name of the target project (defaults to home:$user:branches)
  • --target-package TARGET_PACKAGE β€” Name of the package (defaults to $package)
  • --gitea-fork-org GITEA_FORK_ORG β€” Name of the org owning the fork
  • --new-repo-name NEW_REPO_NAME β€” Name of the newly forked repo
  • --git-branch GIT_BRANCH β€” Name of the new git branch
  • --no-devel-project β€” Fork the specified package instead the package from the devel project (which is the place where the package is developed)

πŸ¦‹ osc person

Manage persons πŸ‘€

usage: osc [global opts] person [-h] {register,search} ...

🌈 osc person register

Register a new person (user) πŸ“

usage: osc [global opts] register [-h] --login LOGIN --realname REALNAME
                                  --email EMAIL [--password PASSWORD]
                                  [--note NOTE] [--state STATE]

options:

  • --login LOGIN β€” Login.
  • --realname REALNAME β€” Real name of the person.
  • --email EMAIL β€” Email address.
  • --password PASSWORD β€” Password. An interactive prompt is shown if password is not specified. πŸ”‘
  • --note NOTE β€” Any notes about the person.
  • --state STATE β€” State of the account. Defaults to 'unconfirmed'.

Search a person (user) πŸ”Ž

usage: osc [global opts] search [-h] [--login LOGIN] [--login-contains SUBSTR]
                                [--realname-contains SUBSTR] [--email EMAIL]
                                [--email-contains SUBSTR]

options:

  • --login LOGIN β€” Search by a login.
  • --login-contains SUBSTR β€” Search by a substring in a login.
  • --realname-contains SUBSTR β€” Search by a substring in a realname.
  • --email EMAIL β€” Search by an email address.
  • --email-contains SUBSTR β€” Search by a substring in an email address.

🧚 osc repo

Manage repositories in project meta πŸ—ƒοΈ

usage: osc [global opts] repo [-h] {add,list,ls,remove,rm} ...

πŸŽ€ osc repo add

Add a repository to project meta βž•

usage: osc [global opts] add [-h] --repo NAME --arch [ARCH]
                             --path [PROJECT/REPO] [--disable-publish] [--yes]
                             project

arguments:

  • project β€” Name of the project

options:

  • --repo NAME β€” Name of the repository we're adding
  • --arch [ARCH] β€” Architecture of the repository. Can be specified multiple times. πŸ—οΈ
  • --path [PROJECT/REPO] β€” Path associated to the repository. Format is PROJECT/REPO. Can be specified multiple times.
  • --disable-publish β€” Disable publishing the added repository 🚫
  • --yes β€” Proceed without asking βœ…

πŸ“‹ osc repo list (ls)

List repositories in project meta πŸ“œ

usage: osc [global opts] list [-h] project

arguments:

  • project β€” Name of the project

πŸ—‘οΈ osc repo remove (rm)

Remove repositories from project meta ❌

usage: osc [global opts] remove [-h] --repo [NAME] [--yes] project

arguments:

  • project β€” Name of the project

options:

  • --repo [NAME] β€” Name of the repository we're removing. Can be specified multiple times.
  • --yes β€” Proceed without asking βœ…

⭐ osc rmkpac

Make a package on OBS side. πŸ“¦

usage: osc [global opts] rmkpac [-h] [--scmsync SCMSYNC] [--force]
                                project package

The primary goal is to provide a convenient way for creating new package with scmsync enabled ✨

arguments:

  • project β€” Name of the project or . for current directory
  • package β€” Name of the new package

options:

  • --scmsync SCMSYNC β€” URL to put to the scmsync tag in _meta file
  • --force β€” Overwrite existing package, if any πŸ’₯

🫢 osc add

Mark files to be added upon the next commit πŸ“Œ

usage: osc [global opts] add [-h] [-f]

In case a URL is given the file will get downloaded and registered to be downloaded by the server as well via the download_url source service. 🌐

This is recommended for release tar balls to track their source and to help others to review your changes esp. on version upgrades. 🎁

usage:

    osc add URL [URL...]
    osc add FILE [FILE...]

options:

  • -f, --force β€” add files even if they are excluded by the exclude_glob config option

🌟 osc addchannels

Add channels to project πŸ“‘

usage: osc [global opts] addchannels [-h] [-s] [-e]

The command adds all channels which are defined to be used for a given source package. The source link target is used to lookup the channels. The command can be used for a certain package or for all in the specified project.

In case no channel is defined the operation is just returning. πŸ«₯

Examples:

    osc addchannels [PROJECT [PACKAGE]]

options:

  • -s, --skip-disabled β€” Skip disabled channels. Otherwise the source gets added, but not the repositories.
  • -e, --enable-all β€” Enable all added channels including the ones disabled by default.

πŸ’œ osc addcontainers

Add maintained containers for a give package πŸ“¦ (yes, "give" β€” that's what the manual says, we don't fix quotes, we respect them πŸ’…)

usage: osc [global opts] addcontainers [-h] [--extend-package-names]

The command adds all containers which are marked as maintained and contain an rpm originating from the specified source package. 🐳

Examples:

    osc addcontainers [PROJECT PACKAGE]

options:

  • --extend-package-names β€” Extend packages names with project name as suffix

🌸 osc addremove (ar)

Adds new files, removes disappeared files ✨

usage: osc [global opts] addremove [-h] [-r]

Adds all files new in the local copy, and removes all disappeared files.

ARG, if specified, is a package working copy.

options:

  • -r, --recursive β€” If CWD is a project dir then scan all package dirs as well πŸ”

πŸ”₯ osc aggregatepac

"Aggregate" a package to another package 🧲

usage: osc [global opts] aggregatepac [-h] [--nosources]
                                      [-m SRC=TARGET[,SRC=TARGET]] [-d]

Aggregation of a package means that the build results (binaries) of a package are basically copied into another project. This can be used to make packages available from building that are needed in a project but available only in a different project. Note that this is done at the expense of disk space. πŸ’Ύ See http://en.opensuse.org/openSUSE:Build_Service_Tips_and_Tricks#link_and_aggregate for more information.

The DESTPAC name is optional; the source packages' name will be used if DESTPAC is omitted.

usage:

    osc aggregatepac SOURCEPRJ SOURCEPAC[:FLAVOR] DESTPRJ [DESTPAC]

options:

  • --nosources β€” ignore source packages when copying build results to destination project πŸ™ˆ
  • -m SRC=TARGET[,SRC=TARGET], --map-repo SRC=TARGET[,SRC=TARGET] β€” lets you hand over repo mapping(s) in that exact SRC=TARGET[,SRC=TARGET] shape πŸ’«
  • -d, --disable-publish β€” turns OFF publishing of the aggregated package, so nothing goes out the door πŸšͺ

πŸ¦‹ osc api

Issues an arbitrary request to the API. Yes bestie, any request. It's giving "let me just poke the server directly" 😌

usage:

osc [global opts] api [-h] [-X HTTP_METHOD] [-e] [-d STRING] [-T FILE]
                      [-a NAME STRING NAME STRING]
                      url

Super useful for testing. Like, testing testing. πŸ§ͺ

The URL can be given either partially (just the path component) or fully with URL scheme and hostname ('http://...').

Heads up: the global -A and -H options matter here (peep osc help).

Examples, because examples are everything:

osc api /source/home:user
osc api -X PUT -T /etc/fstab source/home:user/test5/myfstab
osc api -e /configuration

arguments:

  • url β€” either a URL like '/path' or a full URL like 'scheme://hostname/path' 🌸

options:

  • -X HTTP_METHOD, -m HTTP_METHOD, --method HTTP_METHOD β€” specify the HTTP method to use (HEAD|GET|PUT|DELETE|POST) πŸ› οΈ
  • -e, --edit β€” GET it, edit it, then PUT it back at that location. Chef's kiss workflow ✨
  • -d STRING, --data STRING β€” specify string data for, say, a POST πŸ“¨
  • -T FILE, -f FILE, --file FILE β€” specify a filename to upload; it uses PUT mode by default ⬆️
  • -a NAME STRING NAME STRING, --add-header NAME STRING NAME STRING β€” add the specified header to the request πŸŽ€

🌈 osc branch (also known as getpac, bco, branchco)

Branches a package πŸ’…

usage:

osc [global opts] branch [-h] [--nodevelproject] [-c] [-f]
                         [--add-repositories]
[--extend-package-names]
                         [--noaccess] [-m TEXT] [-M] [-N] [-r rev]
                         [--linkrev linkrev]
                         [--add-repositories-block
add_repositories_block]
                         [--add-repositories-rebuild
add_repositories_rebuild]
                         [--disable-build]

[See http://en.opensuse.org/openSUSE:Build_Service_Collaboration for information on this topic.] πŸ“š

Creates a source link from a package of an existing project to a new subproject of the requester's home project (home:branches:).

The branched package will live in

home:USERNAME:branches:PROJECT/PACKAGE

if nothing else is specified. 🏠

With getpac or bco, the branched package will come from one of

%(getpac_default_project)s

(list of projects from oscrc:getpac_default_project) if nothing else is specified on the command line.

In case of branch errors, where the source currently has merge conflicts, use the --linkrev=base option. 😭

usage:

osc branch
osc branch SOURCEPROJECT SOURCEPACKAGE
osc branch SOURCEPROJECT SOURCEPACKAGE TARGETPROJECT|.
osc branch SOURCEPROJECT SOURCEPACKAGE TARGETPROJECT|. TARGETPACKAGE
osc getpac SOURCEPACKAGE
osc bco ...

options:

  • --nodevelproject β€” do not follow a defined devel project (that's the primary project where a package is developed) πŸ™…β€β™€οΈ
  • -c, --checkout β€” check out the branched package afterwards using "co -e -S" ('osc bco' is literally a shorthand for this option) πŸ›οΈ
  • -f, --force β€” force the branch, overwrite the target πŸ’₯
  • --add-repositories β€” add repositories to the target project (this happens by default when the project is new) πŸ—οΈ
  • --extend-package-names β€” extend package names with the project name as a suffix 🏷️
  • --noaccess β€” create a hidden project πŸ™ˆ
  • -m TEXT, --message TEXT β€” specify message TEXT ✍️
  • -M, --maintenance β€” create the project and package in maintenance mode πŸ”§
  • -N, --new-package β€” create a branch pointing to a not-yet-existing package πŸ‘»
  • -r rev, --revision rev β€” branch against a specific revision πŸ“Œ
  • --linkrev linkrev β€” specify the used revision in the link target 🎯
  • --add-repositories-block add_repositories_block β€” specify the used block strategy for new repositories 🧱
  • --add-repositories-rebuild add_repositories_rebuild β€” specify the used rebuild strategy for new repositories πŸ”
  • --disable-build β€” disable building of the branched package 🚫

πŸŽ€ osc browse

Opens browser 🌐

usage:

osc [global opts] browse [-h]

usage:

osc browse [PROJECT [PACKAGE]]
osc browse [REQUEST_ID]

πŸ‘‘ osc build (also wipe, shell, chroot)

Build a package on your local machine πŸ–₯️πŸ”₯

usage:

osc [global opts] build [-h] [--clean] [-o] [-l] [--no-changelog]
                               [--rsync-src RSYNCSRCPATH]
                               [--rsync-dest RSYNCDESTPATH]
                               [--overlay OVERLAY] [--noinit] [--checks]
                               [--nochecks] [--no-verify]
[--nodebugpackages]
                               [--skip-local-service-run] [-p DIR] [-k DIR]
                               [-M FLAVOR] [-x PAC] [-X FILE] [--root ROOT]
                               [-j N] [-t N] [--icecream N] [--ccache]
                               [--pkg-ccache /path/to/_ccache.tar]
                               [--sccache]
                               [--sccache-uri redis://127.0.0.1:6389]
                               [--with X] [--without X] [--define 'X Y']
                               [--build-opt OPT] [--buildtool-opt OPT]
                               [--userootforbuild]
                               [--build-uid uid:gid|"caller"]
                               [--local-package] [--stage STAGE]
                               [--linksources] [--vm-memory MEMORY]
                               [--vm-disk-size DISKSIZE] [--vm-type TYPE]
                               [--vm-telnet TELNET] [--target TARGET]
                               [--alternative-project PROJECT] [-d]
                               [--disable-debuginfo] [-b] [--release N]
                               [--disable-cpio-bulk-download]
                               [--download-api-only] [--oldpackages DIR]
                               [--verbose-mode MODE]
[--shell-after-fail]
                               [--shell-cmd COMMAND] [-f] [--host HOST]
                               [--trust-all-projects]
[--nopreinstallimage]
                               [--just-print-buildroot] [--buildinfo]
                               [--buildinfo-debug] [--no-timestamps]

The command works from a package checkout (local changes are fine, no stress πŸ’–).

You can use osc repos to look up REPOSITORY and ARCH arguments. If they are not set, osc chooses from configured repos in this priority:

  1. build_repository mentioned in config file
  2. "standard"
  3. "openSUSE_Factory"
  4. "openSUSE_Tumbleweed"
  5. last repo from the sorted list

BUILD_DESCR is either a RPM spec file, or a Debian dsc file. πŸ“„

The command honors packagecachedir, build-root and build-uid settings in oscrc, if present. You may want to set su-wrapper = 'sudo' in oscrc, and configure sudo with option NOPASSWD for /usr/bin/build. πŸ”

If neither --clean nor --noinit is given, build will reuse an existing build-root again, removing unneeded packages and adding missing ones. This is usually the fastest option. ⚑

If the package doesn't exist on the server please use the --local-package option. If the project of the package doesn't exist on the server use the --alternative-project <alternative-project> option. Example:

osc build [OPTS] --alternative-project openSUSE:10.3 standard i586 BUILD_DESCR

usage:

osc build [OPTS]                      # will try to guess a build environment
osc build [OPTS] REPOSITORY ARCH BUILD_DESCR
osc build [OPTS] REPOSITORY ARCH
osc build [OPTS] REPOSITORY (ARCH = hostarch, BUILD_DESCR is detected automatically)
osc build [OPTS] ARCH (REPOSITORY = build_repository (config option), BUILD_DESCR is detected automatically)
osc build [OPTS] BUILD_DESCR (REPOSITORY = build_repository (config option), ARCH = hostarch)
osc build [OPTS] (REPOSITORY = build_repository (config option), ARCH = hostarch, BUILD_DESCR is detected automatically)

For debugging after a build you can jump into the build environment:

osc shell [OPTS] REPOSITORY ARCH

Run a single command inside of the build environment:

osc shell --shell-cmd=COMMAND [OPTS] REPOSITORY ARCH

Useful shell OPTS 🐚

--noinit             # for faster run
--shell-cmd=COMMAND
--shell-after-fail
--extra-pkgs=PACKAGE # install additional packages

To clean up the build environment run

osc wipe [OPTS]
osc wipe [OPTS] REPOSITORY ARCH

If you've set the used VM type in oscrc, it can be also overridden here

--vm-type=chroot     # for faster, but uncleaner and unsecure build
--vm-type=kvm        # for clean and secure build
--vm-type=qemu       # for slow cross architecture build using system emulator
# Note: # Configuration can be overridden by envvars, e.g.  #
OSC_SU_WRAPPER overrides the setting of su-wrapper.  # OSC_BUILD_ROOT
overrides the setting of build-root.  # OSC_PACKAGE_CACHE_DIR overrides
the setting of packagecachedir.

options:

  • --clean β€” delete the old build root before initializing it 🧼
  • -o, --offline β€” start with cached prjconf and packages without contacting the api server πŸ“΄
  • -l, --preload β€” preload all files into the cache for offline operation πŸ“¦
  • --no-changelog β€” don't update the package changelog from a changes file πŸ“
  • --rsync-src RSYNCSRCPATH β€” copy folder to buildroot after installing all RPMs. Use together with --rsync-dest. This is the path on the HOST filesystem, e.g. /tmp/linux-kernel-tree. It defines RSYNCDONE 1. πŸ—‚οΈ
  • --rsync-dest RSYNCDESTPATH β€” copy folder to buildroot after installing all RPMs. Use together with --rsync-src. This is the path on the TARGET filesystem, e.g. /usr/src/packages/BUILD/linux-2.6. 🎯
  • --overlay OVERLAY β€” copy overlay filesystem to buildroot after installing all RPMs πŸ§…
  • --noinit, --no-init β€” skip initialization of build root and start with build immediately ⏩
  • --checks β€” run checks even if disabled in the build config βœ…
  • --nochecks, --no-checks β€” do not run build checks on the resulting packages ❌
  • --no-verify, --noverify β€” skips the whole signature-checking moment (the pgp keys thing) for the packages you're building with. Global config key in oscrc: no_verify ✨
  • --nodebugpackages, --no-debug-packages β€” don't install those extra debug packages for CLI builds (the ones specified by obs:cli_debug_packages in the project metadata). Lowkey trims the install list πŸ’…
  • --skip-local-service-run, --noservice, --no-service β€” skips running the local source services that are specified in the _service file. Not me dodging the service run πŸ™ˆ
  • -p DIR, --prefer-pkgs DIR β€” when installing the build-root, prefer packages from this directory. Bestie's faves first. πŸ’–
  • -k DIR, --keep-pkgs DIR β€” saves the built packages into this directory, so they don't just vanish into the void πŸŽ€
  • -M FLAVOR, --multibuild-package FLAVOR β€” only work with the specified flavor of a multibuild package. Pick your fighter ⭐
  • -x PAC, --extra-pkgs PAC β€” add this package when installing the build-root, like a little bonus πŸ¦‹
  • -X FILE, --extra-pkgs-from FILE β€” add every package listed in this file when installing the build-root. A whole roster of extras πŸ“‹
  • --root ROOT β€” build in the specified directory. See oscrc(5) for the supported substitutions. Yes, there are substitutions, go read them.
  • -j N, --jobs N β€” compile with N jobs πŸ”₯
  • -t N, --threads N β€” compile with N threads 🧡
  • --icecream N β€” use N parallel build jobs with icecream 🍦 (the distributed build kind, not the dessert kind, sadly)
  • --ccache β€” use ccache to speed up rebuilds. Rebuilds go brrr ⚑
  • --pkg-ccache /path/to/_ccache.tar β€” path to an existing uncompressed archive ccache. Using this option implies --ccache ✨
  • --sccache β€” use sccache to speed up rebuilds. Conflicts with --ccache β€” pick one, bestie, you can't have both πŸ’€
  • --sccache-uri redis://127.0.0.1:6389 β€” optional remote URI for sccache storage. Implies --sccache. Look at that example URI living its best life 🌈
  • --with X β€” enable feature X for the build βœ…
  • --without X β€” disable feature X for the build ❌
  • --define 'X Y' β€” define macro X with value Y. Note the quotes, they're doing the heavy lifting 🫢
  • --build-opt OPT β€” pass option OPT to the build command
  • --buildtool-opt OPT β€” pass option OPT to the build tool command (rpmbuild). For example:
    • don't clean the build environment after a successful build:
--buildtool-opt=--noclean
  • --userootforbuild, --login-as-root β€” run build or shell as root. The default is to build as an unprivileged user. Heads up: a line # norootforbuild in the spec file will invalidate this option. The spec file said no and it meant it πŸ’…
  • --build-uid uid:gid|"caller" β€” specify the numeric uid:gid pair to assign to the unprivileged abuild user, or use "caller" to use the current user's uid:gid. Choose your identity era πŸ‘‘
  • --local-package β€” build a package which does not exist on the server. Main character energy, building something the server has never even heard of ✨
  • --stage STAGE β€” runs a specific stage; the default is "a" for all. Append a trailing = to only run the specified stage. Append a trailing + to run the specified stage and all stages coming after it. With no suffix at all, stages up to and including the specified stage are run. Three behaviors, one flag, iconic tbh.
  • --linksources β€” use hard links instead of a deep copied source πŸ”—
  • --vm-memory MEMORY β€” amount of memory for the VM, defined in MB 🧠
  • --vm-disk-size DISKSIZE β€” size for the newly created disk image, in MB πŸ’Ύ
  • --vm-type TYPE β€” use VM type TYPE (e.g. kvm) πŸ–₯️
  • --vm-telnet TELNET β€” launch a telnet server inside of the VM build πŸ“‘
  • --target TARGET β€” define the target platform 🎯
  • --alternative-project PROJECT β€” specify the build target project
  • -d, --debuginfo β€” also build debuginfo sub-packages πŸ›
  • --disable-debuginfo β€” disable the build of debuginfo packages πŸš«πŸ›
  • -b, --baselibs β€” create -32bit/-64bit/-x86 rpms for other architectures. Spreading the love across architectures fr fr πŸ’–
  • --release N β€” set the release number of the package to N
  • --disable-cpio-bulk-download β€” disable downloading packages as a cpio archive from the api πŸ“¦
  • --download-api-only β€” only fetch packages from the api 🫑
  • --oldpackages DIR β€” take the previous build from DIR. Special values: _self, _link πŸ‘€
  • --verbose-mode MODE β€” set the verbose mode of the "build" program; arguments can be "all" or "vm"
  • --shell-after-fail β€” run a shell if the build tool fails. Post-failure shell time, we investigate together πŸ«‚
  • --shell-cmd COMMAND β€” run the specified command instead of bash
  • -f, --force β€” do not ask for confirmation to wipe. It just wipes. No take-backs. πŸ’€
  • --host HOST β€” perform the build on a remote server β€” user@server:~/remote/directory 🌐
  • --trust-all-projects β€” trust packages from all projects. All of them. Every single one. Trust fall, but make it packages 🫢
  • --nopreinstallimage, --no-preinstallimage β€” do not use preinstall images for creating the build root πŸ™…β€β™€οΈ
  • --just-print-buildroot β€” print the build root path and exit. In and out, no notes πŸšͺ
  • --buildinfo β€” print buildinfo and exit πŸ“„
  • --buildinfo-debug β€” print buildinfo in debug mode and exit πŸ”
  • --no-timestamps, -s, --strip-time β€” hide the time prefix in the output. Clean logs, clean mind ✨

πŸ› οΈ osc buildconfig πŸ› οΈ

Shows the build config πŸ’…

usage: osc [global opts] buildconfig [-h]

Shows the build configuration which is used in building a package. This command is mostly used internally by the 'build' command.

The returned data is the project-wide build configuration in a format which is directly readable by the build script. It contains RPM macros and BuildRequires expansions, for example. iykyk

The argument REPOSITORY an be taken from the first column of the

usage:

osc buildconfig REPOSITORY                      (in pkg or prj dir)
osc buildconfig PROJECT REPOSITORY

(yes bestie, that sentence in the original really does just stop mid-thought. we keep every detail, including the cliffhanger πŸ’€)


πŸ“œ osc buildhistory (buildhist) πŸ“œ

Shows the build history of a package πŸ•°οΈ

usage: osc [global opts] buildhistory [-h] [--csv] [-l limit] [-M
FLAVOR]

The arguments REPOSITORY and ARCH can be taken from the first two columns of the 'osc repos' output.

usage:

osc buildhist REPOSITORY ARCHITECTURE
osc buildhist PROJECT PACKAGE[:FLAVOR] REPOSITORY ARCHITECTURE

options:

  • --csv β€” generate output in CSV (separated by |) πŸ“Š
  • -l limit, --limit limit β€” for setting the number of results πŸ”’
  • -M FLAVOR, --multibuild-package FLAVOR β€” only work with the specified flavor of a multibuild package ⭐

πŸ” osc buildinfo πŸ”

Shows the build info 🧐

usage: osc [global opts] buildinfo [-h] [--alternative-project PROJECT] [-d]
                                   [-M FLAVOR] [-x PAC] [-p DIR]
                                   [--nodebugpackages]

Shows the build "info" which is used in building a package. This command is mostly used internally by the 'build' subcommand. It needs to be called from within a package directory. πŸ“‚

The BUILD_DESCR argument is optional. BUILD_DESCR is a local RPM specfile or Debian "dsc" file. If specified, it is sent to the server, and the buildinfo will be based on it. If the argument is not supplied, the buildinfo is derived from the specfile which is currently on the source repository server. 🌐

The returned data is XML and contains a list of the packages used in building, their source, and the expanded BuildRequires. ✨

The arguments REPOSITORY and ARCH are optional. They can be taken from the first two columns of the 'osc repos' output. If not specified, REPOSITORY defaults to the 'build_repository' config entry in your 'oscrc' and ARCH defaults to your host architecture. πŸ’»

usage:

in a package working copy:
    osc buildinfo [OPTS] REPOSITORY ARCH BUILD_DESCR
    osc buildinfo [OPTS] REPOSITORY (ARCH = hostarch, BUILD_DESCR is detected automatically)
    osc buildinfo [OPTS] ARCH (REPOSITORY = build_repository (config option), BUILD_DESCR is detected automatically)
    osc buildinfo [OPTS] BUILD_DESCR (REPOSITORY = build_repository (config option), ARCH = hostarch)
    osc buildinfo [OPTS] (REPOSITORY = build_repository (config option), ARCH = hostarch, BUILD_DESCR is detected automatically)
    Note: if BUILD_DESCR does not exist locally the remote BUILD_DESCR is used

osc buildinfo [OPTS] PROJECT PACKAGE[:FLAVOR] REPOSITORY ARCH [BUILD_DESCR]

options:

  • --alternative-project PROJECT β€” specify the build target project 🎯
  • -d, --debug β€” verbose output of build dependencies πŸ—£οΈ
  • -M FLAVOR, --multibuild-package FLAVOR β€” only work with the specified flavor of a multibuild package ⭐
  • -x PAC, --extra-pkgs PAC β€” add this package when computing the buildinfo βž•
  • -p DIR, --prefer-pkgs DIR β€” prefer packages from this directory when installing the build-root πŸ’–
  • --nodebugpackages, --no-debug-packages β€” skip installation of additional debug packages for CLI builds (specified in obs:cli_debug_packages in project metadata) πŸ›πŸš«

πŸ“Ί osc buildlog (remotebuildlogtail, rbuildlogtail, rblt, remotebuildlog, rbuildlog, rbl, buildlogtail, blt, bl) πŸ“Ί

Shows the build log of a package πŸ“

usage: osc [global opts] buildlog [-h] [-l] [--lastsucceeded] [-M FLAVOR]
                                  [-o OFFSET] [-s]

Shows the log file of the build of a package. Can be used to follow the log while it is being written. πŸ‘€ Live-tweeting your build, essentially.

When called as buildlogtail (or blt) it just shows the end of the logfile. This is useful to see just a build failure reasons. 😭

The arguments REPOSITORY and ARCH are the first two columns in the 'osc results' output.

buildlog [PROJECT PACKAGE REPOSITORY [ARCH] | REPOSITORY ARCH | BUILDLOGURL]

options:

  • -l, --last β€” show the last finished log file πŸ•
  • --lastsucceeded, --last-succeeded β€” show the last succeeded log file βœ…
  • -M FLAVOR, --multibuild-package FLAVOR β€” only work with the specified flavor of a multibuild package ⭐
  • -o OFFSET, --offset OFFSET β€” get log start or end from the offset πŸ“
  • -s, --strip-time β€” strip the leading build time from the log βœ‚οΈ

🐱 osc cat (less, blame) 🐱

Output the content of a file to standard output πŸ–¨οΈ

okay so picking up right where we left off, bestie β€” here's the full tea on osc cat πŸ’…

usage: osc [global opts] cat [-h] [-r rev] [-e] [-u] [-D] [-M]

Examples, eat them up:

osc cat file
osc cat project package file
osc cat project/package/file
osc cat http://api.opensuse.org/build/.../_log
osc cat http://api.opensuse.org/source/../_link

osc less file
osc less project package file

osc blame file
osc blame project package file

Options ✨

  • -r rev, --revision rev β€” print out the specified revision, periodt
  • -e, --expand β€” (this is the default btw) force expansion of linked packages
  • -u, --unexpand β€” always work with unexpanded packages
  • -D, --deleted β€” access file in a deleted package
  • -M, --meta β€” list meta data files

🌸 osc changedevelrequest (changedevelreq, cr) 🌸

Create request to change the devel package definition β€” lowkey iconic behavior

usage: osc [global opts] changedevelrequest [-h] [-m TEXT]

[See http://en.opensuse.org/openSUSE:Build_Service_Collaboration for information on this topic.]

Also go look at the request command if you wanna see and modify requests that already exist, bestie.

usage:

osc changedevelrequest PROJECT PACKAGE DEVEL_PROJECT [DEVEL_PACKAGE]

options:

  • -m TEXT, --message TEXT β€” specify message TEXT

πŸ¦‹ osc checkconstraints πŸ¦‹

Check the constraints and view compliant workers. Vibe check for workers basically.

usage: osc [global opts] checkconstraints [-h] [--ignore-file] [-M FLAVOR]

Checks the constraints for compliant workers.

usage:

remote request:
    osc checkconstraints [OPTS] PROJECT PACKAGE REPOSITORY ARCH [CONSTRAINTSFILE]

in a package working copy:
    osc checkconstraints [OPTS] REPOSITORY ARCH [CONSTRAINTSFILE]
    osc checkconstraints [OPTS] CONSTRAINTSFILE
    osc checkconstraints [OPTS]

options:

  • --ignore-file β€” ignore the _constraints file and only check project constraints
  • -M FLAVOR, --multibuild-package FLAVOR β€” Only work with the specified flavor of a multibuild package.

πŸ’– osc checkout (co) πŸ’–

Check out content from the repository β€” this is the main character command ngl

usage: osc [global opts] checkout [-h] [-r rev] [--linkrev REV] [-e] [-D] [-u]
                                  [-M] [-c] [-o outdir] [-s] [-S]
                                  [-l limit_size] [--native-obs-package]

Check out content from the repository server, creating a local working copy. It's giving "your whole setup, but local".

When checking out a single package, the option --revision can be used to specify a revision of the package to be checked out.

When a package is a source link, then it will be checked out in expanded form. If --unexpand-link option is used, the checkout will instead produce the raw _link file plus patches.

usage:

osc co PROJECT [PACKAGE] [FILE]
   osc co PROJECT                    # entire project
   osc co PROJECT PACKAGE            # a package
   osc co PROJECT PACKAGE FILE       # single file -> to current dir

while inside a project directory:
   osc co PACKAGE                    # check out PACKAGE from project

with the result of rpm -q --qf '%%{DISTURL}\n' PACKAGE
   osc co obs://API/PROJECT/PLATFORM/REVISION-PACKAGE

options:

  • -r rev, --revision rev β€” checkout the specified revision. NOTE: if you checkout the complete project this option is ignored! 🫠
  • --linkrev REV β€” Revision of the link target that is used during link expansion. Use --linkrev=base to checkout the exact revision of a package with _link.
  • -e, --expand-link β€” if a package is a link, check out the expanded sources (no-op, since this became the default)
  • -D, --deleted β€” checkout an already deleted package. No meta information
  • -u, --unexpand-link β€” if a package is a link, check out the _link file instead of the expanded sources
  • -M, --meta β€” checkout out meta data instead of sources
  • -c, --current-dir β€” place PACKAGE folder in the current directory instead of a PROJECT/PACKAGE directory
  • -o outdir, --output-dir outdir β€” place package in the specified directory instead of a PROJECT/PACKAGE directory
  • -s, --source-service-files β€” Run source services.
  • -S, --server-side-source-service-files β€” Use server side generated sources instead of local generation.
  • -l limit_size, --limit-size limit_size β€” Skip all files with a given size
  • --native-obs-package β€” Do not clone native scm repositories: Different representation and you will not be able to submit changes! 😭

πŸŽ€ osc clean πŸŽ€

Removes all untracked files from the package working copy. Spring cleaning but make it git.

usage: osc [global opts] clean [-h] [-n]

Examples:

osc clean <path>
Note: if <path> is omitted it defaults to '.' (<path> has to be a package working copy)
Warning: This command removes all files with status '?'. Like, actually deletes them. Be so fr before you run this πŸ’€

options:

  • -n, --dry-run β€” print the results without actually removing a file

🧚 osc cleanassets (ca) 🧚

Clean all previous downloaded assets. Decluttering era ✨

usage: osc [global opts] cleanassets [-h]

This is useful to prepare a new git commit.


🌈 osc comment 🌈

List / create / delete comments β€” yes, the build service has a comment section and it's lowkey fun

usage: osc [global opts] comment [-h] [-c COMMENT] [-p PARENT]

On create:

If -p is given a reply to the ID is created. Otherwise a toplevel comment is created. If -c is not given the default editor will be opened and you can type your comment.

usage:

osc comment list package PROJECT PACKAGE
osc comment list project PROJECT
osc comment list request REQUEST_ID

osc comment create [-p PARENT_ID] [-c COMMENT] package PROJECT PACKAGE
osc comment create [-p PARENT_ID] [-c COMMENT] project PROJECT
osc comment create [-p PARENT_ID] [-c COMMENT] request REQUEST_ID

osc comment delete ID

options:

  • -c COMMENT, --comment COMMENT β€” comment text
  • -p PARENT, --parent PARENT β€” reply to comment with parent id

⭐ osc commit (checkin, ci) ⭐

Upload content to the repository server. This is the moment of truth, bestie.

usage: osc [global opts] commit [-h] [-m TEXT] [-n] [-F FILE] [-f]
                                [--skip-local-service-run]

Upload content which is changed in your working copy, to the repository server.

examples:

osc ci                   # current dir
osc ci <dir>
osc ci file1 file2 ...

options:

  • -m TEXT, --message TEXT β€” specify log message TEXT
  • -n, --no-message β€” do not specify a log message
  • -F FILE, --file FILE β€” read log message from FILE, '-' denotes standard input.
  • -f, --force β€” Allow empty commit with no changes. When committing a project, allow removing packages even if other packages depend on them.
  • --skip-local-service-run, --noservice, --no-service β€” Skip run of local source services as specified in _service file.

πŸ’œ osc config πŸ’œ

Get/set a config option. Tiny command, huge power.

usage: osc [global opts] config [-h] [-d] [-s] [-p] [--change-password]
                                [--select-password-store] [--no-echo] [--dump]
                                [--dump-full]

Examples:

osc config section option (get current value)
osc config section option value (set to value)
osc config section option --delete (delete option/reset to the default)
osc config section --change-password (changes the password in section "section")
(section is either an apiurl or an alias or 'general')
osc config --dump (dump the complete configuration)

options:

  • -d, --delete β€” delete option from config or reset option to the default)
  • -s, --stdin β€” indicates that the config value should be read from stdin
  • -p, --prompt β€” prompt for a value
  • --change-password β€” Change password
  • --select-password-store β€” Change the password store
  • --no-echo β€” prompt for a value but do not echo entered characters
  • --dump β€” dump the complete configuration (without pass and passx options)
  • --dump-full β€” dump the complete configuration (including pass and passx options)

πŸ“ osc copypac πŸ“

Copy a package. It's giving "ctrl+c ctrl+v but for the build service".

usage: osc [global opts] copypac [-h] [-c] [-k] [-K] [-d] [-r rev] [-t URL]
                                 [-m TEXT] [-e]

A way to copy package to somewhere else.

It can be done across buildservice instances, if the -t option is used. In that case, a client-side copy and link expansion are implied.

Using --client-side-copy always involves downloading all files, and uploading them to the target.

The DESTPAC name is optional; the source packages' name will be used if DESTPAC is omitted.

If SOURCEPRJ or DESTPRJ is '.' it will be expanded to the PRJ of the current directory.

usage:

osc copypac SOURCEPRJ SOURCEPAC DESTPRJ [DESTPAC]

options:

  • -c, --client-side-copy β€” do a (slower) client-side copy
  • -k, --keep-maintainers β€” keep original maintainers. Default is remove all and replace with the one calling the script.
  • -K, --keep-link β€” If the target package is a link, the link is kept, but may be updated. If the source package is a link, its expanded version is considered.
  • -d, --keep-develproject β€” keep develproject tag in the package metadata
  • -r rev, --revision rev β€” copy the specified revision.
  • -t URL, --to-apiurl URL β€” URL of destination api server. Default is the source api server.
  • -m TEXT, --message TEXT β€” specify message TEXT
  • -e, --expand β€” if the source package is a link then copy the expanded version of the link

πŸ‘‘ osc create-pbuild-config (cpc) πŸ‘‘

This command is creating the necessary files to build using pbuild tool.

usage: osc [global opts] create-pbuild-config [-h] repository arch

It basically creates _config and _pbuild file in the project directory. Changes from there can not get submitted back, except the project is managed in git. πŸ™ˆ

Examples:

osc cpc REPOSITORY ARCH

and the two arguments it's asking for are:

  • repository
  • arch

🌸 osc createincident 🌸

Okay so this one creates a maintenance incident ✨

usage: osc [global opts] createincident [-h] [-a ATTRIBUTE] [--noaccess]
                                        [-m TEXT]

[See https://openbuildservice.org/help/manuals/obs-user-guide/cha.obs.maintenance_setup.html for information on this topic.]

So basically this command asks to open an empty maintenance incident, and ngl usually only a responsible maintenance team can even do that πŸ‘‘ Please go look at the mbranch command for how to fill such a project content, and the patchinfo command for how to add the required maintenance update information. iykyk.

usage:

osc createincident [ MAINTENANCEPROJECT ]

options:

  • -a ATTRIBUTE, --attribute ATTRIBUTE β€” use this attribute to find the default maintenance project (the default is OBS:MaintenanceProject)
  • --noaccess β€” create a hidden project πŸ™ˆ
  • -m TEXT, --message TEXT β€” specify message TEXT

πŸ’… osc createrequest (creq) πŸ’…

Create a request with multiple actions β€” multi-tasking queen behavior fr fr.

usage: osc [global opts] createrequest [-h] [-a ACTION [[ARGS] ...]] [-m TEXT]
                                       [-r REV] [-s REQUEST_ID]
                                       [--nodevelproject] [--cleanup]
                                       [--no-cleanup] [--no-update] [--yes]

usage:

osc creq [OPTIONS] [
    -a submit SOURCEPRJ SOURCEPKG DESTPRJ [DESTPKG]
    -a delete PROJECT [PACKAGE]
    -a change_devel PROJECT PACKAGE DEVEL_PROJECT [DEVEL_PACKAGE]
    -a add_me ROLE PROJECT [PACKAGE]
    -a add_group GROUP ROLE PROJECT [PACKAGE]
    -a add_role USER ROLE PROJECT [PACKAGE]
    -a set_bugowner USER PROJECT [PACKAGE]
    -a release PROJECT PACKAGE TARGET_PROJECT [[SOURCE_REPOSITORY] TARGET_REPOSITORY]
    ]

The option -m works for all types of request actions, but the rest work only for submit. πŸ’–

Example:

osc creq -a submit -a delete home:someone:branches:openSUSE:Tools -a change_devel openSUSE:Tools osc home:someone:branches:openSUSE:Tools -m ok

This will submit all modified packages under the current directory, delete project home:someone:branches:openSUSE:Tools and change the devel project to home:someone:branches:openSUSE:Tools for package osc in project openSUSE:Tools. iconic, honestly.

options:

  • -a ACTION [[ARGS] ...], --action ACTION [[ARGS] ...] β€” specify action type of a request, can be : submit/delete/change_devel/add_role/set_bugowner
  • -m TEXT, --message TEXT β€” specify message TEXT
  • -r REV, --revision REV β€” for "create", specify a certain source revision ID (the md5 sum)
  • -s REQUEST_ID, --supersede REQUEST_ID β€” Superseding another request by this one
  • --nodevelproject β€” do not follow a defined devel project (primary project where a package is developed)
  • --cleanup β€” remove package if submission gets accepted (default for home:<id>:branch projects)
  • --no-cleanup β€” never remove source package on accept, but update its content
  • --no-update β€” never touch source package on accept (will break source links) πŸ’€
  • --yes β€” proceed without asking.

πŸ¦‹ osc delete (remove, del, rm) πŸ¦‹

Mark files or package directories to be deleted upon the next 'checkin' ✨

usage: osc [global opts] delete [-h] [-f]

usage:

cd .../PROJECT/PACKAGE
osc delete FILE [...]
cd .../PROJECT
osc delete PACKAGE [...]

Lowkey important: this command works on check out copies. Use rdelete for working on the server side only. That's what you need for removing the entire project.

As a safety measure 🫢 projects must be empty (i.e., you need to delete all packages first).

If you are sure that you want to remove a package and all its files, use the --force switch. Sometimes this also works without --force. Sometimes. no promises.

options:

  • -f, --force β€” forces removal of entire package and its files

πŸŽ€ osc deleterequest (deletereq, droprequest, dropreq, dr) πŸŽ€

Request to delete (or 'drop') a package or project. bye bestie πŸ‘‹

usage: osc [global opts] deleterequest [-h] [-m TEXT] [-r REPOSITORY] [--all]
                                       [--accept-in-hours HOURS]

usage:

osc deletereq [-m TEXT]                     # works in checked out project/package
osc deletereq [-m TEXT] PROJECT PACKAGE
osc deletereq [-m TEXT] PROJECT [--all|--repository REPOSITORY]

options:

  • -m TEXT, --message TEXT β€” specify message TEXT
  • -r REPOSITORY, --repository REPOSITORY β€” specify repository
  • --all β€” deletes entire project with packages inside
  • --accept-in-hours HOURS β€” specify time when request shall get accepted automatically. Only works with write permissions in target. πŸ”‘

🌈 osc dependson 🌈

Dependson shows the build dependencies inside of a project, valid for a given repository and architecture.

usage: osc [global opts] dependson [-h] [-M FLAVOR]

The command can be used to find build dependencies (wrt. a given repository and arch) that reside in the same project. To see all build dependencies use the buildinfo command instead.

This is no guarantee, since the new build might have changed dependencies. ⚠️
NOTE: to see all binary packages, which can trigger a build you need to refer the buildinfo, since this command shows only the dependencies inside of a project.

The arguments REPOSITORY and ARCH can be taken from the first two columns of the osc repos output. cute, right?

usage in package or project directory:

osc dependson REPOSITORY ARCH [-M FLAVOR]

usage:

osc dependson PROJECT [PACKAGE[:FLAVOR]] REPOSITORY ARCH

options:

  • -M FLAVOR, --multibuild-package FLAVOR β€” Only work with the specified flavor of a multibuild package.

✨ osc detachbranch ✨

Replace a link with its expanded sources. glow up moment πŸ’…

usage: osc [global opts] detachbranch [-h] [-m TEXT]

If a package is a link it is replaced with its expanded sources. The link does not exist anymore. it's gone, it's over, periodt.

usage:

osc detachbranch                    # from a package working copy
osc detachbranch PROJECT PACKAGE

options:

  • -m TEXT, --message TEXT β€” specify message TEXT

πŸ’œ osc develproject (dp, bsdevelproject) πŸ’œ

Print the devel project / package of a package.

usage: osc [global opts] develproject [-h]

Examples:

osc develproject [PROJECT PACKAGE]

πŸ”₯ osc diff (di, ldiff, linkdiff) πŸ”₯

Generates a diff. the moment of truth bestie 😭

usage: osc [global opts] diff [-h] [-c rev] [-r rev1[:rev2]] [-M] [-p] [-l]
                              [--missingok] [-u]

Generates a diff, comparing local changes against the repository server.

usage:

    ARG, if specified, is a filename to include in the diff.
    Default: all files.

osc diff --link
osc linkdiff
    Compare current checkout directory against the link base.

osc diff --link PROJ PACK
osc linkdiff PROJ PACK
    Compare a package against the link base (ignoring working copy changes).

options:

  • -c rev, --change rev β€” the change made by revision rev (like -r rev-1:rev). If rev is negative this is like -r rev:rev-1.
  • -r rev1[:rev2], --revision rev1[:rev2] β€” If rev1 is specified it will compare your working copy against the revision (rev1) on the server. If rev1 and rev2 are specified it will compare rev1 against rev2 (NOTE: changes in your working copy are ignored in this case) πŸ™ˆ
  • -M, --meta β€” operate on meta files
  • -p, --plain β€” output the diff in plain (not unified) diff format
  • -l, --link β€” (osc linkdiff): compare against the base revision of the link
  • --missingok β€” do not fail if the source or target project/package does not exist on the server
  • -u, --unexpand β€” Local changes only, ignore changes in linked package sources

πŸ“ osc distributions (dists) πŸ“

Shows all available distributions.

usage: osc [global opts] distributions [-h]

This command shows the available distributions. For active distributions it shows the name, project and name of the repository and a suggested default repository name. so much info, so organized ✨

usage:

osc distributions

🧚 osc downloadassets (da) 🧚

usage: osc [global opts] downloadassets [-h]

that's literally it, bestie. short and sweet πŸ’–


πŸ‘‘ osc enablechannels (enablechannel) πŸ‘‘

Enables channels.

usage: osc [global opts] enablechannels [-h]

Enables existing channel packages in a project. Enabling means adding the needed repositories for building. The command can be used to enable a specific one or all channels of a project. all of them?? slay.

Examples:

osc enablechannels [PROJECT [PACKAGE]]

🌟 osc getbinaries 🌟

Download binaries to a local directory.

usage: osc [global opts] getbinaries [-h] [-d DIR] [-M FLAVOR] [--sources]
                                     [--debuginfo] [--ccache]

This command downloads packages directly from the api server. Thus, it directly accesses the packages that are used for building others even when they are not "published" yet. sneaky but legal πŸ’…

usage:

osc getbinaries REPOSITORY                                 # works in checked out project/package (check out all archs in subdirs)
osc getbinaries REPOSITORY ARCHITECTURE                    # works in checked out project/package
osc getbinaries PROJECT REPOSITORY ARCHITECTURE
osc getbinaries PROJECT PACKAGE REPOSITORY ARCHITECTURE
osc getbinaries PROJECT PACKAGE REPOSITORY ARCHITECTURE FILE

options:

  • -d DIR, --destdir DIR β€” destination directory
  • -M FLAVOR, --multibuild-package FLAVOR β€” Get binaries from the specified flavor of a multibuild package. It is meant for use from a package checkout when it is not possible to specify package:flavor.
  • --sources β€” also fetch source packages
  • --debuginfo β€” also fetch debug packages
  • --ccache β€” allow fetching ccache archive

🫢 osc help (?) 🫢

Give detailed help on a specific sub-command. when you're lost, this is your bestie πŸ₯Ί

usage: osc [global opts] help [-h]

usage:

  %(prog)s [SUBCOMMAND]

⭐ osc importsrcpkg ⭐

Import a new package from a src.rpm

osc importsrcpkg πŸ“¦

okay bestie, this one imports a source RPM and sets you up a whole package dir. iconic behaviour tbh.

usage: osc [global opts] importsrcpkg [-h] [-p project] [-n name] [-t title]
                                      [-d description]
                                      [--delete-old-files]
                                      [-c]
                                      srpm

A new package dir will be created inside the project dir β€” and lowkey here's the tea: if no project is specified and your current working dir is a project dir, the package gets created in that project. If the package doesn't exist on the server yet, it'll be created too; otherwise the meta data of the existing package gets updated (<title /> and <description />). The src.rpm gets extracted into the package dir. And listen β€” the files won't be committed unless you explicitly pass the --commit switch. no cap.

SRPM is the path of the src.rpm in the local filesystem, or an URL.

arguments:

  • srpm β€” the source rpm, either a local path or a URL ✨

options:

  • -p project, --project project β€” specify the path to a project
  • -n name, --name name β€” specify a package name
  • -t title, --title title β€” set a title
  • -d description, --description description β€” set the description of the package
  • --delete-old-files β€” delete existing files from the server
  • -c, --commit β€” commit the new files

osc info πŸ”

Print information about a working copy. that's it, that's the vibe.

usage: osc [global opts] info [-h]

Print information about each ARG (default: '.'). ARG is a working-copy path.


osc init 🐣

Initialize a directory as working copy.

usage: osc [global opts] init [-h] project [package] [scm_url]

Initialize an existing directory to be a working copy of an (already existing) buildservice project/package.

ngl this is literally the same as checking out a package and then copying sources into the directory. It does NOT create a new package. If you want to create a package, use osc meta pkg ... ... 🫢

You wouldn't normally use this command. bestie, we're just being thorough.

To get a working copy of a package (for building it or working on it), you'd normally use the checkout command. Use "osc help checkout" to get help for it.

usage:

osc init PRJ
osc init PRJ PAC
osc init PRJ PAC SCM_URL

arguments:

  • project
  • package
  • scm_url

osc jobhistory (jobhist) πŸ•°οΈ

Shows the job history of a project.

usage: osc [global opts] jobhistory [-h] [--csv] [-l limit] [-M FLAVOR]

The arguments REPOSITORY and ARCH can be taken from the first two columns of the 'osc repos' output. cute, right?

usage:

osc jobhist REPOSITORY ARCHITECTURE  (in project dir)
osc jobhist PROJECT [PACKAGE[:FLAVOR]] REPOSITORY ARCHITECTURE

options:

  • --csv β€” generate output in CSV (separated by |)
  • -l limit, --limit limit β€” for setting the number of results
  • -M FLAVOR, --multibuild-package FLAVOR β€” Only work with the specified flavor of a multibuild package.

osc linkpac πŸ”—

"Link" a package to another package. it's giving clone-with-benefits.

usage: osc [global opts] linkpac [-h] [-C {add,copy,local}] [-c] [-r rev] [-f]
                                 [--disable-build] [-d] [-N]

A linked package is a clone of another package, but plus local modifications. It can be cross-project. πŸ’…

The TARGET_PACKAGE name is optional; the source packages' name will be used if TARGET_PACKAGE is omitted.

Afterwards, you will want to 'checkout TARGET_PROJECT TARGET_PACKAGE'.

To add a patch, add the patch as file and add it to the _link file. You can also specify text which will be inserted at the top of the spec file.

See the examples in the _link file.

NOTE: In case you want to fix or update another package, you should use the 'branch' command. A branch has correct repositories (and a link) setup up by default and will be cleaned up automatically after it was submitted back. fr fr, just use branch.

usage:

osc linkpac PROJECT PACKAGE TARGET_PROJECT [TARGET_PACKAGE]
osc linkpac TARGET_PROJECT [TARGET_PACKAGE]  # from a package checkout

options:

  • -C {add,copy,local}, --cicount {add,copy,local} β€” cicount attribute in the link, known values are add, copy, and local, default in buildservice is currently add.
  • -c, --current β€” link fixed against current revision.
  • -r rev, --revision rev β€” link the specified revision.
  • -f, --force β€” overwrite an existing link file if it is there.
  • --disable-build β€” disable building of the linked package
  • -d, --disable-publish β€” disable publishing of the linked package
  • -N, --new-package β€” create a link to a not yet existing package

osc linktobranch 🌿

Convert a package containing a classic link with patch to a branch.

usage: osc [global opts] linktobranch [-h]

This command tells the server to convert a _link with or without a project.diff to a branch. This is a full copy with a _link file pointing to the branched place. obsessed.

usage:

osc linktobranch                    # from a package working copy
osc linktobranch PROJECT PACKAGE

osc list (LL, lL, ll, ls) πŸ“‹

List sources or binaries on the server. so many aliases, main character energy.

usage: osc [global opts] list [-h] [-a ARCH] [-r REPO] [-b] [-e] [-u] [-l]
                              [-D] [-M] [-R REVISION]

Examples for listing sources:

ls                          # list all projects (deprecated)
ls /                        # list all projects
ls .                        # take PROJECT/PACKAGE from current dir.
ls PROJECT                  # list packages in a project
ls PROJECT PACKAGE          # list source files of package of a project
ls PROJECT PACKAGE <file>   # list <file> if this file exists
ls -v PROJECT PACKAGE       # verbosely list source files of package
ls -l PROJECT PACKAGE       # verbosely list source files of package
ll PROJECT PACKAGE          # verbosely list source files of package
LL PROJECT PACKAGE          # verbosely list source files of expanded link

With --verbose, the following fields will be shown for each item:

  • MD5 hash of file (doesn't apply to binaries)
  • Revision number of the last commit
  • Size (in bytes)
  • Date and time of the last commit

Examples for listing binaries:

ls -b PROJECT               # list all binaries of a project
ls -b PROJECT -a ARCH       # list ARCH binaries of a project
ls -b PROJECT -r REPO       # list binaries in REPO
ls -b PROJECT PACKAGE REPO ARCH

usage:

ls [PROJECT [PACKAGE]]
ls -b [PROJECT [PACKAGE [REPO [ARCH]]]]

options:

  • -a ARCH, --arch ARCH β€” specify architecture (only for binaries)
  • -r REPO, --repo REPO β€” specify repository (only for binaries)
  • -b, --binaries β€” list built binaries instead of sources
  • -e, --expand β€” expand linked package (only for sources)
  • -u, --unexpand β€” always work with unexpanded (source) packages
  • -l, --long β€” print extra information
  • -D, --deleted β€” show only the former deleted projects or packages
  • -M, --meta β€” list meta data files
  • -R REVISION, --revision REVISION β€” specify revision (only for sources)

osc localbuildlog (lbl) πŸ“œ

Shows the build log of a local buildchroot.

usage: osc [global opts] localbuildlog [-h] [-o OFFSET] [-s]

usage:

osc lbl [REPOSITORY [ARCH]]
osc lbl # show log of newest last local build

options:

  • -o OFFSET, --offset OFFSET β€” get log starting from offset
  • -s, --strip-time β€” strip leading build time from the log

osc lock πŸ”’

Locks a project or package.

usage: osc [global opts] lock [-h] [-m TEXT]

usage:

osc lock PROJECT [PACKAGE]

options:

  • -m TEXT, --message TEXT β€” specify log message TEXT

osc log πŸ“

Shows the commit log of a package.

usage: osc [global opts] log [-h] [-r rev] [-p] [--csv] [--xml] [-D] [-M]

usage:

osc log (inside working copy)
osc log remote_project [remote_package]

options:

  • -r rev, --revision rev β€” show log of the specified revision
  • -p, --patch β€” show patch for each revision; NOTE: use this option carefully because it loads patches on demand in a pager
  • --csv β€” generate output in CSV
  • --xml β€” generate output in XML
  • -D, --deleted β€” work on deleted package
  • -M, --meta β€” checkout out meta data instead of sources

osc maintainer (bugowner) πŸ‘‘

Show maintainers according to server side configuration. who's responsible? let's find out bestie.

usage: osc [global opts] maintainer [-h] [-b] [-B] [-e] [--nodevelproject]
                                    [-D devel_project] [-a user] [-A]
                                    [-s user] [-S user] [-U USER] [-G GROUP]
                                    [-d user] [-r role] [-m MESSAGE]
# Search for official maintained sources in OBS instance
osc maintainer BINARY_OR_PACKAGE_NAME <options>
osc maintainer -U <user> <options>
osc maintainer -G <group> <options>

# Lookup via containers
osc maintainer <options>
osc maintainer PRJ <options>
osc maintainer PRJ PKG <options>

The tool looks up the default responsible person for a certain project or package. When using with an OBS 2.4 (or later) server it is doing the lookup for a given binary according to the server side configuration of default owners.

The tool is also looking into devel packages and supports to fallback to the project in case a package has no defined maintainer. 🫢

Please use "osc meta pkg" in case you need to know the definition in a specific container.

PRJ and PKG default to current working-copy path.

options:

  • -b, --bugowner-only β€” Show only the bugowner
  • -B, --bugowner β€” Show only the bugowner if defined, or maintainer otherwise
  • -e, --email β€” show email addresses instead of user names
  • --nodevelproject β€” do not follow a defined devel project (primary project where a package is developed)
  • -D devel_project, --devel-project devel_project β€” define the project where this package is primarily developed
  • -a user, --add user β€” add a new person for given role ("maintainer" by default)
  • -A, --all β€” list all found entries not just the first one
  • -s user, --set-bugowner user β€” sets the bugowner to the person you name (or, if you wanna hand it to a whole group, prefix it with group:). πŸ’–
  • -S user, --set-bugowner-request user β€” same idea but it goes through a request instead of just Doing The Thing. Same group: prefix trick applies. ✨
  • -U USER, --user USER β€” pulls every officially maintained instance for that USER (you can give a username or an email, either one slays).
  • -G GROUP, --group GROUP β€” all the officially maintained instances for the GROUP. πŸ‘‘
  • -d user, --delete user β€” deletes a maintainer/bugowner. You can say who via --role, iykyk.
  • -r role, --role role β€” specifies the user role.
  • -m MESSAGE, --message MESSAGE β€” sets MESSAGE as the commit entry or the request description.

🌈 osc maintenancerequest (mr) 🌈

okay bestie, this one creates a request to start a maintenance incident. Iconic behaviour tbh.

usage: osc [global opts] maintenancerequest [-h] [-a ATTRIBUTE] [-m
TEXT]
                                            [--release-project
RELEASEPROJECT]
                                            [--enforce-branching]
                                            [--no-cleanup] [--cleanup]
                                            [--incident INCIDENT]
                                            [--incident-project
INCIDENT_PROJECT]
                                            [-s REQUEST_ID]
See https://openbuildservice.org/help/manuals/obs-user-guide/cha.obs.maintenance_setup.html for information on this topic.

So what's happening here: this command is literally asking the maintenance team to start a maintenance incident based on a maintenance update you already made. πŸ’… Wanna know how to make such a project? Peep the mbranch command. Wanna know how to add the required maintenance update info? That's the patchinfo command, bestie. They're a duo fr fr.

usage:
    osc maintenancerequest [ SOURCEPROJECT [ SOURCEPACKAGES RELEASEPROJECT ] ]
    osc maintenancerequest .

The 2nd line hits different when you run it inside a package directory β€” it's a lil shortcut to submit a single package (the one sitting in your current directory) from that package's project, submitted over to the release project this package links to. πŸŽ€ Heads up though: that syntax is only valid when you run it from a package subdirectory. No cap.

✨ options ✨

  • -a ATTRIBUTE, --attribute ATTRIBUTE β€” use this attribute to find the default maintenance project (default is OBS:MaintenanceProject).
  • -m TEXT, --message TEXT β€” specify message TEXT.
  • --release-project RELEASEPROJECT β€” specify the release project.
  • --enforce-branching β€” submit from a fresh branched project.
  • --no-cleanup β€” do not remove the source project on accept.
  • --cleanup β€” do remove the source project on accept.
  • --incident INCIDENT β€” specify the incident number to merge in.
  • --incident-project INCIDENT_PROJECT β€” specify the incident project to merge in.
  • -s REQUEST_ID, --supersede REQUEST_ID β€” superseding another request by this one. πŸ¦‹

πŸŽ€ osc mbranch (maintained, sm) πŸŽ€

Search or branch multiple instances of a package. So many. So much slay.

usage: osc [global opts] mbranch [-h] [-c] [-a ATTRIBUTE]
                                 [-u UPDATE_ATTRIBUTE] [--dryrun]
[--noaccess]
                                 [--nodevelproject] [--version]

This command is for searching all relevant instances of packages and then creating links of them inside one project. It's esp. used for maintenance updates (iykyk). You can also use it to branch every package that was marked before with a given attribute. πŸ’…

See http://en.opensuse.org/openSUSE:Build_Service_Concept_Maintenance for information on this topic.

The branched package will live in

home:USERNAME:branches:ATTRIBUTE:PACKAGE

…if nothing else is specified. πŸ’–

And listen: if you run osc maintained or sm, it only shows the relevant instances of a package. No branch gets created. That's basically the same energy as osc mbranch --dryrun. 🫢

usage:
    osc sm [SOURCEPACKAGE] [-a ATTRIBUTE]
    osc mbranch [ SOURCEPACKAGE [ TARGETPROJECT ] ]

✨ options ✨

  • -c, --checkout β€” checkout the branched package afterwards (osc bco is a shorthand for this option, cute right).
  • -a ATTRIBUTE, --attribute ATTRIBUTE β€” use this attribute to find affected packages (default is OBS:Maintained).
  • -u UPDATE_ATTRIBUTE, --update-project-attribute UPDATE_ATTRIBUTE β€” use this attribute to find update projects (default is OBS:UpdateProject).
  • --dryrun β€” just simulate the action and report back the result. No commitment, just vibes. 🌸
  • --noaccess β€” create a hidden project.
  • --nodevelproject β€” do not follow a defined devel project (that's the primary project where a package is developed).
  • --version β€” print version of maintained package.

πŸ’œ osc meta πŸ’œ

Show meta information, or edit it. Main character energy honestly.

usage: osc [global opts] meta [-h] [-a ATTRIBUTE] [--attribute-defaults]
                              [--attribute-project] [--blame] [-f] [-F
FILE]
                              [-r REV] [-m TEXT] [-e] [-c] [-R]
                              [-s ATTRIBUTE_VALUES] [--add
ATTRIBUTE_VALUES]
                              [--delete]

Show or edit build service metadata of type <prj|pkg|prjconf|user|pattern>. πŸ¦‹

This command displays metadata on buildservice objects β€” projects, packages, users, the whole fam. The type of metadata is specified by the word after "meta", like e.g. "meta prj".

Let's break the types down, bestie:

  • prj denotes metadata of a buildservice project.
  • prjconf denotes the (build) configuration of a project.
  • pkg denotes metadata of a buildservice package.
  • user denotes the metadata of a user.
  • group denotes the metadata of a group.
  • pattern denotes installation patterns defined for a project.

To list patterns, use osc meta pattern PRJ. An additional argument will be the pattern file to view or edit.

With the --edit switch, the metadata can be edited. Per default, osc opens the program specified by the environmental variable EDITOR with a temporary file. Alternatively, content to be saved can be supplied via the --file switch. If the argument is '-', input is taken from stdin:

osc meta prjconf home:user | sed ... | osc meta prjconf home:user -F -

For meta prj and prjconf updates, optional commit messages can be applied with --message. ✨

When trying to edit a non-existing resource, it is created implicitly. Surprise! It manifests. πŸ’…

Examples:

osc meta prj PRJ
osc meta pkg PRJ PKG
osc meta pkg PRJ PKG -e
usage:
    osc meta <prj|prjconf> [-r|--revision REV] ARGS...
    osc meta <prj|pkg|prjconf|user|group|pattern> ARGS...
    osc meta <prj|pkg|prjconf|user|group|pattern> [-m|--message TEXT] -e|--edit ARGS...
    osc meta <prj|pkg|prjconf|user|group|pattern> [-m|--message TEXT] -F|--file ARGS...
    osc meta pattern --delete PRJ PATTERN
    osc meta attribute PRJ [PKG [SUBPACKAGE]] [--attribute ATTRIBUTE] [--create [--set <value_list>]|--delete|--set <value_list>]

✨ options ✨

  • -a ATTRIBUTE, --attribute ATTRIBUTE β€” affect only a given attribute.
  • --attribute-defaults β€” include defined attribute defaults.
  • --attribute-project β€” include project values, if missing in packages.
  • --blame β€” show author and time of each line. Detective mode πŸ” (but make it fashion).
  • -f, --force β€” force the save operation, allows one to ignores some errors like depending repositories. For prj meta only.
  • -F FILE, --file FILE β€” read metadata from FILE, instead of opening an editor. '-' denotes standard input.
  • -r REV, --revision REV β€” checkout given revision instead of head revision. For prj and prjconf meta only.
  • -m TEXT, --message TEXT β€” specify log message TEXT. For prj and prjconf meta only.
  • -e, --edit β€” edit metadata.
  • -c, --create β€” create attribute without values.
  • -R, --remove-linking-repositories β€” try to remove also all repositories building against remove ones.
  • -s ATTRIBUTE_VALUES, --set ATTRIBUTE_VALUES β€” set attribute values.
  • --add ATTRIBUTE_VALUES β€” add to the existing attribute values, skip duplicates. πŸ™ˆ
  • --delete β€” delete a pattern or attribute.

🌸 osc mkpac 🌸

Create a new package under version control. Baby's first package, but make it git-coded. πŸŽ€

usage: osc [global opts] mkpac [-h]
usage:
    osc mkpac new_package

⭐ osc mv ⭐

Move SOURCE file to DEST and keep it under version control. So the history stays intact β€” we love a queen who doesn't lose her receipts. πŸ’…

usage: osc [global opts] mv [-h] [-f] source dest

arguments

  • source
  • dest

options

  • -f, --force β€” forces removal of entire package and its files.
Careful bestie β€” that's the whole package and its files, not just the one file. Read twice, run once. πŸ’€

πŸ¦‹ osc my πŸ¦‹

Show waiting work, packages, projects or requests involving yourself. It's giving personal dashboard.

usage: osc [global opts] my [-h] [-b] [-m] [-a] [-U USER]
                            [--exclude-project EXCLUDE_PROJECT]
[--maintained]

Examples:

# list all open tasks for me
osc my [work]
# list packages where I am bugowner
osc my pkg -b
# list projects where I am maintainer
osc my prj -m
# list request for all my projects and packages
osc my rq
# list requests, excluding project 'foo' and 'bar'
osc my rq --exclude-project foo,bar
# list requests I made
osc my sr
usage:
    osc my <TYPE>

    where TYPE is one of requests, submitrequests,
    projects or packages (rq, sr, prj or pkg)

✨ options ✨

  • -b, --bugowner β€” restrict listing to items where the user is bugowner.
  • -m, --maintainer β€” restrict listing to items where the user is maintainer.
  • -a, --all β€” all involvements. (Every single one. You're everywhere. πŸ‘‘)
  • -U USER, --user USER β€” search for USER instead of yourself.
  • --exclude-project EXCLUDE_PROJECT β€” exclude requests for specified project.
  • --maintained β€” limit search results to packages with maintained attribute set.

🧚 osc patchinfo 🧚

Generate and edit a patchinfo file. πŸ“

usage: osc [global opts] patchinfo [-h] [-f]

A patchinfo file describes the packages for an update and the kind of problem it solves. Like a lil summary of "what was broken and what we fixed" β€” except it's machine-readable and lowkey iconic.

This command either creates a new _patchinfo or updates an existing one. ✨

Examples:

osc patchinfo
osc patchinfo [PROJECT [PATCH_NAME]]

options

  • -f, --force β€” force generation of a brand new patchinfo file, like, don't update the existing one, just make a fresh one. no editing, full rewrite energy πŸ’…

πŸŽ€ osc pdiff

Quick alias to diff the content of a package against its parent. just the diff bestie, nothing extra ✨

usage: osc [global opts] pdiff [-h] [-p] [-n]

usage:

    osc pdiff [--plain|-p] [--nomissing-ok|-n]
    osc pdiff [--plain|-p] [--nomissing-ok|-n] PKG
    osc pdiff [--plain|-p] [--nomissing-ok|-n] PRJ PKG

options:

  • -p, --plain β€” output the diff in plain (not unified) diff format
  • -n, --nomissingok β€” fail if the parent package does not exist on the server (like, it will literally refuse to continue, so know that going in 😭)

🌈 osc prdiff (projdiff, projectdiff)

Server-side diff of two projects. the server does the work, you just vibe

usage: osc [global opts] prdiff [-h] [-r] [-e REGEXP] [-i REGEXP] [-n]
                                [-o] [-u] [-d]

Compares two projects and either summarizes or outputs the differences in full. In the second form, a project is compared with one of its branches inside a home:$USER project (the branch is treated as NEWPRJ). The home branch is optional if the current working directory is a checked out copy of it. iykyk πŸ‘‘

usage:

    osc prdiff [OPTIONS] OLDPRJ NEWPRJ
    osc prdiff [OPTIONS] [home:$USER:branch:$PRJ]

options:

  • -r, --requests β€” show open requests for any packages with differences
  • -e REGEXP, --exclude REGEXP β€” skip packages matching REGEXP
  • -i REGEXP, --include REGEXP β€” only consider packages matching REGEXP
  • -n, --show-not-in-old β€” show packages only in the new project
  • -o, --show-not-in-new β€” show packages only in the old project
  • -u, --unified β€” show full unified diffs of differences
  • -d, --diffstat β€” show diffstat of differences

πŸ¦‹ osc prjresults (pr)

Shows project-wide build results. the big picture moment πŸ“Š

usage: osc [global opts] prjresults [-h] [-b] [-w] [-c] [--xml] [-s STATUS]
                                    [-n EXPR] [-a ARCH] [-r REPO] [-V]
                                    [--show-excluded]

usage:

    osc prjresults (inside working copy)
    osc prjresults PROJECT

options:

  • -b, --brief β€” show the result in "pkgname repo arch result" short and sweet fr fr
  • -w, --watch β€” watch the results until all finished building, only supported with --xml so don't try it solo bestie
  • -c, --csv β€” csv output
  • --xml β€” generate output in XML
  • -s STATUS, --status-filter STATUS β€” show only packages with buildstatus STATUS (see legend)
  • -n EXPR, --name-filter EXPR β€” show only packages whose names match EXPR
  • -a ARCH, --arch ARCH β€” show results only for specified architecture(s)
  • -r REPO, --repo REPO β€” show results only for specified repo(s)
  • -V, --vertical β€” list packages vertically instead horizontally rotated, slayed πŸ’…
  • --show-excluded β€” show packages that are excluded in all repos, also hide repos that have only excluded packages

🌸 osc pull

Merge the changes of the link target into your working copy. pull up, get the changes, periodt 🫢

usage: osc [global opts] pull [-h]

πŸ’€ osc rdelete

Delete a project or packages on the server. careful bestie, this one's for real

usage: osc [global opts] rdelete [-h] [-r] [-f] [-m TEXT]

As a safety measure, project must be empty (i.e., you need to delete all packages first). Also, packages must have no requests pending (i.e., you need to accept/revoke such requests first). If you are sure that you want to remove this project and all its packages use --recursive switch. It may still not work because other depends on it. If you want to ignore this as well use --force switch.

ngl this will absolutely nuke stuff if you're not paying attention. The --force switch literally ignores the fact that other things depend on the project. Read twice, delete once. 😭

usage:

   osc rdelete [-r] [-f] PROJECT [PACKAGE]

options:

  • -r, --recursive β€” deletes a project with packages inside
  • -f, --force β€” deletes a project where other depends on (yikes, but okay)
  • -m TEXT, --message TEXT β€” specify log message TEXT

✨ osc rdiff

Server-side "pretty" diff of two packages. pretty diff, pretty slay ✨

usage: osc [global opts] rdiff [-h] [--issues-only] [-M] [-r N[:M]] [-p]
                               [-c rev] [--missingok] [-u] [--xml]

Compares two packages (three or four arguments) or shows the changes of a specified revision of a package (two arguments)

If no revision is specified the latest revision is used.

usage:

    osc rdiff OLDPRJ OLDPAC NEWPRJ [NEWPAC]
    osc rdiff PROJECT PACKAGE
    osc rdiff PROJECT --meta

options:

  • --issues-only β€” show only issues in diff
  • -M, --meta β€” diff meta data
  • -r N[:M], --revision N[:M] β€” revision id, where N = old revision and M = new revision
  • -p, --plain β€” output the diff in plain (not unified) diff format and show diff of files in archives
  • -c rev, --change rev β€” the change made by revision rev (like -r rev-1:rev). If rev is negative this is like -r rev:rev-1. negative revision math, iconic 🧚
  • --missingok β€” do not fail if the source or target project/package does not exist on the server
  • -u, --unexpand β€” diff unexpanded version if sources are linked
  • --xml β€” show diff as xml (only for issues diff)

πŸ”₯ osc rebuild (rebuildpac)

Trigger package rebuilds. kick it off manually, if you must πŸ’«

usage: osc [global opts] rebuild [-h] [-a ARCH] [-r REPO] [-f] [-M FLAVOR]
                                 [--all]

Note that it is normally NOT needed to kick off rebuilds like this, because they principally happen in a fully automatic way, triggered by source check-ins. In particular, the order in which packages are built is handled by the build service. the machine already got this, bestie, let it cook

The arguments REPOSITORY and ARCH can be taken from the first two columns of the osc repos output.

usage:

    osc rebuild [PROJECT [PACKAGE[:FLAVOR] [REPOSITORY [ARCH]]]]

options:

  • -a ARCH, --arch ARCH β€” trigger rebuilds for a specific architecture
  • -r REPO, --repo REPO β€” trigger rebuilds for a specific repository
  • -f, --failed β€” rebuild all failed packages the ones that went πŸ’€
  • -M FLAVOR, --multibuild-package FLAVOR β€” Only work with the specified flavors of a multibuild package. Globs are resolved according to _multibuild file from server. Empty string is resolved to a package without a flavor.
  • --all β€” Rebuild all packages of entire project

πŸ‘‘ osc release

Release sources and binaries. ship it πŸš€

usage: osc [global opts] release [-h] [-a ARCH] [-r REPO]
                                 [--target-project TARGETPROJECT]
                                 [--target-repository TARGETREPOSITORY]
                                 [--set-release RELEASETAG] [--no-delay]

This command is used to transfer sources and binaries without rebuilding them. It requires defined release targets set to trigger="manual". manual trigger only, no cap

usage:

    osc release [PROJECT [PACKAGE]]

options:

  • -a ARCH, --arch ARCH β€” Release only binaries from the specified architecture
  • -r REPO, --repo REPO β€” Release only binaries from the specified repository
  • --target-project TARGETPROJECT β€” Release only to specified project
  • --target-repository TARGETREPOSITORY β€” Release only to specified repository
  • --set-release RELEASETAG β€” rename binaries during release using this release tag
  • --no-delay β€” Don't put the release job in a queue to be run later, but immediately run it. Thus the next call to osc prjresult will reflect it. Otherwise there is no way to know if it is finished or didn't start yet. instant gratification mode, lowkey obsessed

πŸŽ€ osc releaserequest

Create a release request. paperwork but make it cute πŸŽ€

usage: osc [global opts] releaserequest [-h] [-m TEXT] [-p PKG]

For maintenance incident projects:

This command is used by the maintenance team to start the release process of a maintenance update. This includes usually testing based on the defined reviewers of the update project.

[See https://openbuildservice.org/help/manuals/obs-user-guide/cha.obs.maintenance_setup.html for information on this topic.]

For normal projects:

This command is used to transfer sources and binaries without rebuilding them. It requires defined release targets set to trigger="manual".

[See https://openbuildservice.org/help/manuals/obs-user-guide/cha.obs.request_and_review_system.html for information on this topic.]

usage:

    osc releaserequest [-p package] [ SOURCEPROJECT ]

options:

  • -m TEXT, --message TEXT β€” specify message TEXT
  • -p PKG, --package PKG β€” specify packages to release

Repair a broken source link. glow-up for your link πŸ”§βœ¨

usage: osc [global opts] repairlink [-h] [-d DIR]

This command checks out a package with merged source changes. It uses a 3-way merge to resolve file conflicts. After reviewing/repairing the merge, use 'osc resolved ...' and 'osc ci' to re-create a working source link.

usage: * For merging conflicting changes of a checkout package:

    osc repairlink
  • Check out a package and merge changes:
    osc repairlink PROJECT PACKAGE
  • Pull conflicting changes from one project into another one:
    osc repairlink PROJECT PACKAGE INTO_PROJECT [INTO_PACKAGE]

options:

  • -d DIR, --destdir DIR β€” destination directory

πŸ’œ osc repairwc

Try to repair an inconsistent working copy. your wc is going through something, let's fix her πŸ’œ

usage: osc [global opts] repairwc [-h] [--force-apiurl]

Examples:

    osc repairwc <path>

Note: if <path> is omitted it defaults to '.' (<path> can be a project or package working copy)

Warning: This command might delete some files in the storedir (.osc). Please check the state of the wc afterwards (via 'osc status'). not me deleting your files without asking, check after, fr fr 😭

options:

  • --force-apiurl β€” ask once for an apiurl and force this apiurl for all inconsistent projects/packages

🌸 osc repositories (platforms, repos)

Shows repositories configured for a project. where the packages get built, bestie πŸ“¦

usage: osc [global opts] repositories [-h]

It skips repositories by default which are disabled for a given package.

usage:

    osc repos
    osc repos [PROJECT] [PACKAGE]

πŸ¦‹ osc repourls

Shows URLs of .repo files. links, but make it build-service ✨

usage: osc [global opts] repourls [-h]

Shows URLs on which to access the project repositories.

usage:

   osc repourls [PROJECT]

πŸ’… osc request (review, rq)

Show or modify requests and reviews

usage: osc [global opts] request [-h] [-d] [-S SUPERSEDED_REQUEST] [-u] [--no-devel] [-m TEXT] [-t TYPE] [-a] [-f] [-s STATE] [-D DAYS] [-U USER] [-G GROUP] [-P PROJECT] [-p PACKAGE] [-b] [-M] [-B] [-e] [-i] [--or-revoke] [--non-interactive] [--exclude-target-project EXCLUDE_TARGET_PROJECT] [--keep-packages-locked] [--incoming] [--involved-projects] [--target-package-filter TARGET_PACKAGE_FILTER] [--source-buildstatus]
[See http://en.opensuse.org/openSUSE:Build_Service_Collaboration for information on this topic.]

The request command has the following sub commands:

  • list β€” lists open requests attached to a project or package or person. Uses the project/package of the current directory if none of -M, -U USER, project/package are given.
  • log β€” will show the history of the given ID.
  • show β€” will show the request itself, and generate a diff for review, if used with the --diff option. The keyword show can be omitted if the ID is numeric. The -v/--verbose options shows comments in the request's history.
  • decline β€” will change the request state to "declined".
  • reopen β€” will set the request back to new or review.
  • setincident β€” will direct "maintenance" requests into specific incidents.
  • supersede β€” will supersede one request with another existing one.
  • revoke β€” will set the request state to "revoked".
⚠️ WARNING: Revoking a maintenance release request unlocks packages in the source project. To avoid unlocking, use the --keep-packages-locked option.
  • accept β€” will change the request state to "accepted" and will trigger the actual submit process. That would normally be a server-side copy of the source package to the target package.
  • approve β€” marks a requests in "review" state as approved. This request will get accepted automatically when the last review got accepted.
  • checkout β€” will checkout the request's source package ("submit" requests only).
  • prioritize β€” change the priority of a request to either "critical", "important", "moderate" or "low".

The review command has the following sub commands:

  • list β€” lists open requests that need to be reviewed by the specified user or group.
  • add β€” adds a person or group as reviewer to a request.
  • accept β€” mark the review positive.
  • decline β€” mark the review negative. A negative review will decline the request.

okay so here's the whole menu of how you actually type these, no cap:

usage:
    osc request list [-M] [-U USER] [-s state] [-D DAYS] [-t type] [-B] [PRJ [PKG]]
    osc request log ID
    osc request [show] [-d] [-b] [-v/--verbose] ID

    osc request accept [-m TEXT] ID
    osc request approve [-m TEXT] ID
    osc request cancelapproval [-m TEXT] ID
    osc request decline [-m TEXT] ID
    osc request revoke [-m TEXT] ID
    osc request reopen [-m TEXT] ID
    osc request setincident [-m TEXT] ID INCIDENT
    osc request supersede [-m TEXT] ID SUPERSEDING_ID
    osc request approvenew [-m TEXT] PROJECT
    osc request prioritize [-m TEXT] ID PRIORITY

    osc request checkout/co ID
    osc request clone [-m TEXT] ID

    osc review show [-d] [-b] ID
    osc review list [-U USER] [-G GROUP] [-P PROJECT [-p PACKAGE]] [-s state]
    osc review add [-m TEXT] [-U USER] [-G GROUP] [-P PROJECT [-p PACKAGE]] ID
    osc review accept [-m TEXT] [-U USER] [-G GROUP] [-P PROJECT [-p PACKAGE]] ID
    osc review decline [-m TEXT] [-U USER] [-G GROUP] [-P PROJECT [-p PACKAGE]] ID
    osc review reopen [-m TEXT] [-U USER] [-G GROUP] [-P PROJECT [-p PACKAGE]] ID
    osc review supersede [-m TEXT] [-U USER] [-G GROUP] [-P PROJECT [-p PACKAGE]] ID SUPERSEDING_ID

✨ options ✨

  • -d, --diff β€” generate a diff πŸ’…
  • -S SUPERSEDED_REQUEST, --superseded-request SUPERSEDED_REQUEST β€” Create the diff relative to a given former request.
  • -u, --unified β€” output the diff in the unified diff format.
  • --no-devel β€” Do not attempt to forward to devel project. πŸ™ˆ
  • -m TEXT, --message TEXT β€” specify message TEXT.
  • -t TYPE, --type TYPE β€” limit to requests which contain a given action type (submit/delete/change_devel/add_role/set_bugowner/maintenance_incident/maintenance_release).
  • -a, --all β€” all states. Same as -s all.
  • -f, --force β€” enforce state change, can be used to ignore open reviews, devel-package dependencies and more. 😀
  • -s STATE, --state STATE β€” only list requests in one of the comma separated given states (new/review/accepted/revoked/declined) or "all" [default="new,review,declined"].
  • -D DAYS, --days DAYS β€” only list requests in state "new" or changed in the last DAYS.
  • -U USER, --user USER β€” requests or reviews limited for the specified USER.
  • -G GROUP, --group GROUP β€” requests or reviews limited for the specified GROUP.
  • -P PROJECT, --project PROJECT β€” requests or reviews limited for the specified PROJECT.
  • -p PACKAGE, --package PACKAGE β€” requests or reviews limited for the specified PACKAGE, requires also a PROJECT.
  • -b, --brief β€” print output in list view as list subcommand.
  • -M, --mine β€” only show requests created by yourself. main character energy only 🫢
  • -B, --bugowner β€” also show requests about packages where I am bugowner.
  • -e, --edit β€” edit a submit action.
  • -i, --interactive β€” interactive review of request.
  • --or-revoke β€” For automation scripts: accepts (if using with accept argument) a request when it is in new or review state. Or revoke it when it got declined. Otherwise just do nothing.
  • --non-interactive β€” non-interactive review of request.
  • --exclude-target-project EXCLUDE_TARGET_PROJECT β€” exclude target project from request list.
  • --keep-packages-locked β€” Avoid unlocking of packages in maintenance incident when revoking release requests.
  • --incoming β€” Show only requests where the project is target.
  • --involved-projects β€” show all requests for project/packages where USER is involved.
  • --target-package-filter TARGET_PACKAGE_FILTER β€” only list requests for the packages matching the package filter. A (python) regular expression is expected.
  • --source-buildstatus β€” print the buildstatus of the source package (only works with "show" and the interactive review).

πŸŽ€ osc requestmaintainership (reqbs, reqms, reqmaintainership, requestbugownership, reqbugownership)

Requests to add user as maintainer or bugowner. it's giving "let me in" energy.

usage: osc [global opts] requestmaintainership [-h] [-m TEXT] [-r role]
usage:
    osc requestmaintainership                            # for current user in checked out package
    osc requestmaintainership USER                       # for specified user in checked out package
    osc requestmaintainership PROJECT                    # for current user if cwd is not a checked out package
    osc requestmaintainership PROJECT group:NAME         # request for specified group
    osc requestmaintainership PROJECT PACKAGE            # for current user
    osc requestmaintainership PROJECT PACKAGE USER       # request for specified user
    osc requestmaintainership PROJECT PACKAGE group:NAME # request for specified group

    osc requestbugownership ...                          # accepts same parameters but uses bugowner role

options

  • -m TEXT, --message TEXT β€” specify message TEXT.
  • -r role, --role role β€” specify user role (default: maintainer).

🌈 osc resolved

Remove 'conflicted' state on working copy files.

usage: osc [global opts] resolved [-h]

If an upstream change can't be merged automatically, a file is put into in 'conflicted' ('C') state. Within the file, conflicts are marked with special <<<<<<< as well as ======== and >>>>>>> lines.

After manually resolving all conflicting parts, use this command to remove the 'conflicted' state.

πŸ“ Note: this subcommand does not semantically resolve conflicts or remove conflict markers; it merely removes the conflict-related artifact files and allows PATH to be committed again.
usage:
    osc resolved FILE [FILE...]

πŸ”₯ osc restartbuild (abortbuild)

Restart the build of a certain project or package.

usage: osc [global opts] restartbuild [-h] [-a ARCH] [-M FLAVOR] [-r REPO] [--all]
usage:
    osc restartbuild [PROJECT [PACKAGE[:FLAVOR] [REPOSITORY [ARCH]]]]

options

  • -a ARCH, --arch ARCH β€” Restart builds for a specific architecture.
  • -M FLAVOR, --multibuild-package FLAVOR β€” Only work with the specified flavors of a multibuild package. Globs are resolved according to _multibuild file from server. Empty string is resolved to a package without a flavor.
  • -r REPO, --repo REPO β€” Restart builds for a specific repository.
  • --all β€” Restart all running builds of entire project. everything. all at once. slay.

πŸ’œ osc results (r)

Shows the build results of a package or project.

usage: osc [global opts] results [-h] [-l] [-r REPO] [-a ARCH] [-b] [--no-multibuild] [-M FLAVOR] [-V] [-w] [-F] [-s STATUS_FILTER] [-f] [--xml] [--csv] [--format FORMAT] [--show-excluded]
usage:
    osc results                 # (inside working copy of PRJ or PKG)
    osc results PROJECT [PACKAGE[:FLAVOR]]

options

  • -l, --last-build β€” show last build results (succeeded/failed/unknown).
  • -r REPO, --repo REPO β€” Show results only for specified repo(s).
  • -a ARCH, --arch ARCH β€” Show results only for specified architecture(s).
  • -b, --brief β€” show the result in "pkgname repo arch result". Default for -f.
  • --no-multibuild β€” Disable results for all direct affect packages inside of the project.
  • -M FLAVOR, --multibuild-package FLAVOR β€” only mess with the flavors you named for a multibuild package πŸ’…. Globs get resolved against the _multibuild file from the server, and an empty string resolves to the package that has no flavor at all. iykyk.
  • -V, --vertical β€” list packages vertically instead of horizontally, and it applies to the entire project 🌈
  • -w, --watch β€” sit there and watch the results until literally everything is done building πŸ‘€
  • -F, --fail-on-error β€” bail out with exit 1 if any build has errored. no cap, she's strict 😀
  • -s STATUS_FILTER, --status-filter STATUS_FILTER β€” only show packages with the build status you asked for 🎯
  • -f, --failed β€” show only the failed results. the flop report, if you will πŸ’€
  • --xml β€” generate output in XML (this is the former results_meta, fyi)
  • --csv β€” generate output in CSV format πŸ“
  • --format FORMAT β€” change the format of the text output (that's the default) or the csv output. Heads up: it is not supported for xml output 🚫. The supported fields are: project, package, repository, arch, state, dirty, code, details. For text output you have to use those field names as named fields for string interpolation, like %(field)s. For CSV output you just separate the field names with commas ✨
  • --show-excluded β€” show the repos that are excluded for this package 🫢

osc revert

Restore changed files, or honestly the whole entire working copy if that's the vibe πŸ’–

osc [global opts] revert [-h] file [file ...]

Examples:

osc revert <modified file(s)>
osc revert .  Note: this only works for package working copies

arguments:

  • file

osc rpmlintlog (lint, rpmlint)

Shows the rpmlint logfile πŸ“‹

osc [global opts] rpmlintlog [-h] [-M FLAVOR]

So this shows you the rpmlint logfile so you can analyse whether there are any problems with the spec file and the built binaries πŸ”

usage:

osc rpmlintlog repository arch # (inside checked out PKG dir)
osc rpmlintlog project package repository arch

options:

  • -M FLAVOR, --multibuild-package FLAVOR β€” only work with the specified flavor of a multibuild package 🌸

osc rremove

Remove source files from the selected package, bye bestie πŸ‘‹

osc [global opts] rremove [-h] [-f] project package file [file ...]

arguments:

  • project
  • package
  • file

options:

  • -f, --force β€” don't ask, just delete the files. no questions, no hesitation πŸ’…

osc search (bse, se)

Search for a project and/or package πŸ”Ž

osc [global opts] search [-h] [--repos-baseurl] [-e] [-s] [--package] [--project] [--title] [--description] [-a ATTRIBUTE] [-V] [-i] [-b] [-m] [-M] [--csv] [--binary] [-B PROJECT] [--binaryversion VERSION]

If you don't specify any option, osc will search for projects and packages that contain the search term in their name, title or description. default behavior, iconic ✨

usage:

osc search 'search term' <options>
osc bse ...                         ('osc search --binary')
osc se 'perl(Foo::Bar)'             ('osc search --package perl-Foo-Bar')

options:

  • --repos-baseurl β€” show the base URLs of download repositories 🌐
  • -e, --exact β€” show only exact matches, which is the default now btw
  • -s, --substring β€” also show results where the search term is a sub string. slower search, but thorough 🐌
  • --package β€” search for a package πŸ“¦
  • --project β€” search for a project πŸ—‚οΈ
  • --title β€” search for matches in the title element
  • --description β€” search for matches in the description element
  • -a ATTRIBUTE, --limit-to-attribute ATTRIBUTE β€” only match when the given attribute exists in the meta data πŸŽ€
  • -V, --version β€” show package version, revision, and srcmd5. CAUTION: this is slow and unreliable ⚠️ like, proceed with caution bestie
  • -i, --involved β€” show projects/packages where the given person (or myself) is involved as bugowner or maintainer. Format is [[{group|person}/]<name>], default: person 🫢
  • -b, --bugowner β€” same as -i, but only bugowner
  • -m, --maintainer β€” same as -i, but only maintainer
  • -M, --mine β€” shorthand for --bugowner --package πŸ’–
  • --csv β€” generate output in CSV (separated by |)
  • --binary β€” search binary packages
  • -B PROJECT, --baseproject PROJECT β€” search packages built for PROJECT (this implies --binary)
  • --binaryversion VERSION β€” search for a binary with the specified version (implies --binary)

osc sendsysrq

Trigger a sysrq in a running build 😳

osc [global opts] sendsysrq [-h] [-M FLAVOR]

Okay so this is only going to work when the build is running in a supported VM, fr fr. Also, only a subset of sysrq are supported. The typical use case for debugging is 9, t and w, in this sequence 🧠

usage:

osc sendsysrq REPOSITORY ARCH SYSRQ
osc sendsysrq PROJECT PACKAGE[:FLAVOR] REPOSITORY ARCH SYSRQ

options:

  • -M FLAVOR, --multibuild-package FLAVOR β€” only work with the specified flavors of a multibuild package πŸ’…. Globs are resolved according to the _multibuild file from the server. An empty string is resolved to a package without a flavor.

osc service

Handle source services πŸ› οΈ

osc [global opts] service [-h] [-v]

Source services can be used to modify sources, like downloading files, verifying files, generating files, or modifying existing files ✨

usage:

osc service COMMAND (inside working copy)
osc service run [SOURCE_SERVICE]
osc service runall
osc service manualrun [SOURCE_SERVICE]
osc service remoterun [PROJECT PACKAGE]
osc service merge [PROJECT PACKAGE]
osc service wait [PROJECT PACKAGE]

COMMAND can be:
run         r  run defined services with modes "trylocal", "localonly", or no mode set locally,
               may take an optional parameter to run only a specified source service. In case
               parameters exist for this one in _service file they are used.
runall      ra run all services independent of the used mode
manualrun   mr run all services with mode "manual", may take an optional parameter to run only a
               specified source service
remoterun   rr trigger a re-run on the server side
merge          commits all server side generated files and drops the _service definition
wait           waits until the service finishes and returns with an error if it failed
precommit      run the services exactly as would be before a commit, for use from the git hook

Not for common usage anymore:
localrun    lr the same as "run" but services with mode "serveronly" are also executed
disabledrun dr run all services with mode "disabled"

options:

  • -v, --verbose β€” verbose run of local services, for debugging purposes πŸ”

osc setdevelproject (sdp)

Set the devel project / package of a package 🎯

osc [global opts] setdevelproject [-h] [-u]

Examples:

osc setdevelproject [PROJECT PACKAGE] DEVEL_PROJECT [DEVEL_PACKAGE]

options:

  • -u, --unset β€” remove devel project πŸ™ˆ

osc setlinkrev

Updates a revision number in a source link πŸ”—

osc [global opts] setlinkrev [-h] [-r rev] [-R] [-u] [--vrev vrev]

This command adds or updates a specified revision number in a source link. And if you don't specify a revision number, the current revision of the source gets used πŸ’«

usage:

osc setlinkrev
osc setlinkrev PROJECT [PACKAGE]

options:

  • -r rev, --revision rev β€” use the specified revision.
  • -R, --use-plain-revision β€” do not expand the specified or latest rev 🚫
  • -u, --unset β€” remove the revision in the link, so it will always point to the latest revision 🌈
  • --vrev vrev β€” enforce a given vrev πŸ’…

osc showlinked

Show all packages linking to a given one πŸ‘€

osc [global opts] showlinked [-h]

Examples:

osc showlinked [PROJECT PACKAGE]

osc signkey

Manage Project Signing Key πŸ”‘

osc [global opts] signkey [-h] [--create] [--extend] [--delete]
                                 [--notraverse] [--sslcert]

osc signkey [--create|--delete|--extend] <PROJECT>
osc signkey [--notraverse] <PROJECT>

This command is for managing gpg keys. By default it shows the public key. And there is no way to download or upload the private part of a key β€” by design, bestie πŸš«πŸ”

However, you can create a new own key. You may want to consider signing the public key with your own existing key πŸ’–

If a project has no key, the key from the upper level project will be used. So like, if you drop the "KDE:KDE4:Community" key, the one from "KDE:KDE4" will be used πŸͺ„

WARNING: THE OLD KEY CANNOT BE RESTORED AFTER USING DELETE OR CREATE 😭 like it's gone gone. no takebacks, no undo, periodt πŸ’€

options:

  • --create β€” create a new gpg signing key for this project πŸŽ€
  • --extend β€” extend the expiration date of the gpg public key for this project ⏳
  • --delete β€” delete the gpg signing key in this project πŸ—‘οΈ
  • --notraverse β€” don't traverse projects upwards to find the key
  • --sslcert β€” fetch the SSL certificate instead of the GPG key πŸ”’

osc status (st)

Show status of files in working copy πŸ“‚

osc [global opts] status [-h] [-e]

Shows the status of files in a local working copy, indicating whether files have been changed locally, deleted, added, ... you know the drill πŸ’…

The first column in the output specifies the status, and it's one of these characters:

' ' no modifications (shown only in verbose output)
'A' Added
'C' Conflicted
'D' Deleted
'M' Modified
'R' Replaced (file was deleted and added again afterwards)
'?' item is not under version control
'!' item is missing (removed by non-osc command) or incomplete
'S' item is skipped (item exceeds a file size limit or is _service:* file)
'F' Frozen (use "osc pull" to merge conflicts) (package-only state)

examples:

osc st
osc st <directory>
osc st file1 file2 ...

usage:

osc status [OPTS] [PATH...]

options:

  • -e, --show-excluded β€” also show files that are excluded by the "exclude_glob" config option πŸ™ˆ

πŸ¦‹ osc submitrequest (submitpac, submitreq, sr) πŸ¦‹

okay so you wanna Create request to submit source into another Project? that's the collab move, bestie ✨

usage: osc [global opts] submitrequest [-h] [-m TEXT] [-F FILE] [-r REV]
                                       [-s REQUEST_ID] [--nodevelproject]
                                       [--separate-requests] [--cleanup]
                                       [--no-cleanup] [--no-update]
                                       [--update-link] [-d] [--yes]
there's a whole lore page on this btw: http://en.opensuse.org/openSUSE:Build_Service_Collaboration β€” go read it if you want the full tea πŸ“

and if you're trying to look at or modify requests that already exist, that is not this command, that's the request command's whole job πŸ’…

usage:

    osc submitreq [OPTIONS]
    osc submitreq [OPTIONS] DESTPRJ [DESTPKG]
    osc submitreq [OPTIONS] SOURCEPRJ SOURCEPKG DESTPRJ [DESTPKG]

    osc submitpac ... is a shorthand for osc submitreq --cleanup ...

options 🌸

  • -m TEXT, --message TEXT β€” say your piece: specify message TEXT
  • -F FILE, --file FILE β€” read the log message from FILE instead, and '-' means standard input
  • -r REV, --revision REV β€” lock in a specific source revision ID for the source package (it's the md5 sum πŸ‘€)
  • -s REQUEST_ID, --supersede REQUEST_ID β€” superseding another request with this one, so it's the new main character
  • --nodevelproject β€” do not follow a defined devel project (aka the primary project where a package is developed)
  • --separate-requests β€” make multiple requests instead of one single one (only matters when you're running this on an entire project)
  • --cleanup β€” remove the package if the submission gets accepted (this is the default for home:<id>:branch projects)
  • --no-cleanup β€” never remove the source package on accept, but do update its content
  • --no-update β€” never touch the source package on accept at all… ⚠️ and heads up, this will break source links
  • --update-link β€” transfers the source including the _link file
  • -d, --diff β€” just show the diff instead of actually creating the request (a lil peek, no commitment πŸ’–)
  • --yes β€” proceed without asking, no take-backs

πŸ” osc token πŸ”

Show and manage authentication token

usage: osc [global opts] token [-h] [-c] [-d TOKENID] [-o OPERATION]
                               [-t TOKENSTRING] [--scm-token SCM_TOKEN]
                               [-a ARCH] [-r REPO] [--target-project PROJECT]
                               [--target-repo REPO]
                               [--set-release RELEASE_TAG]

the tea: an authentication token lets you run specific commands without sending credentials. yes, it's giving backstage pass πŸŽ€

usage:

    osc token
    osc token --create --operation <OPERATION> [<PROJECT> <PACKAGE>]
    osc token --delete <TOKENID>
    osc token --trigger <TOKENSTRING> [--operation <OPERATION>] [<PROJECT> <PACKAGE>]

options πŸ’…

  • -c, --create β€” Create a new token
  • -d TOKENID, --delete TOKENID β€” Delete a token
  • -o OPERATION, --operation OPERATION β€” the operation associated with the token. Choices: runservice, branch, release, rebuild, workflow
  • -t TOKENSTRING, --trigger TOKENSTRING β€” Trigger the action of a token
  • --scm-token SCM_TOKEN β€” the scm's access token (only in combination with a --operation=workflow option)
  • -a ARCH, --arch ARCH β€” Release/Rebuild only binaries from the specified architecture
  • -r REPO, --repo REPO β€” Release/Rebuild only binaries from the specified repository
  • --target-project PROJECT β€” Release only to specified project
  • --target-repo REPO β€” Release only to specified repository
  • --set-release RELEASE_TAG β€” Rename binaries during release using this release tag

πŸ”₯ osc triggerreason (tr) πŸ”₯

Show reason why a package got triggered to build

usage: osc [global opts] triggerreason [-h] [-M FLAVOR]

so the server is the one who decides when a package needs to get rebuilt, right? and this command shows you the detailed reason for a package. a brief reason also lives in the jobhistory, which you can reach via osc jobhistory.

trigger reasons might be:

  • new build (never build yet or rebuild manually forced)
  • source change (e.g. on updating sources)
  • meta change (packages which are used for building have changed)
  • rebuild count sync (In case that it is configured to sync release numbers)

usage in package or project directory:

    osc triggerreason REPOSITORY ARCH
    osc triggerreason PROJECT PACKAGE[:FLAVOR] REPOSITORY ARCH

options ✨

  • -M FLAVOR, --multibuild-package FLAVOR β€” Only work with the specified flavor of a multibuild package.

🌈 osc undelete 🌈

Restores a deleted project or package on the server

usage: osc [global opts] undelete [-h] [-m TEXT]

the server restores a package including the sources and meta configuration. but listen β€” binaries remain to be lost and will be rebuild. so it's a glow-up, not a resurrection of the old binaries fr fr 😭

usage:

   osc undelete PROJECT
   osc undelete PROJECT PACKAGE

options 🫢

  • -m TEXT, --message TEXT β€” specify log message TEXT

🧚 osc unlock 🧚

Unlocks a project or package

usage: osc [global opts] unlock [-h] [-m TEXT]

Unlocks a locked project or package. and ngl, a comment is required β€” you can't just silently unlock, you gotta say something πŸ’¬

usage:

   osc unlock PROJECT [PACKAGE]

options πŸ’œ

  • -m TEXT, --message TEXT β€” specify log message TEXT

⭐ osc update (up) ⭐

Update a working copy

usage: osc [global opts] update [-h] [-r REV] [--linkrev REV] [-u] [-e] [-s]
                                [-S] [-l limit_size]

examples:

  1. osc up

If the current working directory is a package, update it.

If the directory is a project directory, update all contained packages, AND check out newly added packages.

To update only checked out packages, without checking out new ones, you might want to use "osc up *" from within the project dir.

  1. osc up PAC

Update the packages specified by the path argument(s)

when --expand-link is used with source link packages, the expanded sources will be checked out. without this option, the _link file and patches will be checked out. and --unexpand-link can be used to switch back to the "raw" source with a _link file plus patch(es) πŸ”

options πŸŽ€

  • -r REV, --revision REV β€” update to specified revision (heads up, this option gets ignored if you're going to update the complete project or more than one package)
  • --linkrev REV β€” revision of the link target that is used during link expansion
  • -u, --unexpand-link β€” if a package is an expanded link, update to the raw _link file
  • -e, --expand-link β€” if a package is a link, update to the expanded sources
  • -s, --source-service-files β€” Run local source services after update.
  • -S, --server-side-source-service-files β€” Use server side generated sources instead of local generation.
  • -l limit_size, --limit-size limit_size β€” Skip all files with a given size

πŸ“ osc updatepacmetafromspec (updatepkgmetafromspec, metafromspec) πŸ“

Update package meta information from a specfile

usage: osc [global opts] updatepacmetafromspec [-h] [--specfile FILE]

ARG, if specified, is a package working copy.

options 🌸

  • --specfile FILE β€” Path to specfile. (if you pass more than working copy this option is ignored)

πŸ’– osc vc πŸ’–

Edit the changes file

usage: osc [global opts] vc [-h] [-m MESSAGE] [-F FILE] [-e]
osc vc [-m MESSAGE|-e] [filename[.changes]|path [file_with_comment]]

If no <filename> is given, exactly one *.changes or *.spec file has to be in the cwd or in path.

the email address used in .changes file is read from the BuildService instance, or should be defined in oscrc:

[https://api.opensuse.org/] user = login pass = password email = user@defined.email

or it can be specified via the mailaddr environment variable.

by default, osc vc opens the program specified by the EDITOR environment variable (and it uses Vim if that variable is not set) with a temporary file that should replace the *.changes file when saved by the editor β€” or just discarded otherwise πŸ™ˆ

options ✨

  • -m MESSAGE, --message MESSAGE β€” add MESSAGE to changes (do not open an editor)
  • -F FILE, --file FILE β€” read changes message from FILE (do not open an editor)
  • -e, --just-edit β€” just open changes (cannot be used with -m)

πŸ‘‘ osc version πŸ‘‘

Give version of osc binary

usage: osc [global opts] version [-h]

usage:

    osc version

πŸ¦‹ osc whatdependson πŸ¦‹

Show the packages that require the specified package during the build

usage: osc [global opts] whatdependson [-h] [-M FLAVOR]

whatdependson is how you find out what will be triggered when a certain package changes πŸ””

⚠️ but this is no guarantee, since the new build might have changed dependencies.

the packages marked with the [i] flag are inherited to the project.

the arguments REPOSITORY and ARCH can be taken from the first two columns of the 'osc repos' output.

usage in package or project directory:

    osc whatdependson REPOSITORY ARCH

usage:

    osc whatdependson PROJECT [PACKAGE[:FLAVOR]] REPOSITORY ARCH

options πŸ’…

  • -M FLAVOR, --multibuild-package FLAVOR β€” Only work with the specified flavors of a multibuild package. Globs are resolved according to _multibuild file from server. Empty string is resolved to a package without a flavor.

🫢 osc whois (user, who) 🫢

Show fullname and email of a buildservice user

usage: osc [global opts] whois [-h] [user ...]

arguments 🌸

  • user

πŸ’€ osc wipebinaries (unpublish) πŸ’€

Delete all binary packages of a certain project/package

usage: osc [global opts] wipebinaries [-h] [-a ARCH] [-M FLAVOR] [-r REPO]
                                      [--build-disabled] [--build-failed]
                                      [--broken] [--unresolvable] [--all]

with the optional argument <package> you can specify a certain package, otherwise all binary packages in the project will be deleted. gone. poof. πŸ’¨

    osc wipebinaries OPTS                       # works in checked out project dir
    osc wipebinaries OPTS PROJECT [PACKAGE[:FLAVOR]]
    osc unpublish OPTS                       # works in checked out project dir
    osc unpublish OPTS PROJECT [PACKAGE[:FLAVOR]]

okay so you know how sometimes you just need to yeet some binaries into the void? πŸ’€ that's this. run it from a checked-out project dir and it just knows, or hand it a PROJECT and optionally a PACKAGE[:FLAVOR] and it does the thing. unpublish is the same energy, same arguments, same flags. πŸ’…


✨ options ✨ (the wipebinaries/unpublish menu) πŸ“

  • -a ARCH, --arch ARCH β€” nukes every binary package for one specific architecture. just that arch. bye bestie 🫢
  • -M FLAVOR, --multibuild-package FLAVOR β€” only messes with the flavors you name on a multibuild package. globs get resolved according to the _multibuild file from the server, and an empty string resolves to a package with no flavor at all. no cap 🧚
  • -r REPO, --repo REPO β€” deletes all the binary packages for one specific repository. one repo, all the binaries ✨
  • --build-disabled β€” deletes all binaries of packages where the build is disabled. yeah. those ones. πŸ’€
  • --build-failed β€” deletes all binaries of packages where the build failed. the sadness cleanup 😭
  • --broken β€” deletes all binaries of packages where the package source is bad. it's giving broken, so it's going πŸ¦‹
  • --unresolvable β€” deletes all binaries of packages that have dependency errors. unresolved drama? not on this server's watch πŸ‘‘
  • --all β€” deletes all binaries regardless of package status. this used to be the default, fyi, so if you were relying on the old behaviour, that's the one you want. previously default, periodt πŸ”₯
bestie, gentle reminder: this is deleting stuff off the server. pick your flags like your life depends on it, because the binaries' lives literally do. πŸ™ˆ

πŸ¦‹ osc workerinfo πŸ¦‹

gets the information to a worker from the server. that's the whole vibe β€” you ask, it tells you about that worker. πŸŽ€

usage:

osc [global opts] workerinfo [-h] <hostarch>:<workerid>

examples, because a demo eats every time:

osc workerinfo x86_64:goat:1

usage, once more with feeling:

osc workerinfo <hostarch>:<workerid>

arguments 🧚

  • <hostarch>:<workerid> β€” the thing you're asking about. hostarch, colon, workerid. like x86_64:goat:1. that exact shape, bestie, don't freestyle it πŸ’–

πŸ’œ AUTHOR πŸ’œ

contributors to the osc project. see the project's GIT history for the complete list. it's a whole group chat in there, and every single one of them ate 🫢


🌈 DISTRIBUTION 🌈

the latest version of osc may be downloaded from https://github.com/openSUSE/osc/ β€” go get it, it's iconic ✨


and that's the whole page, bestie!! πŸŽ€ you made it to the very end of OSC(1), which is giving main character energy fr fr πŸ‘‘ this one's osc, dated 2026-08-12, and that's the version/date stamp β€” slay, go wipe some binaries responsibly, iykyk πŸ’…πŸ’–

πŸ“¦ where this page comes from