apt-ostree/.notes/rpm-ostree/cli-help.txt

493 lines
No EOL
22 KiB
Text

$ rpm-ostree --help
Usage:
rpm-ostree [OPTION…] COMMAND
Builtin Commands:
apply-live Apply pending deployment changes to booted deployment
cancel Cancel an active transaction
cleanup Clear cached/pending data
compose Commands to compose a tree
db Commands to query the RPM database
deploy Deploy a specific commit
initramfs Enable or disable local initramfs regeneration
initramfs-etc Add files to the initramfs
install Overlay additional packages
kargs Query or modify kernel arguments
override Manage base package overrides
rebase Switch to a different tree
refresh-md Generate rpm repo metadata
reload Reload configuration
reset Remove all mutations
rollback Revert to the previously booted tree
search Search for packages
status Get the version of the booted system
uninstall Remove overlayed additional packages
upgrade Perform a system upgrade
usroverlay Apply a transient overlayfs to /usr
Help Options:
-h, --help Show help options
Application Options:
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree apply-live --help
Usage: rpm-ostree [OPTIONS]
Options:
--target <TARGET> Target provided commit instead of pending deployment
--reset Reset back to booted commit
--allow-replacement Allow replacement of packages/files (default is pure additive)
-h, --help Print help
$ rpm-ostree cancel --help
Usage:
rpm-ostree cancel [OPTION…]
Cancel an active transaction
Help Options:
-h, --help Show help options
Application Options:
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree cleanup --help
Usage:
rpm-ostree cleanup [OPTION…]
Clear cached/pending data
Help Options:
-h, --help Show help options
Application Options:
--stateroot=STATEROOT Operate on provided STATEROOT
-b, --base Clear temporary files; will leave deployments unchanged
-p, --pending Remove pending deployment
-r, --rollback Remove rollback deployment
-m, --repomd Delete cached rpm repo metadata
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree compose --help
Usage:
rpm-ostree compose [OPTION…] COMMAND
Commands to compose a tree
Builtin "compose" Commands:
build-chunked-oci Generate a "chunked" OCI archive from an input rootfs
commit Commit a target path to an OSTree repository
container-encapsulate Generate a reproducible "chunked" container image (using RPM data) from an OSTree commit
extensions Download RPM packages guaranteed to depsolve with a base OSTree
image Generate a reproducible "chunked" container image (using RPM data) from a treefile
install Install packages into a target path
postprocess Perform final postprocessing on an installation root
rootfs Generate a root filesystem tree from a treefile
tree Process a "treefile"; install packages and commit the result to an OSTree repository
Help Options:
-h, --help Show help options
Application Options:
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree db --help
Usage:
rpm-ostree db [OPTION…] COMMAND
Commands to query the RPM database
Builtin "db" Commands:
diff Show package changes between two commits
list List packages within commits
version Show rpmdb version of packages within the commits
Help Options:
-h, --help Show help options
Application Options:
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree deploy --help
Usage:
rpm-ostree deploy [OPTION…] REVISION
Deploy a specific commit
Help Options:
-h, --help Show help options
Application Options:
--stateroot=STATEROOT Operate on provided STATEROOT
-r, --reboot Initiate a reboot after operation is complete
--preview Just preview package differences
-C, --cache-only Do not download latest ostree and RPM data
--download-only Just download latest ostree and RPM data, don't deploy
--skip-branch-check Do not check if commit belongs on the same branch
--disallow-downgrade Forbid deployment of chronologically older trees
--unchanged-exit-77 If no new deployment made, exit 77
--register-driver=DRIVERNAME Register the calling agent as the driver for updates; if REVISION is an empty string, register driver without deploying
--bypass-driver Force a deploy even if an updates driver is registered
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--install=PKG Overlay additional package
--uninstall=PKG Remove overlayed additional package
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree initramfs --help
Usage:
rpm-ostree initramfs [OPTION…]
Enable or disable local initramfs regeneration
Help Options:
-h, --help Show help options
Application Options:
--stateroot=STATEROOT Operate on provided STATEROOT
--enable Enable regenerating initramfs locally using dracut
--arg=ARG Append ARG to the dracut arguments
--disable Disable regenerating initramfs locally
-r, --reboot Initiate a reboot after operation is complete
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree initramfs-etc --help
Usage:
rpm-ostree initramfs-etc [OPTION…]
Add files to the initramfs
Help Options:
-h, --help Show help options
Application Options:
--stateroot=STATEROOT Operate on provided STATEROOT
--force-sync Deploy a new tree with the latest tracked /etc files
--track=FILE Track root /etc file
--untrack=FILE Untrack root /etc file
--untrack-all Untrack all root /etc files
-r, --reboot Initiate a reboot after operation is complete
--unchanged-exit-77 If no new deployment made, exit 77
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree install --help
Usage:
rpm-ostree install [OPTION…] PACKAGE [PACKAGE...]
Overlay additional packages
Help Options:
-h, --help Show help options
Application Options:
--uninstall=PKG Remove overlayed additional package
-C, --cache-only Do not download latest ostree and RPM data
--download-only Just download latest ostree and RPM data, don't deploy
-A, --apply-live Apply changes to both pending deployment and running filesystem tree
--force-replacefiles Allow package to replace files from other packages
--stateroot=STATEROOT Operate on provided STATEROOT
-r, --reboot Initiate a reboot after operation is complete
-n, --dry-run Exit after printing the transaction
-y, --assumeyes Auto-confirm interactive prompts for non-security questions
--allow-inactive Allow inactive package requests
--idempotent Do nothing if package already (un)installed
--unchanged-exit-77 If no overlays were changed, exit 77
--enablerepo Enable the repository based on the repo id. Is only supported in a container build.
--disablerepo Only disabling all (*) repositories is supported currently. Is only supported in a container build.
--releasever Set the releasever. Is only supported in a container build.
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree kargs --help
Usage:
rpm-ostree kargs [OPTION…]
Query or modify kernel arguments
Help Options:
-h, --help Show help options
Application Options:
--stateroot=STATEROOT Operate on provided STATEROOT
--deploy-index=INDEX Modify the kernel args from a specific deployment based on index. Index is in the form of a number (e.g. 0 means the first deployment in the list)
--reboot Initiate a reboot after operation is complete
--append=KEY=VALUE Append kernel argument; useful with e.g. console= that can be used multiple times. empty value for an argument is allowed
--replace=KEY=VALUE=NEWVALUE Replace existing kernel argument, the user is also able to replace an argument with KEY=VALUE if only one value exist for that argument
--delete=KEY=VALUE Delete a specific kernel argument key/val pair or an entire argument with a single key/value pair
--append-if-missing=KEY=VALUE Like --append, but does nothing if the key is already present
--delete-if-present=KEY=VALUE Like --delete, but does nothing if the key is already missing
--unchanged-exit-77 If no kernel args changed, exit 77
--import-proc-cmdline Instead of modifying old kernel arguments, we modify args from current /proc/cmdline (the booted deployment)
--editor Use an editor to modify the kernel arguments
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree override --help
Usage:
rpm-ostree override [OPTION…] COMMAND
Manage base package overrides
Builtin "override" Commands:
remove Remove packages from the base layer
replace Replace packages in the base layer
reset Reset currently active package overrides
Help Options:
-h, --help Show help options
Application Options:
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree rebase --help
Usage:
rpm-ostree rebase [OPTION…] REFSPEC [REVISION]
Switch to a different tree
Help Options:
-h, --help Show help options
Application Options:
--stateroot=STATEROOT Operate on provided STATEROOT
-b, --branch=BRANCH Rebase to branch BRANCH; use --remote to change remote as well
-m, --remote=REMOTE Rebase to current branch name using REMOTE; may also be combined with --branch
-r, --reboot Initiate a reboot after operation is complete
--skip-purge Keep previous refspec after rebase
-C, --cache-only Do not download latest ostree and RPM data
--download-only Just download latest ostree and RPM data, don't deploy
--custom-origin-description Human-readable description of custom origin
--custom-origin-url Machine-readable description of custom origin
--experimental Enable experimental features
--disallow-downgrade Forbid deployment of chronologically older trees
--bypass-driver Force a rebase even if an updates driver is registered
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--install=PKG Overlay additional package
--uninstall=PKG Remove overlayed additional package
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree refresh-md --help
Usage:
rpm-ostree refresh-md [OPTION…]
Generate rpm repo metadata
Help Options:
-h, --help Show help options
Application Options:
--stateroot=STATEROOT Operate on provided STATEROOT
-f, --force Expire current cache
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree reload --help
Usage:
rpm-ostree reload [OPTION…]
Reload configuration
Help Options:
-h, --help Show help options
Application Options:
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree reset --help
Usage:
rpm-ostree reset [OPTION…]
Remove all mutations
Help Options:
-h, --help Show help options
Application Options:
--stateroot=STATEROOT Operate on provided STATEROOT
-r, --reboot Initiate a reboot after transaction is complete
-l, --overlays Remove all overlayed packages
-o, --overrides Remove all overrides
-i, --initramfs Stop regenerating initramfs or tracking files
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--install=PKG Overlay additional package
--uninstall=PKG Remove overlayed additional package
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree rollback --help
Usage:
rpm-ostree rollback [OPTION…]
Revert to the previously booted tree
Help Options:
-h, --help Show help options
Application Options:
-r, --reboot Initiate a reboot after operation is complete
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree search --help
Usage:
rpm-ostree search [OPTION…] PACKAGE [PACKAGE...]
Search for packages
Help Options:
-h, --help Show help options
Application Options:
--uninstall=PKG Remove overlayed additional package
-C, --cache-only Do not download latest ostree and RPM data
--download-only Just download latest ostree and RPM data, don't deploy
-A, --apply-live Apply changes to both pending deployment and running filesystem tree
--force-replacefiles Allow package to replace files from other packages
--install=PKG Overlay additional package
--all Remove all overlayed additional packages
--stateroot=STATEROOT Operate on provided STATEROOT
-r, --reboot Initiate a reboot after operation is complete
-n, --dry-run Exit after printing the transaction
-y, --assumeyes Auto-confirm interactive prompts for non-security questions
--allow-inactive Allow inactive package requests
--idempotent Do nothing if package already (un)installed
--unchanged-exit-77 If no overlays were changed, exit 77
--enablerepo Enable the repository based on the repo id. Is only supported in a container build.
--disablerepo Only disabling all (*) repositories is supported currently. Is only supported in a container build.
--releasever Set the releasever. Is only supported in a container build.
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree status --help
Usage:
rpm-ostree status [OPTION…]
Get the version of the booted system
Help Options:
-h, --help Show help options
Application Options:
-v, --verbose Print additional fields (e.g. StateRoot); implies -a
-a, --advisories Expand advisories listing
--json Output JSON
-J, --jsonpath=EXPRESSION Filter JSONPath expression
-b, --booted Only print the booted deployment
--pending-exit-77 If pending deployment available, exit 77
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree uninstall --help
Usage:
rpm-ostree uninstall [OPTION…] PACKAGE [PACKAGE...]
Remove overlayed additional packages
Help Options:
-h, --help Show help options
Application Options:
--install=PKG Overlay additional package
--all Remove all overlayed additional packages
--stateroot=STATEROOT Operate on provided STATEROOT
-r, --reboot Initiate a reboot after operation is complete
-n, --dry-run Exit after printing the transaction
-y, --assumeyes Auto-confirm interactive prompts for non-security questions
--allow-inactive Allow inactive package requests
--idempotent Do nothing if package already (un)installed
--unchanged-exit-77 If no overlays were changed, exit 77
--enablerepo Enable the repository based on the repo id. Is only supported in a container build.
--disablerepo Only disabling all (*) repositories is supported currently. Is only supported in a container build.
--releasever Set the releasever. Is only supported in a container build.
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree upgrade --help
Usage:
rpm-ostree upgrade [OPTION…]
Perform a system upgrade
Help Options:
-h, --help Show help options
Application Options:
--stateroot=STATEROOT Operate on provided STATEROOT
-r, --reboot Initiate a reboot after operation is complete
--allow-downgrade Permit deployment of chronologically older trees
--preview Just preview package differences (implies --unchanged-exit-77)
--check Just check if an upgrade is available (implies --unchanged-exit-77)
-C, --cache-only Do not download latest ostree and RPM data
--download-only Just download latest ostree and RPM data, don't deploy
--unchanged-exit-77 If no new deployment made, exit 77
--bypass-driver Force an upgrade even if an updates driver is registered
--sysroot=SYSROOT Use system root SYSROOT (default: /)
--peer Force a peer-to-peer connection instead of using the system message bus
--install=PKG Overlay additional package
--uninstall=PKG Remove overlayed additional package
--version Print version information and exit
-q, --quiet Avoid printing most informational messages
$ rpm-ostree usroverlay --help
Usage:
ostree admin unlock [OPTION…]
Make the current deployment mutable (as a hotfix or development)
Help Options:
-h, --help Show help options
Application Options:
--sysroot=PATH Create a new OSTree sysroot at PATH
--hotfix Retain changes across reboots
--transient Mount overlayfs read-only by default
-v, --verbose Print debug information during command processing
--version Print version information and exit
$ rpm-ostree --version
rpm-ostree:
Version: '2025.8'
Git: 966eee9be1b9d89aaccef2c6a1eadcdb40494542
Features:
- rust
- compose
- container
- fedora-integration