penguins-eggs

Penguin's eggs are generated and new birds are ready to fly...

Index

Index
Presentation
Technology
Features
Packages
Usage
Commands
Penguin's eggs official book
That's all Folks!

Presentation

penguins-eggs is a console utility, under continuous development, that allows you to remaster your system and redistribute it as iso images.

The purpose of this project is to implement the process of remastering your own version of Linux, generate it as an ISO image to burn to a CD/DVD or copy to a USB stick to boot your system. The default behavior is total removal of the system's data and users, but it is also possible to remaster the system including the data and accounts of present users, use flag --clone. It is also possible to keep the users and files present under an encrypted LUKS file within the same resulting iso file, flag --backup.

You can easily install the resulting live system with the calamares installer or the internal TUI krill installer. It is possible to have also unattended installation using --unattended flag.

Thanks to the wardrobe, you can create or use scripts to switch from a "naked" version - with only a CLI interface - and "wear" it with a full GUI or server configurations. See penguins-wardrobe, fork it and adapt it to yours needs.

Technology

The whole thing is written in pure typescript, so ideally it can be used with different Linux distributions. Yes, there are major differences in terms of the package manager used, but not so much on the way the various programs used to build the isos work. Actually eggs support: Debian, Devuan, Ubuntu, Arch and ManjaroLinux.

You can read more on the blog, some examples of iso images remastered with eggs are in the sourceforge page of the project.

Features

addons and themes

Addons are used mostly to let third parties to develop extensions. Note that currently we have an extension for the theme that includes both branding calamares, link and installer icon. In addition, also as an addon has been developed choose between GUI or CLI installation, adapt the video resolution, link to remote support, etc.

backup/clone

We have two methods to save in the live system all our data: clone and backup.

eggs produce --fast --clone

saves our users and our data directly in the generated iso. The data will be visible directly from the live and accessible to anyone who gets a copy.

eggs produce --fast --backup

saves our data within the generated iso using a LUKS volume. Our data will NOT be visible in the live system but can be reinstalled automatically with krill installer. Even having the generated image available, our data will be protected by the LUKS passphrase.

eggs produce this is the default: all private data are removed on the live.
eggs produce --clone include all users data UNCRYPTED directly on the live.
eggs produce --backup include all users data CRYPTED on a LUKS volume inside the iso.

Using sudo eggs install --cli will automaticaly restore your CRYPTED backup automatically during the installation.

calamares and krill

eggs was developed to use the excellent calamares as a system installer and allows customization. It also includes its own installer called krill, which allows you to produce and install CLI systems such as servers. krill uses a CLI interface that mimics calamares and uses the same configuration files created by eggs for calamares itself. This results in having "about the same" installation experience from old distros to new ones, desktop or server installations. With krill it is also possible to have unattended installations, simply by adding the --unattended flag, the configuration values can be changed in /etc/penguins-eggs.d/krill.yaml and they will be used for the configuration.

cuckoo

The cuckoo lays its eggs in the nests of other birds, and the eggs are hatched by the latter. Similarly eggs can start a self-configuring PXE service to allow you to boot and install your iso on third party networked computers. Command cuckoo can be used either to deploy a newly created iso on an installed system or by live booting the iso itself.

mom and dad

I've added two lightweight assistants integrated with eggs: mom and dad. While mom is a bash script with whiptail - and guides the user to the various commands and documentation, dad started as a short way to create isos. All you have to do is type sudo eggs dad and follow simple instructions. You can also shortcut the way to reset the configuration sudo dad -c or - even faster - reset the configuration, load defaults, kill created isos: simply type sudo eggs dad -d and you will immediately be able to produce the egg in the default /home/eggs nest.

wardrobe

wardrobe was added to eggs on april 2022, it's is a way to guide and consolidate the process of creating a custom version of Linux, starting from a CLI system. All my personal editions are passed to use wardrobe for their convenience, in that way I can organize, consolidate and manage better my work. I used birds names for my customizations, we have: colibri, duck, eagle, owl, wagtail and warbier.

I hope peoples will be interested in wardrobe and you will end to fork the main repository and add your customizations: together will be possibile to make great steps impossible for a single developer.

You can read more in wardrobe on penguin's eggs blog. The results of mine customizations are mostly under Debian bullseye, Devuan chimaera and Ubuntu jammy on my sourgeforce page.

yolk

yolk - so called staying on the subject of eggs - is a local repository included in the livecd that contains a minimum of indispensable packages during installation. Thanks to yolk, you can safely install your system without the need of an active internet connection. Yolk, It is used only for Debian families and derivated.

Packages

Supporting various distributions, we need to have different packages. Debian, Devuan and Ubuntu share the .deb packages of eggs, while for Arch Linux and ManjaroLinux they use their PKGBUILD.

Debian families

eggs is released deb packages for amd64, armel and arm64 architectures. Due the characteristic of eggs, they can installed in Debian, Devuan or Ubuntu based distros, without worries about different versions, except for the architecture. It include standard scripts for preinst, postinst, prerm and postrm.

Install eggs

There are more than a way to install eggs as .deb package, the most common it's to add and use penguins-eggs-ppa.

Using penguins-eggs-ppa (stable version)

eggs have it's repository ppa, You can use it, copy and paste in a terminal window the following two lines:

curl -fsSL https://pieroproietti.github.io/penguins-eggs-ppa/KEY.gpg | sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/penguins-eggs.gpg
echo "deb [arch=$(dpkg --print-architecture)] https://pieroproietti.github.io/penguins-eggs-ppa ./" | sudo tee /etc/apt/sources.list.d/penguins-eggs.list > /dev/null

Update your repositories and install eggs:

sudo apt update && sudo apt install eggs

Download the package and install with dpkg

The simplest way to install eggs is download the package eggs from sourceforge page of the project and install it

sudo dpkg -i eggs_9.2.2_amd64.deb

or, on a i386 system:

sudo dpkg -i eggs_8.17.17-1_i386.deb

Upgrade eggs

If you are using penguins-eggs-ppa You can ugrade eggs as others packages just: sudo apt upgrade, else simply download new versions of eggs from sourgeforge page and install it with the standard command sudo dpkg -i eggs_.9.2.2-1_amd64.deb.

Arch families: Arch and ManjaroLinux

eggs has been present in AUR for a long time, even without my knowledge thanks the support of Arch peoples. I am currently directly maintaining the AUR version of penguins-eggs for Arch, however you can refer to the versions for Arch and manjaro in their respective repositories on github.

To install eggs on Arch, simply git clone https://github.com/pieroproietti/penguins-eggs-arch, cd penguins-eggs-arch, then makepkg -si.

The same for manjaro: git clone https://github.com/pieroproietti/penguins-eggs-manjaro, cd penguins-eggs-manjaro, then makepkg -si.

Usage

Once the package has been installed, you can have the new eggs command. Typing eggs will get the list of commands, typing eggs produce --help will get the eggs produce command help screen. You can also use the command autocomplete with the TABS key, you will get the possible choices for each command. In addition, there is a man page, so by typing man eggs you will get that help as well. A more guided approach can be made usind eggs mom, will present a menu with various commands.

Examples

Create a live system without user data:

sudo eggs produce --fast

Create a live system with user data uncrypted.

sudo eggs produce --fast --clone

Create a live system with the encrypted user data.

sudo eggs produce --fast --backup

Especially during the first trials, you should always use the --fast flag that will ensure a fast creation of the ISO, later you can use --max flag and get ISOs more compressed.

In addition to the description of the commands in this README, you can consult the Penguin's eggs official book.

Commands

eggs adapt
eggs analyze
eggs autocomplete [SHELL]
eggs calamares
eggs config
eggs cuckoo
eggs dad
eggs export deb
eggs export iso
eggs help [COMMAND]
eggs install
eggs kill
eggs mom
eggs produce
eggs status
eggs syncfrom
eggs syncto
eggs tools clean
eggs tools ppa
eggs tools skel
eggs tools stat
eggs tools yolk
eggs update
eggs version
eggs wardrobe get [REPO]
eggs wardrobe list [WARDROBE]
eggs wardrobe show [COSTUME]
eggs wardrobe wear [COSTUME]

`eggs adapt`

adapt monitor resolution for VM only

USAGE
  $ eggs adapt [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  adapt monitor resolution for VM only

See code: dist/commands/adapt.js

`eggs analyze`

analyze for syncto

USAGE
  $ eggs analyze [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose  verbose

DESCRIPTION
  analyze for syncto

EXAMPLES
  $ sudo eggs analyze

See code: dist/commands/analyze.js

`eggs autocomplete [SHELL]`

display autocomplete installation instructions

USAGE
  $ eggs autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ eggs autocomplete

  $ eggs autocomplete bash

  $ eggs autocomplete zsh

  $ eggs autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

`eggs calamares`

calamares or install or configure it

USAGE
  $ eggs calamares [-h] [-i] [-r] [--remove] [--theme <value>] [-v]

FLAGS
  -h, --help       Show CLI help.
  -i, --install    install calamares and it's dependencies
  -r, --release    release: remove calamares and all it's dependencies after the installation
  -v, --verbose
  --remove         remove calamares and it's dependencies
  --theme=<value>  theme/branding for eggs and calamares

DESCRIPTION
  calamares or install or configure it

EXAMPLES
  ~$ sudo eggs calamares 
  create/renew calamares configuration's files

  ~$ sudo eggs calamares -i 
  install calamares and create it's configuration's files

See code: dist/commands/calamares.js

`eggs config`

Configure and install prerequisites deb packages to run it

USAGE
  $ eggs config [-c] [-h] [-n] [-v]

FLAGS
  -c, --clean          remove old configuration before to create new one
  -h, --help           Show CLI help.
  -n, --nointeractive  assume yes
  -v, --verbose        verbose

DESCRIPTION
  Configure and install prerequisites deb packages to run it

EXAMPLES
  ~$ sudo eggs config
  Configure and install prerequisites deb packages to run it

See code: dist/commands/config.js

`eggs cuckoo`

PXE start with proxy-dhcp

USAGE
  $ eggs cuckoo [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  PXE start with proxy-dhcp

EXAMPLES
  $ sudo eggs cuckoo
  start a PXE server with dhcp-proxy (can coexists with a real dhcp server)

See code: dist/commands/cuckoo.js

`eggs dad`

ask help from daddy - configuration helper

USAGE
  $ eggs dad [-c] [-d] [-h] [-v]

FLAGS
  -c, --clean    remove old configuration before to create
  -d, --default  remove old configuration and force default
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  ask help from daddy - configuration helper

See code: dist/commands/dad.js

`eggs export deb`

export deb/docs/iso to the destination host

USAGE
  $ eggs export deb [-a] [-c] [-h] [-v]

FLAGS
  -a, --all      export all archs
  -c, --clean    remove old .deb before to copy
  -h, --help     Show CLI help.
  -v, --verbose  verbose

DESCRIPTION
  export deb/docs/iso to the destination host

`eggs export iso`

export iso in the destination host

USAGE
  $ eggs export iso [-b] [-c] [-h] [-v]

FLAGS
  -b, --backup   export backup ISOs
  -c, --clean    delete old ISOs before to copy
  -h, --help     Show CLI help.
  -v, --verbose  verbose

DESCRIPTION
  export iso in the destination host

`eggs help [COMMAND]`

Display help for eggs.

USAGE
  $ eggs help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for eggs.

See code: @oclif/plugin-help

`eggs install`

command-line system installer - the egg became a penguin!

USAGE
  $ eggs install [-k] [-c <value>] [-d <value>] [-h] [-i] [-n] [-N] [-p] [-r] [-s] [-S] [-u] [-v]

FLAGS
  -N, --none            Swap none: 256M
  -S, --suspend         Swap suspend: RAM x 2
  -c, --custom=<value>  custom unattended configuration
  -d, --domain=<value>  Domain name, defult: .local
  -h, --help            Show CLI help.
  -i, --ip              hostname as ip, eg: ip-192-168-1-33
  -k, --crypted         Crypted CLI installation
  -n, --nointeractive   assume yes
  -p, --pve             Proxmox VE install
  -r, --random          Add random to hostname, eg: colibri-ay412dt
  -s, --small           Swap small: RAM
  -u, --unattended      Unattended installation
  -v, --verbose         Verbose

DESCRIPTION
  command-line system installer - the egg became a penguin!

EXAMPLES
  $ eggs install
  Install the system using krill installer

See code: dist/commands/install.js

`eggs kill`

kill the eggs/free the nest

USAGE
  $ eggs kill [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose  verbose

DESCRIPTION
  kill the eggs/free the nest

EXAMPLES
  $ eggs kill
  kill the eggs/free the nest

See code: dist/commands/kill.js

`eggs mom`

ask for mommy - gui helper

USAGE
  $ eggs mom [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  ask for mommy - gui helper

See code: dist/commands/mom.js

`eggs produce`

produce a live image from your system whithout your data

USAGE
  $ eggs produce [--addons <value>] [-b] [--basename <value>] [-c] [-f] [-h] [-m] [-n] [-p <value>]
    [--release] [-s] [--theme <value>] [-v] [-y]

FLAGS
  -b, --backup          backup mode (CRYPTED)
  -c, --clone           clone mode
  -f, --fast            fast compression
  -h, --help            Show CLI help.
  -m, --max             max compression
  -n, --nointeractive   don't ask for user interctions
  -p, --prefix=<value>  prefix
  -s, --script          script mode. Generate scripts to manage iso build
  -v, --verbose         verbose
  -y, --yolk            -y force yolk renew
  --addons=<value>...   addons to be used: adapt, ichoice, pve, rsupport
  --basename=<value>    basename
  --release             release: max compression, remove penguins-eggs and calamares after installation
  --theme=<value>       theme for livecd, calamares branding and partitions

DESCRIPTION
  produce a live image from your system whithout your data

EXAMPLES
  $ sudo eggs produce 
  produce an ISO called [hostname]-[arch]-YYYY-MM-DD_HHMM.iso, compressed xz (standard compression).
  If hostname=ugo and arch=i386 ugo-x86-2020-08-25_1215.iso

  $ sudo eggs produce -v
  same as previuos, but with --verbose output

  $ sudo eggs produce -vf
  same as previuos, compression zstd, lz4 or gzip (depend from system capability)

  $ sudo eggs produce -vm
  same as previuos, compression xz -Xbcj x86 (max compression, about 10%
  more compressed)

  $ sudo eggs produce -vf --basename leo --theme debian --addons adapt 
  produce an ISO called leo-i386-2020-08-25_1215.iso compression fast,
  using Debian theme and link to adapt

  $ sudo eggs produce -v --basename leo --theme debian --addons rsupport 
  produce an ISO called leo-i386-2020-08-25_1215.iso compression xz,
  using Debian theme and link to dwagent

  $ sudo eggs produce -v --basename leo --rsupport 
  produce an ISO called leo-i386-2020-08-25_1215.iso compression xz, using eggs
  theme and link to dwagent

  $ sudo eggs produce -vs --basename leo --rsupport 
  produce scripts to build an ISO as the previus example. Scripts can be found
  in /home/eggs/ovarium and you can customize all you need

See code: dist/commands/produce.js

`eggs status`

informations about eggs status

USAGE
  $ eggs status [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  informations about eggs status

See code: dist/commands/status.js

`eggs syncfrom`

restore users and user data from a LUKS volumes

USAGE
  $ eggs syncfrom [--delete <value>] [-f <value>] [-h] [-r <value>] [-v]

FLAGS
  -f, --file=<value>     file LUKS volume encrypted
  -h, --help             Show CLI help.
  -r, --rootdir=<value>  rootdir of the installed system, when used from live
  -v, --verbose          verbose
  --delete=<value>       rsync --delete delete extraneous files from dest dirs

DESCRIPTION
  restore users and user data from a LUKS volumes

EXAMPLES
  $ sudo eggs restore

See code: dist/commands/syncfrom.js

`eggs syncto`

saves users and user data in a LUKS volume inside the iso

USAGE
  $ eggs syncto [--delete <value>] [-f <value>] [-h] [-v]

FLAGS
  -f, --file=<value>  file LUKS volume encrypted
  -h, --help          Show CLI help.
  -v, --verbose       verbose
  --delete=<value>    rsync --delete delete extraneous files from dest dirs

DESCRIPTION
  saves users and user data in a LUKS volume inside the iso

EXAMPLES
  $ sudo eggs syncto

See code: dist/commands/syncto.js

`eggs tools clean`

clean system log, apt, etc

USAGE
  $ eggs tools clean [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose  verbose

DESCRIPTION
  clean system log, apt, etc

`eggs tools ppa`

add/remove PPA repositories (Debian family)

USAGE
  $ eggs tools ppa [-a] [-h] [-r] [-v]

FLAGS
  -a, --add      add penguins-eggs PPA repository
  -h, --help     Show CLI help.
  -r, --remove   remove penguins-eggs PPA repository
  -v, --verbose  verbose

DESCRIPTION
  add/remove PPA repositories (Debian family)

`eggs tools skel`

update skel from home configuration

USAGE
  $ eggs tools skel [-h] [-u <value>] [-v]

FLAGS
  -h, --help          Show CLI help.
  -u, --user=<value>  user to be used
  -v, --verbose

DESCRIPTION
  update skel from home configuration

EXAMPLES
  $ eggs skel --user mauro
  desktop configuration of user mauro will get used as default

`eggs tools stat`

get statistics from sourceforge

USAGE
  $ eggs tools stat [-h] [-m] [-y]

FLAGS
  -h, --help   Show CLI help.
  -m, --month  current month
  -y, --year   current year

DESCRIPTION
  get statistics from sourceforge

`eggs tools yolk`

configure eggs to install without internet

USAGE
  $ eggs tools yolk [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  configure eggs to install without internet

EXAMPLES
  $ eggs yolk -v

`eggs update`

update the penguin's eggs tool

USAGE
  $ eggs update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose  verbose

DESCRIPTION
  update the penguin's eggs tool

EXAMPLES
  $ eggs update
  update/upgrade the penguin's eggs tool

See code: dist/commands/update.js

`eggs version`

USAGE
  $ eggs version [--json] [--verbose]

FLAGS
  --verbose  Show additional information about the CLI.

GLOBAL FLAGS
  --json  Format output as json.

FLAG DESCRIPTIONS
  --verbose  Show additional information about the CLI.

    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.

See code: @oclif/plugin-version

`eggs wardrobe get [REPO]`

get warorobe

USAGE
  $ eggs wardrobe get [REPO] [-h] [-v]

ARGUMENTS
  REPO  repository to get

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  get warorobe

`eggs wardrobe list [WARDROBE]`

list costumes and accessoires in wardrobe

USAGE
  $ eggs wardrobe list [WARDROBE] [-h] [-v]

ARGUMENTS
  WARDROBE  wardrobe

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  list costumes and accessoires in wardrobe

`eggs wardrobe show [COSTUME]`

show costumes/accessories in wardrobe

USAGE
  $ eggs wardrobe show [COSTUME] [-h] [-j] [-v] [-w <value>]

ARGUMENTS
  COSTUME  costume

FLAGS
  -h, --help              Show CLI help.
  -j, --json              output JSON
  -v, --verbose
  -w, --wardrobe=<value>  wardrobe

DESCRIPTION
  show costumes/accessories in wardrobe

`eggs wardrobe wear [COSTUME]`

wear costume/accessories from wardrobe

USAGE
  $ eggs wardrobe wear [COSTUME] [-h] [-a] [-f] [-s] [-v] [-w <value>]

ARGUMENTS
  COSTUME  costume

FLAGS
  -a, --no_accessories    not install accessories
  -f, --no_firmwares      not install firmwares
  -h, --help              Show CLI help.
  -s, --silent
  -v, --verbose
  -w, --wardrobe=<value>  wardrobe

DESCRIPTION
  wear costume/accessories from wardrobe

Penguin's eggs official book

The original edition of the eggs manual is released in Italian, of course other languages can be accessed using machine translation.

That's all Folks!

No need other configurations, penguins-eggs are battery included or better, as in the real, live is inside! :-D

More informations

There is a Penguin's eggs official book and same other documentation - mostly for developers - on penguins-eggs repo under documents and i386, in particular we have hens, differents species who descrive how to use eggs in manjaro.

You can contact me at pieroproietti@gmail.com or meet me

Gridman44/penguins-eggs

penguins-eggs

Penguin's eggs are generated and new birds are ready to fly...

Index

Presentation

Technology

Features

addons and themes

backup/clone

calamares and krill

cuckoo

mom and dad

wardrobe

yolk

Packages

Debian families

Install eggs

Using penguins-eggs-ppa (stable version)

Download the package and install with dpkg

Upgrade eggs

Arch families: Arch and ManjaroLinux

Usage

Examples

Commands

eggs adapt

eggs analyze

eggs autocomplete [SHELL]

eggs calamares

eggs config

eggs cuckoo

eggs dad

eggs export deb

eggs export iso

eggs help [COMMAND]

eggs install

eggs kill

eggs mom

eggs produce

eggs status

eggs syncfrom

eggs syncto

eggs tools clean

eggs tools ppa

eggs tools skel

eggs tools stat

eggs tools yolk

eggs update

eggs version

eggs wardrobe get [REPO]

eggs wardrobe list [WARDROBE]

eggs wardrobe show [COSTUME]

eggs wardrobe wear [COSTUME]