ABRoot Manpage

Aug 29, 2023 — by Vanilla-OS, kbdharun

abrootmanpage

NAME

ABRoot is utility which provides full immutability and atomicity to a Linux system, by transacting between two root filesystems. It's updates are performed using OCI images, to ensure that the system is always in a consistent state.

SYNOPSIS

abroot [command] [arguments] [options]

DESCRIPTION

ABRoot provides full immutability and atomicity by performing transactions between 2 root partitions (A<->B)

Usage:
  abroot [command]

Available Commands:
  completion       Generate the autocompletion script for the specified shell
  config-editor    Edit ABRoot configuration
  help             Help about any command
  kargs            Manage kernel parameters
  pkg              Manage packages
  rollback         Return the system to a previous state
  status           Display status
  update-initramfs Update the initramfs
  upgrade          Upgrade the system

Flags:
  -h, --help      help for abroot
  -v, --verbose   show more detailed output
      --version   version for abroot

Use "abroot [command] --help" for more information about a command.

COMPLETION

Generate the autocompletion script for abroot for the specified shell.
See each sub-command's help for details on how to use the generated script.

Usage:
  abroot completion [command]

Available Commands:
  bash        Generate the autocompletion script for bash
  fish        Generate the autocompletion script for fish
  powershell  Generate the autocompletion script for powershell
  zsh         Generate the autocompletion script for zsh

Flags:
  -h, --help   help for completion

Global Flags:
  -v, --verbose   show more detailed output

Use "abroot completion [command] --help" for more information about a command.

CONFIG EDITOR

Open an editor to edit the ABRoot configuration.

Usage:
  abroot config-editor [flags]

Flags:
  -h, --help   help for config-editor

Global Flags:
  -v, --verbose   show more detailed output

KARGS

Manage kernel parameters.

Usage:
  abroot kargs edit|show [flags]

Examples:
abroot kargs edit

Flags:
  -h, --help   help for kargs

Global Flags:
  -v, --verbose   show more detailed output

PKG

Install and manage packages.

Usage:
  abroot pkg add|remove|list|apply [flags]

Examples:
abroot pkg add <pkg>

Flags:
  -d, --dry-run                       perform a dry run of the operation
  -f, --force-enable-user-agreement   force enable user agreement, for embedded systems
  -h, --help                          help for pkg

Global Flags:
  -v, --verbose   show more detailed output

ROLLBACK

Executes a system rollback, discarding changes made to the present root.

Usage:
  abroot rollback [flags]

Examples:
abroot rollback

Flags:
  -c, --check-only   check if rollback to previous root is possible
  -h, --help         help for rollback

Global Flags:
  -v, --verbose   show more detailed output

STATUS

Display the current ABRoot status.

Usage:
  abroot status [flags]

Examples:
abroot status

Flags:
  -d, --dump   dump the ABRoot status to an archive
  -h, --help   help for status
  -j, --json   show output in JSON format

Global Flags:
  -v, --verbose   Show more detailed output

UPDATE-INITRAMFS

Update the initramfs of the future root.

Usage:
  abroot update-initramfs [flags]

Examples:
abroot update-initramfs

Flags:
  -d, --dry-run   perform a dry run of the operation
  -h, --help      help for update-initramfs

Global Flags:
  -v, --verbose   show more detailed output

UPGRADE

Check for a new system image and apply it.

Usage:
  abroot upgrade [flags]

Examples:
abroot upgrade

Flags:
  -c, --check-only   check for updates but do not apply them
  -d, --dry-run      perform a dry run of the operation
  -f, --force        force update even if the system is up to date
  -h, --help         help for upgrade

Global Flags:
  -v, --verbose   show more detailed output

SEE ALSO

REPORTING BUGS

Report bugs to the issue tracker.