.TH APT-OSTREE 1 "2025-08-13" "apt-ostree 0.1.0" "System Administration"
.SH NAME
apt-ostree \- Debian/Ubuntu equivalent of rpm-ostree
.SH SYNOPSIS
.B apt-ostree
[\fIOPTIONS\fR] \fICOMMAND\fR [\fIARGS\fR]
.SH DESCRIPTION
.B apt-ostree
is a tool for managing atomic, immutable deployments on Debian and Ubuntu systems
using OSTree as the backend. It provides functionality similar to rpm-ostree but
adapted for APT package management, enabling atomic updates and rollbacks on
Debian-based systems.
.PP
The tool integrates APT package management with OSTree's atomic deployment model,
allowing system administrators to maintain immutable system images while still
benefiting from Debian's package ecosystem.
.SH COMMANDS
.SS "Package Management Commands"
.TP
.B info \fIPACKAGE\fR
Display detailed information about a package, including dependencies, conflicts,
and metadata.
.TP
.B search \fIQUERY\fR
Search for packages in the APT repositories.
.TP
.B install \fIPACKAGES\fR
Install packages and create a new OSTree deployment.
.TP
.B remove \fIPACKAGES\fR
Remove packages and create a new OSTree deployment.
.TP
.B upgrade
Upgrade all packages and create a new OSTree deployment.
.TP
.B rollback
Rollback to the previous OSTree deployment.
.TP
.B status
Show the current OSTree deployment status.

.SS "System Management Commands"
.TP
.B deploy \fIDEPLOYMENT\fR
Deploy a specific OSTree deployment.
.TP
.B rebase \fIREPO\fR [\fIBRANCH\fR]
Rebase to a different OSTree repository or branch.
.TP
.B cleanup
Clean up old deployments and unused objects.
.TP
.B log
Show deployment history and changes.
.TP
.B remote
Manage OSTree remotes.
.TP
.B refs
List available references in the OSTree repository.

.SS "Kernel and Boot Commands"
.TP
.B kargs
Manage kernel command-line arguments.
.TP
.B initramfs
Manage initial RAM filesystem regeneration.

.SS "Transaction Management Commands"
.TP
.B transaction
Manage atomic transactions for system changes.
.TP
.B start-daemon
Start the apt-ostreed system daemon.

.SS "Development Commands (Hidden)"
.TP
.B testutils
Development and testing utilities (hidden command).
.TP
.B shlib-backend
Shared library backend operations (hidden command).
.TP
.B internals
Internal system diagnostics (hidden command).

.SS "Experimental Commands"
.TP
.B compose
Compose new OSTree trees.
.TP
.B db
Query package database.
.TP
.B override
Manage package overrides.
.TP
.B reset
Reset system to clean state.
.TP
.B refresh-md
Refresh metadata.

.SS "Container Commands"
.TP
.B container
Manage container operations.

.SS "Telemetry Commands"
.TP
.B metrics
Export system metrics.
.TP
.B health
Check system health status.

.SH OPTIONS
.TP
.B \-h, \-\-help
Show help message and exit.
.TP
.B \-V, \-\-version
Show version information and exit.
.TP
.B \-\-verbose
Enable verbose output.
.TP
.B \-\-quiet
Suppress non-error messages.
.TP
.B \-\-json
Output in JSON format.
.TP
.B \-\-pretty
Pretty-print output.

.SH EXAMPLES
.TP
Show package information:
.B apt-ostree info apt
.TP
Search for packages:
.B apt-ostree search curl
.TP
Install a package:
.B apt-ostree install nginx
.TP
Remove a package:
.B apt-ostree remove apache2
.TP
Upgrade all packages:
.B apt-ostree upgrade
.TP
Rollback to previous deployment:
.B apt-ostree rollback
.TP
Manage kernel arguments:
.B apt-ostree kargs --append "console=ttyS0"
.TP
Start the daemon:
.B apt-ostree start-daemon

.SH FILES
.TP
.B /etc/apt-ostree/
Configuration directory for apt-ostree.
.TP
.B /var/lib/apt-ostree/
Data directory for apt-ostree.
.TP
.B /ostree/
OSTree repository and deployments.
.TP
.B /etc/systemd/system/apt-ostreed.service
Systemd service file for the daemon.

.SH ENVIRONMENT
.TP
.B APT_OSTREE_CONFIG
Path to configuration file (default: /etc/apt-ostree/config.toml).
.TP
.B APT_OSTREE_DATA_DIR
Path to data directory (default: /var/lib/apt-ostree).
.TP
.B APT_OSTREE_LOG_LEVEL
Log level for debugging (default: info).
.TP
.B APT_OSTREE_DAEMON_SOCKET
Path to daemon socket (default: /run/apt-ostreed.sock).

.SH EXIT STATUS
.TP
.B 0
Success.
.TP
.B 1
General error.
.TP
.B 2
Configuration error.
.TP
.B 3
Package operation failed.
.TP
.B 4
OSTree operation failed.
.TP
.B 77
No changes detected (for --unchanged-exit-77 option).

.SH BUGS
Report bugs to the project issue tracker at
.IR https://github.com/robojerk/apt-ostree/issues .

.SH AUTHOR
Written by Robojerk <robojerk@example.com>.

.SH COPYRIGHT
Copyright \(co 2025 Robojerk. License GPL-3.0-or-later: GNU GPL version 3 or later
<https://gnu.org/licenses/gpl.html>.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

.SH SEE ALSO
.BR ostree (1),
.BR apt (8),
.BR dpkg (1),
.BR rpm-ostree (1),
.BR systemctl (1),
.BR polkit (8)
.PP
The full documentation for apt-ostree is maintained as a Texinfo manual.
If the info and apt-ostree programs are properly installed at your site,
the command
.IP
.B info apt-ostree
.PP
should give you access to the complete manual.