2024-04-21 21:02:22 +02:00
.TH ARKDEP 8 "21 April 2024"
.SH NAME
arkdep - Manage arkdep deployments
.SH SYNOPSIS
2024-04-22 02:19:18 +02:00
\fB arkdep\fR {option} <version>...
2024-04-21 21:02:22 +02:00
.br
\fB arkdep\fR {option} [variant] [version]
2024-07-15 19:17:24 +02:00
.br
\fB arkdep\fR {option} [variant] [variant]
2024-04-21 21:02:22 +02:00
.SH DESCRIPTION
Arkdep is a utility which downloads, deploys and manages Btrfs subvolume exports.
It is able to perform atomic and immutable system updates, migrate local data to new deployments, update the systemd-boot bootloader configuration and switch the by default booted root subvolume through EFI variables.
.SH OPTIONS
.SS deploy
Deploy a new or update an existing deployment.
.SS init
Initialize arkdep on a new system.
.SS teardown
Remove all arkdep-deploy related files and folders.
.SS cleanup
2024-04-22 01:13:06 +02:00
Remove any hanging images, unfinished downloads and untracked deployments.
2024-04-21 21:02:22 +02:00
.SS healthcheck
Check for and report any config issues or untracked deployments.
.SS get-available
Get and print available variants in repo.
2024-07-14 18:21:50 +02:00
.SS get-update
2024-07-15 19:17:24 +02:00
Get and print diff between current active development and the latest default one provided by the repository or up to two specified variants.
2024-04-21 21:02:22 +02:00
.SS remove
Remove specified deployments.
.SH ENVIRONMENT
.SS ARKDEP_ROOT
Prepend path to arkdep target directory.
.SS ARKDEP_BOOT
Set custom /boot location, overwrites ARKDEP_ROOT on relevant tasks if set, implies ARKDEP_NO_BOOTCTL.
.SS ARKDEP_NO_BOOTCTL
Do not run bootctl commands, this includes installing systemd-boot and setting the new deployment as the default boot entry.
.SH EXAMPLES
.SS arkdep deploy
Check for updates, if available download and deploy.
.SS arkdep deploy test-arkanelinux-kde
Download and deploy the latest version of the defined image variant.
.SS arkdep deploy - stable_v1
Download the defined image version from the default variant.
.SS arkdep deploy test-arkanelinux-kde stable_v1
Download the defined image version from the specified variant.
.SS arkdep deploy cache stable_v1
Deploy an image from the local cache skipping database download and checksum check.
.SS arkdep remove stable_v1
Remove the defined deployment.
