penguins-eggs

Penguins' eggs are generated and new birds are ready to fly...

Index

Index
Presentation
Technology
Features
Packages
Usage
Commands
Penguins' eggs official guide
That's all Folks!

Presentation

penguins-eggs is a console tool, under continuous development, that allows you to remaster your system and redistribute it as live images on usb sticks or via PXE.

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, using 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 --cryptedclone.

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 to yours needs.

Technology

eggs is written mostly in typescript and ideally can be used with different Linux distributions. Yes, there are big differences in terms of package manager used, path, etc, but basically the various programs used to build the live are the same.

Currently eggs supports: Debian, Devuan, Ubuntu, Arch, Manjaro and derivatives.

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

Features

wardrobe, themes and addons

wardrobe was added to eggs on april 2022. It 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, warbier and chicks mostly under plastilinux, waydroid or bullseye on eggs' sourceforge page.

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 Penguins' eggs blog.

Addons, mostly themes have been grouped under vendors folder in the penguins-wardrobe, try to use wardrobe for all your customizations.

Consult wardrobe users' guide.

clone/cryptedclone

You can create your live to distribute it - the default mode - or with datas using clone and clonecrypted:

eggs produce

Completely removes user data from live, this is the preset mode

eggs produce --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 --cryptedclone

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 --cryptedclone include all users data CRYPTED on a LUKS volume inside the iso.

Using krill: sudo eggs install will automaticaly restore your CRYPTED data during the installation.

calamares and krill

eggs was developed to use calamares as the system installer and allows its customization with themes. 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. This provides a "roughly similar" installation experience for both desktop and 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 will then be used for automatic installation.

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 added two built-in assistants with eggs: mom and dad. While mom is a script based on easybashgui that explains the various commands and documentation, dad started as a shortcut to properly configure eggs: just type sudo eggs dad and follow simple instructions. Even faster, using sudo eggs dad -d you will resets the configuration, loads defaults, deletes created isos. At this point, with eggs configured, just type sudo produce to generate your live.

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.

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 PKGBUILDs.

Debian families

eggs is released as a deb package for amd64, armel and arm64 architectures. Because of eggs' features, they can be installed in Debian, Devuan, or Ubuntu-based distros without worrying about version (buster, bullseye, bookworm, etc.) except for architecture. It includes standard scripts for preinst, postinst, prerm and postrm and man pages.

Install eggs

There are more than a way to install eggs as .deb package, the most practical is to add and use penguins-eggs-ppa.

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.5.12_amd64.deb

or, on a i386 system:

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

Once eggs is installed you can add the penguins-eggs-ppa repository with the command: sudo eggs tools ppa --install

Using penguins-eggs-ppa (stable version)

eggs have its 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

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_0.5.12_amd64.deb.

Arch families

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 and I'm participating in the Manjaro Community Repository.

The development versions of penguins eggs and other PKGBUILDs are instead in my penguins-eggs-pkgbuilds repository.

Arch

It's possible to install penguins-eggs from AUR adding repo Chaotic-AUR and using sudo pacman -Sy penguins-eggs.

Of course you can also use yay: yay penguins-eggs or download the sources and run makepkg:

git clone https://aur.archlinux.org/packages/penguins-eggs
cd penguins-eggs
makepkg -srcCi

Manjaro

From penguins-eggs v9.4.3 the package is part of the Manjaro community repo and can be installed with pamac install penguins-eggs, alternatively you can download it and:

git clone https://gitlab.manjaro.org/packages/community/penguins-eggs/
cd penguins-eggs
makepkg -srcCi

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. You can also use the eggs mom command that interactively allows you to consult the help for all commands and online documentation.

Examples

Create a live system without user data:

sudo eggs produce

Create a live system with user data uncrypted.

sudo eggs produce --clone

Create a live system with the encrypted user data.

sudo eggs produce --cryptedclone

At the moment eggs uses the default fast compression, which provides a faster compression speed, for the final compression it is worth using the --max flag to get more compressed ISOs.

In addition to the description of the commands in this README, you can consult the Penguins' eggs official guide.

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

EXAMPLES
  $ eggs adapt

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`

configure calamares or install or configure it

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

FLAGS
  -h, --help           Show CLI help.
  -i, --install        install calamares and its dependencies
  -n, --nointeractive  no user interaction
  -N, --noicons        no icons  
  -r, --release        release: remove calamares and all its dependencies after the installation
  -v, --verbose
  --remove             remove calamares and its dependencies
  --theme=<value>      theme/branding for eggs and calamares

DESCRIPTION
  configure calamares or install or configure it

EXAMPLES
  sudo eggs calamares

  sudo eggs calamares --install

  sudo eggs calamares --install --theme=/path/to/theme

  sudo eggs calamares --remove

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  no user interaction
  -N, --noicons        no icons

DESCRIPTION
  Configure and install prerequisites deb packages to run it

EXAMPLES
  sudo eggs config

  sudo eggs config --clean

  sudo eggs config --clean --nointeractive

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

See code: dist/commands/cuckoo.js

`eggs dad`

ask help from daddy - TUI 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 - TUI configuration helper

EXAMPLES
  sudo dad

  sudo dad --clean

  sudo dad --default

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

EXAMPLES
  $ eggs export deb

  $ eggs export deb --clean

  $ eggs export deb --all

`eggs export iso`

export iso in the destination host

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

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

DESCRIPTION
  export iso in the destination host

EXAMPLES
  $ eggs export iso

  $ eggs export iso --clean

`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`

krill: the CLI system installer - the egg became a penguin!

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

FLAGS
  -H, --halt            Halt the system after installation
  -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   no user interaction
  -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
  krill: the CLI system installer - the egg became a penguin!

EXAMPLES
  sudo eggs install

  sudo eggs install --unattended

  sudo eggs install --custom it

See code: dist/commands/install.js

`eggs kill`

kill the eggs/free the nest

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

FLAGS
  -h, --help           Show CLI help.
  -n, --nointeractive  no user interaction
  -v, --verbose        verbose

DESCRIPTION
  kill the eggs/free the nest

EXAMPLES
  sudo eggs kill

See code: dist/commands/kill.js

`eggs mom`

ask help from mommy - TUI helper

USAGE
  $ eggs mom [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  ask help from mommy - TUI helper

EXAMPLES
  $ eggs mom

See code: dist/commands/mom.js

`eggs produce`

produce a live image from your system whithout your data

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

FLAGS
  -C, --cryptedclone    crypted clone
  -c, --clone           clone
  -f, --standard        standard compression
  -h, --help            Show CLI help.
  -m, --max             max compression
  -N, --noicons         no icons
  -n, --nointeractive   no user interaction
  -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

  sudo eggs produce --standard

  sudo eggs produce --max

  sudo eggs produce --max --basename=colibri

  sudo eggs produce --cryptedclone

  sudo eggs produce --clone

  sudo eggs produce --basename=colibri

  sudo eggs produce --basename=colibri --theme /path/to/theme --addons adapt

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

EXAMPLES
  $ 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 syncfrom

  sudo eggs syncfrom --file /path/to/fileLUKS

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

  sudo eggs syncto --file /path/to/fileLUKS

See code: dist/commands/syncto.js

`eggs tools clean`

clean system log, apt, etc

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

FLAGS
  -h, --help           Show CLI help.
  -n, --nointeractive  no user interaction
  -v, --verbose        verbose

DESCRIPTION
  clean system log, apt, etc

EXAMPLES
  sudo eggs tools clean

`eggs tools ppa`

add/remove PPA repositories (Debian family)

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

FLAGS
  -a, --add            add penguins-eggs PPA repository
  -h, --help           Show CLI help.
  -n, --nointeractive  no user interaction
  -r, --remove         remove penguins-eggs PPA repository
  -v, --verbose        verbose

DESCRIPTION
  add/remove PPA repositories (Debian family)

EXAMPLES
  sudo eggs tools ppa --add

  sudo eggs tools ppa --remove

`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
  sudo eggs tools skel

  sudo eggs tools skel --user user-to-be-copied

`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

EXAMPLES
  $ eggs tools stat

  $ eggs tools stat --month

  $ eggs tools stat --year

`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
  sudo eggs tools yolk

`eggs update`

update the Penguins' eggs tool

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

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

DESCRIPTION
  update the Penguins' eggs tool

EXAMPLES
  $ eggs update

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

EXAMPLES
  $ eggs wardrobe get

  $ eggs wardrobe get your-wardrobe

`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

EXAMPLES
  $ eggs wardrobe list

  $ eggs wardrobe list your-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

EXAMPLES
  $ eggs wardrobe show colibri

  $ eggs wardrobe show accessories/firmwares

  $ eggs wardrobe show accessories/

`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

EXAMPLES
  sudo eggs wardrobe wear duck

  sudo eggs wardrobe wear accessories/firmwares

  sudo eggs wardrobe wear wagtail/waydroid

Penguins' eggs official guide

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

Penguins' eggs official guide

A nice thing to do to help users could be to make terminal samples, I did this some time ago, but they should be updated.

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 Penguins' eggs official guide and same other documentation - mostly for developers - on the repository penguins-eggs under documents. I want to point out hens, differents species a brief how to use eggs in Debian. Arch and Manjaro, and the post Arch-naked on the blog which describes how to create an Arch naked live, install it, then dress the resulting system with a graphics development station.

You can contact me by mail or follow me on blog, facebook, github, jtsi, reddit, telegram, twitter.

pieroproietti/penguins-eggs

pieroproietti

Reviews

Repository Details

penguins-eggs

Penguins' eggs are generated and new birds are ready to fly...

Index

Presentation

Technology

Features

wardrobe, themes and addons

clone/cryptedclone

calamares and krill

cuckoo

mom and dad

yolk

Packages

Debian families

Install eggs

Download the package and install with dpkg

Using penguins-eggs-ppa (stable version)

Upgrade eggs

Arch families

Arch

Manjaro

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]

Penguins' eggs official guide

That's all Folks!

More informations

Copyright and licenses

More Repositories

`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]`