zephyrctl#
zephyrctl is a command-line interface (CLI) script that serves as the central control panel for Zephyr 
. This page outlines the available commands and their usages.
burn#
Craft a bootable USB stick by burning the provided disk-image (ISO file) onto a USB flash drive. This can be the remixed ISO file or any other disk-image file.
All files on the drive will be lost!
There are some safe-guards in place, but still be careful when selecting the disk!
Create backups if necessary.
Usage
zephyrctl burn ISO_FILE [DISK]
Params:
ISO_FILE ISO file to burn (e.g. zephyr.iso)
DISK Target USB flash drive device (e.g. /dev/sdc).
Interactive selection if not specified.
customize#
Execute a customization module for a specific profile. Effectively update the system to match configurations in the customization profile.
Usage
zephyrctl customize PROFILE [MODULE]...
Params:
PROFILE Customization profile to use
MODULE Module/category to run (eg. apt, system).
If prefixed with '~', then the module
or the whole category is skipped (e.g ~apt, ~system).
If none given, all modules will be executed.
Examples
# Run all modules with the 'default' profile
zephyrctl customize default
# Run only 'locale' and 'sudo' modules with the 'foo' profile
zephyrctl customize foo locale sudo
# Skip 'certificates' and all 'tools' modules but run others
zephyrctl customize default ~certificates ~tools
# Skip 'apt' but run all other 'packages' modules
zephyrctl customize default ~apt packages
disk#
Manage disk layouts before installing Ubuntu. This command allows you to partition, format, or encrypt volumes based on disk maps.
This operation is destructive!
Ensure you back up your data before proceeding.
Usage
zephyrctl disk SUBCOMMAND PROFILE MAP...
Params:
SUBCOMMAND What to do with the disks
PROFILE Customization profile to use
MAP Disk maps
Subcommands:
decrypt Open encrypted partitions and volumes
encrypt Encrypt partitions and volumes
format Format filesystems on a partition or volume
info Show disk information
lvm Setup LVM (volume groups, physical and logical volumes)
partition Partition disk
zap Delete all partitions and LVM structures on a disk
extract-grub#
It is possible to override the GRUB configuration in the remixed ISO file. To create this custom GRUB config file, you can use this command to extract grub.cfg from the stock Ubuntu ISO file and modify it.
Usage
zephyrctl extract-grub ISO_FILE [EXTRACTED]
Params:
ISO_FILE ISO file to extract GRUB configuration from
EXTRACTED Path to save the extracted 'grub.cfg'.
Default is 'extracted.grub.cfg' in the current directory.
format#
Format partitions as per the provided profile and disk maps.
This will delete all files on selected partitions!
Don't forget to back up your data!
Deprecated
This command is deprecated and will be removed in the future. Use zephyrctl disk format instead.
Usage
zephyrctl format PROFILE MAP...
Params:
PROFILE Customization profile to use
MAP Disk maps
help#
Obtain information on how to use zephyrctl commands.
Usage
zephyrctl help [COMMAND]
Params:
COMMAND Name of the command to show help for.
If empty, all available commands will be listed.
install#
Install Zephyr on your computer.
Usage
zephyrctl install
launch#
Launch Ubuntu installer (ubiquity) in Automatic mode. Use this command on the liveCD to start the installation GUI.
Usage
zephyrctl launch
partition#
Partition a drive according to the provided profile and disk maps.
This will delete all files on selected partitions!
Please watch out for possible data-loss and back up your data beforehand!
Deprecated
This command is deprecated and will be removed in the future. Use zephyrctl disk partition instead.
Usage
zephyrctl partition PROFILE MAP...
Params:
PROFILE Customization profile to use
MAP Disk maps
post-install#
Perform various OS post-installation steps such as GRUB configuration and GPT backup.
Usage
zephyrctl post-install ENVIRONMENT PROFILE MAP...
Params:
ENVIRONMENT Environment where the command is executed
live: live system
install: Ubuntu post-installation step
dev: useful when developing Zephyr
PROFILE Customization profile to use
MAP Disk maps
remix#
Remix an Ubuntu image file to embed Zephyr & customization profiles, and an optional payload. This payload can be any files or scripts that you want to embed into the ISO file.
Usage
zephyrctl remix ISO_IN [ISO_OUT]
Params:
ISO_IN ISO file to remix (e.g. path/to/ubuntu-20.04.6-desktop-amd64.iso)
ISO_OUT Path to save the remixed ISO file.
Default is 'zephyr.iso' in the current directory.
uninstall#
Removes Zephyr from your computer.
Usage
zephyrctl uninstall