penguins-eggs

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

Index

• Index
• Presentation
• Addons
• What distributions can I use?
• Install penguins-eggs
• Usage
• Commands
• That’s all Folks!

Presentation

penguins-eggs is a console utility, in active development, who let you to remaster your system and redistribuite it as iso images or from the lan via PXE remote boot.

The scope of this project is to implement the process of remastering your version of Linux, generate it as ISO image to burn on a CD/DVD or copy to a usb key to boot your system. You can also boot your egg - via remote boot - on your LAN.

All it is written in pure typescript, so ideally can be used with differents Linux distros. Yes, there are big differences about package manager used, but not so much in the way to work of bash and various programs used to build the iso.

penguins-eggs, at the moment 2020 september 13 is a mature tool, yes can have again same troubles for people not in confidence with Linux system administration, but can be already extremely usefull, You can easily create your organization/school version of Linux and deploy it on your LAN, give it to your friends as usb key or publish eggs in the internet!

You can try now penguins-eggs, it is a console utility - no GUI - but don’t be scared, penguins-eggs is a console command - really very simple - if you are able to open a terminal, you can use it.

Addons

Starting with version 7.6.x, an addons architecture has been added to eggs, that allows third parties to develop extensions. Note that we currently have an extension for the theme that includes both calamares branding and installer link and icon. In addition, also as addon has been developed others addons, to chosen hoosing between GUI or CLI installation, adapd video resolution, etc.

What distributions can I use?

Eggs is born on Debian strecth/buster, full support Debian bullseys, Devuan beowulf, Ubuntu focal, bionic and derivatives. I usually try it against Debian buster, Devuan beowulf, Linux Mint 19.3 tricia (bionic derivated) and Linux Mint 20 ulyana (focal derivated) before releases. I tried it successfully in LMDE 4 debbie, and deepin. Eggs, generally must work with all the derivates from that distros.

Some iso images remastered with eggs are in the sourceforge page of the project.

Note about deb packages

You can use the same package for all distributions using deb, naturally choosing the appropriate architecture (i386/amd64).

Install penguins-eggs

Debian package

Actually eggs is released both in deb package for i386 as amd64 architectures.

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

sudo dpkg -i eggs_7.5.122-1_amd64.deb

or, on a i386 system:

sudo dpkg -i eggs_7.5.122-1_i386.deb

Note about deb packages You can use the same package for all distributions using deb, naturally choosing the appropriate architecture (i386/amd64).

Notes on nodejs versions and i386 architecture . You can read more about at i386-nodejs.

NPM package (require nodejs)

If you have already nodejs installed, you can install penguins-eggs with the utility npm (node package manager).

Simply copy and past the following lines:

sudo npm config set unsafe-perm true

sudo npm i penguins-eggs -g

Usage

$ npm install -g penguins-eggs
$ eggs COMMAND
running command...
$ eggs (-v|--version|version)
penguins-eggs/7.6.65 linux-x64 node-v14.15.0
$ eggs --help [COMMAND]
USAGE
  $ eggs COMMAND
...

Commands

• eggs adapt
• eggs calamares
• eggs export:deb
• eggs export:docs
• eggs export:iso [FILE]
• eggs help [COMMAND]
• eggs info
• eggs install
• eggs kill
• eggs prerequisites
• eggs produce
• eggs sterilize
• eggs tools:clean
• eggs tools:initrd
• eggs tools:locales
• eggs tools:sanitize
• eggs tools:skel
• eggs tools:yolk
• eggs update

eggs adapt

adapt monitor resolution for VM only

USAGE
  $ eggs adapt

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

ALIASES
  $ eggs adjust

See code: src/commands/adapt.ts

eggs calamares

calamares or install or configure it

USAGE
  $ eggs calamares

OPTIONS
  -h, --help     show CLI help
  -i, --install  install calamares and it's dependencies
  -v, --verbose
  --final        final: remove eggs prerequisites, calamares and all it's dependencies
  --theme=theme  theme/branding for eggs and calamares

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: src/commands/calamares.ts

eggs export:deb

export package eggs-v7-6-x-1.deb in the destination host

USAGE
  $ eggs export:deb

OPTIONS
  -c, --clean  remove old .deb before to copy
  -h, --help   show CLI help

See code: src/commands/export/deb.ts

eggs export:docs

remove and export docType documentation of the sources in the destination host

USAGE
  $ eggs export:docs

OPTIONS
  -h, --help  show CLI help

See code: src/commands/export/docs.ts

eggs export:iso [FILE]

export iso in the destination host

USAGE
  $ eggs export:iso [FILE]

OPTIONS
  -c, --clean  delete old ISOs before to copy
  -h, --help   show CLI help

See code: src/commands/export/iso.ts

eggs help [COMMAND]

display help for eggs

USAGE
  $ eggs help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

eggs info

informations about system and eggs

USAGE
  $ eggs info

EXAMPLE
  $ eggs info
  You will find here informations about penguin's eggs!

See code: src/commands/info.ts

eggs install

system installater cli (the eggs became penguin)

USAGE
  $ eggs install

OPTIONS
  -g, --gui        use gui installer
  -h, --info       show CLI help
  -l, --lvmremove  remove lvm /dev/pve
  -u, --umount     umount devices
  -v, --verbose    verbose

ALIASES
  $ eggs hatch

EXAMPLE
  $ eggs install
  penguin's eggs installation

See code: src/commands/install.ts

eggs kill

kill the eggs/free the nest

USAGE
  $ eggs kill

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  verbose

EXAMPLE
  $ eggs kill
  kill the eggs/free the nest

See code: src/commands/kill.ts

eggs prerequisites

install packages prerequisites to run eggs

USAGE
  $ eggs prerequisites

OPTIONS
  -c, --configuration  create configuration's files
  -h, --help           show CLI help
  -l, --links          create links
  -v, --verbose        verbose

EXAMPLES
  ~$ eggs prerequisites
  install prerequisites and create configuration files

  sudo eggs prerequisites -c
    create configuration's file

See code: src/commands/prerequisites.ts

eggs produce

the system produce an egg: livecd creation.

USAGE
  $ eggs produce

OPTIONS
  -b, --basename=basename  basename egg
  -c, --compress           max compression
  -f, --fast               fast compression
  -h, --help               show CLI help
  -s, --script             script mode. Generate scripts to manage iso build
  -v, --verbose            verbose
  -y, --yolk               -y force the renew of the local repository yolk
  --adapt                  adapt video resolution in VM
  --final                  final: remove eggs prerequisites, calamares and all it's dependencies
  --ichoice                allows the user to choose the installation type cli/gui
  --pve                    administration of virtual machines (Proxmox-VE)
  --rsupport               remote support via dwagent
  --theme=theme            theme/branding for eggs and calamares

ALIASES
  $ eggs spawn
  $ eggs lay

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
  the same as the previuos, but with more explicative output

  $ sudo eggs produce -vf
  the same as the previuos, compression lz4 (fast compression, but about 30%
  less compressed compared xz standard)

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

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

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

  $ 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: src/commands/produce.ts

eggs sterilize

remove all packages installed as prerequisites, calamares and configurations

USAGE
  $ eggs sterilize

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  verbose

See code: src/commands/sterilize.ts

eggs tools:clean

clean system log, apt, etc

USAGE
  $ eggs tools:clean

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  verbose

See code: src/commands/tools/clean.ts

eggs tools:initrd

Test initrd

USAGE
  $ eggs tools:initrd

OPTIONS
  -h, --help     show CLI help
  -v, --verbose
  --check=check  check if necessary to clean initrd.img
  --clean=clean  clean the initrd.img

See code: src/commands/tools/initrd.ts

eggs tools:locales

install/clean locales

USAGE
  $ eggs tools:locales

OPTIONS
  -h, --help       show CLI help
  -r, --reinstall  reinstall locales
  -v, --verbose    verbose

See code: src/commands/tools/locales.ts

eggs tools:sanitize

sanitize

USAGE
  $ eggs tools:sanitize

OPTIONS
  -h, --help  show CLI help

See code: src/commands/tools/sanitize.ts

eggs tools:skel

update skel from home configuration

USAGE
  $ eggs tools:skel

OPTIONS
  -h, --help       show CLI help
  -u, --user=user  user to be used
  -v, --verbose

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

See code: src/commands/tools/skel.ts

eggs tools:yolk

configure eggs to install without internet

USAGE
  $ eggs tools:yolk

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

EXAMPLE
  $ eggs yolk -v

See code: src/commands/tools/yolk.ts

eggs update

update/upgrade the penguin’s eggs tool.

USAGE
  $ eggs update

OPTIONS
  -h, --help      show CLI help
  -i, --internet  import deb package from internet
  -l, --lan       import deb package from LAN
  -v, --verbose   verbose

DESCRIPTION
  This way of update work only with npm installation, if you used the debian package version, please download the new 
  one and install it.

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

See code: src/commands/update.ts

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

You can find more informations at Penguin’s eggs blog.

Contacts

Feel free to contact me or open an issue on github.

• mail: piero.proietti@gmail.com

Copyright and licenses

Copyright (c) 2017, 2020 Piero Proietti, dual licensed under the MIT or GPL Version 2 licenses.