Node's Perpetuum Mobile

    penguins-eggs
    TypeScript icon, indicating that this package has built-in type declarations

    9.1.37 • Public • Published

    Stand With Ukraine

    penguins-eggs

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

    sources blog sources-documentation guide npm version deb iso

    Index

    Presentation

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

    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. You can also boot your "egg" via remote booting-on your LAN. You can easily install your live system with the calamares installer or the eggs TUI installer.

    Also, 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 GUI or server configurations. See penguins-wardrobe, fork it and adapt it to yours needs.

    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 in the way bash works and the various programs used to build the isos.

    penguins-eggs, as of May 2022, is a mature tool and is extremely powerful: you can easily create your own custom version of Linux for your organization/school and distribute it on your LAN, give it to your friends as a usb key, or post your images on the Internet!

    Have no fear, yes eggs is a console utility - without a graphical user interface - but it is really simple - if you are able to open a terminal, you can use it and your end users will enjoy a complete help and fully graphical installation procedure.

    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.

    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.

    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.

    krill

    eggs include a CLI installer named krill, this let you to produce and install servers configurations. krill use a nice TUI interface using the same, configuration created by eggs for calamares. This lead to have "about the same" experience installing, from old distros to new ones and for GUI and CLI. To force using krill in place of calamares in a GUI system just: sudo eggs install --cli

    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

    You can use the backup mode by simply adding --backup in the produce command. This way eggs will save your users data and accounts and will not add a live user, you will have to log in with the main user of your system with the his password. Note: since eggs always configures autologin, you may have a security risk with valuable data. Use this option only for your personal stuff and do not share the iso on the network.

    • eggs produce just remove users accounts and home. This let to have working servers examples;
    • eggs produce --backup remove servers and users data from live, and put them on a LUKS volume.

    We have another two commands for backup/restore: eggs syncfrom and eggs syncto. A working installation, can easily sync users and servers data to a luks-eggs-backup file:

    • eggs syncto -f /tmp/luks-eggs-backup backup users and servers data to LUKS volume /tmp/luks-eggs-backup:

    Or a new installation, can easyly get users and servers data from a luks-eggs-backup:

    • eggs syncfrom from -f /tmp/luks-eggs-backup restore users and servers data from the LUKS volume /tmp/luks-eggs-backup.

    NOTE:

    • krill: sudo eggs install --cli will restore users and servers data automatically;
    • installing with calamares: when installation is finished, you need to mount the rootdir of your installed system and, give the following command: sudo eggs syncfrom -f /path/to/luks-eggs-backup -r /path/to/rootdir
    • it's possbile actually to change the nest directory, editing configuration file /etc/penguins-eggs.d/eggs.yaml. Example: set snapshot_dir: '/opt/eggs/', but you can't use the following: /etc, /boot, /usr and /var.

    DISCLAIM: using this feathures in non appropriate way can be dangerous for your data:

    • syncfrom replace all users homes and all servers homes with data from the luck-eggs-backup file, Force this data in a not appropriate system can easily end in a long disaster recovery.

    What distributions can I use?

    eggs was born on Debian strecth, buster and followinng. Actually full support Debian from jessie to bookworm/sid, Devuan beowulf, chimaera, daedalus, Ubuntu bionic, focal, jammy - and all derivatives from them including Linux mint, Deepin, neon KDE, etc - ManjaroLinux and finally Arch, the last distro added.

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

    What architecture can I use?

    Eggs, can be released for differents architectures: amd64, arm64 and armel. Actually I'm producing mainly for PCs (amd64) and armel. Someone want to contribute to bring eggs on raspberrypi?

    Packages

    eggs is released deb packages for i386, amd64, armel and arm64 architectures. Due the characteristic of eggs, they can installed in Debian, Devuan or Ubuntu based distros, withouth worries about different versions, except for the architecture. It include standard scripts for preinst, postinst, prerm and postrm. The packages usually go before in sourgeforce page of eggs, (unstable version) and later in ppa (stable version).

    Install eggs

    There are more than a way to install eggs, the most common it's to 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 -SsL  https://pieroproietti.github.io/penguins-eggs-ppa/KEY.gpg | gpg --dearmor | sudo tee /usr/share/keyrings/penguins-eggs-ppa-keyring.gpg
    sudo curl -s --compressed -o /etc/apt/sources.list.d/penguins-eggs-ppa.list "https://pieroproietti.github.io/penguins-eggs-ppa/penguins-eggs-ppa.list"
    

    Update your repositories: sudo apt update and install eggs: 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.1.26_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.

    Manual upgrade

    Simply download new versions of eggs from sourgeforge page and install it with the standard command sudo dpkg -i eggs_8.17.x-1_amd64.deb.

    Usage

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

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

    Commands

    eggs adapt

    adapt monitor resolution for VM only

    USAGE
      $ eggs adapt [-v] [-h]
    
    FLAGS
      -h, --help     Show CLI help.
      -v, --verbose
    
    DESCRIPTION
      adapt monitor resolution for VM only
    

    See code: src/commands/adapt.ts

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

    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] [-v] [-i] [-r] [--remove] [--theme <value>]
    
    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: src/commands/calamares.ts

    eggs config

    Configure and install prerequisites deb packages to run it

    USAGE
      $ eggs config [-n] [-c] [-h] [-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: src/commands/config.ts

    eggs dad

    ask help from daddy - configuration helper

    USAGE
      $ eggs dad [-h] [-c] [-d] [-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: src/commands/dad.ts

    eggs export deb

    export deb/docs/iso to the destination host

    USAGE
      $ eggs export deb [-h] [-c] [--amd64] [--i386] [--armel] [--arm64] [-a]
    
    FLAGS
      -a, --all    export all archs
      -c, --clean  remove old .deb before to copy
      -h, --help   Show CLI help.
      --amd64      export amd64 arch
      --arm64      export arm64 arch
      --armel      export armel arch
      --i386       export i386 arch
    
    DESCRIPTION
      export deb/docs/iso to the destination host
    

    eggs export docs

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

    USAGE
      $ eggs export docs [-h]
    
    FLAGS
      -h, --help  Show CLI help.
    
    DESCRIPTION
      remove and export docType documentation of the sources in the destination host
    

    eggs export iso

    export iso in the destination host

    USAGE
      $ eggs export iso [-h] [-b] [-c]
    
    FLAGS
      -b, --backup  export backup ISOs
      -c, --clean   delete old ISOs before to copy
      -h, --help    Show CLI help.
    
    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 info

    informations about eggs configuration

    USAGE
      $ eggs info [-v] [-h]
    
    FLAGS
      -h, --help     Show CLI help.
      -v, --verbose
    
    DESCRIPTION
      informations about eggs configuration
    

    See code: src/commands/info.ts

    eggs install

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

    USAGE
      $ eggs install [-c] [-k] [-p] [-h] [-v]
    
    FLAGS
      -c, --cli      force use CLI installer
      -h, --help     Show CLI help.
      -k, --crypted  crypted CLI installation
      -p, --pve      Proxmox VE install
      -v, --verbose  verbose
    
    DESCRIPTION
      command-line system installer - the egg became a penguin!
    
    ALIASES
      $ eggs install
    
    EXAMPLES
      $ eggs install
      Install the system using GUI or CLI installer
    

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

    eggs krill

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

    USAGE
      $ eggs krill [-c] [-k] [-p] [-h] [-v]
    
    FLAGS
      -c, --cli      force use CLI installer
      -h, --help     Show CLI help.
      -k, --crypted  crypted CLI installation
      -p, --pve      Proxmox VE install
      -v, --verbose  verbose
    
    DESCRIPTION
      command-line system installer - the egg became a penguin!
    
    ALIASES
      $ eggs install
    
    EXAMPLES
      $ eggs install
      Install the system using GUI or CLI installer
    

    See code: src/commands/krill.ts

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

    eggs produce

    produce a live image from your system whithout your data

    USAGE
      $ eggs produce [-p <value>] [--basename <value>] [-b] [-f] [-n] [-m] [-v] [-y] [-s] [-h] [--theme <value>]
        [--addons <value>] [--release]
    
    FLAGS
      -b, --backup          backup mode
      -f, --fast            fast compression
      -h, --help            Show CLI help.
      -m, --max             max compression
      -n, --normal          normal compression
      -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: configure GUI installer to remove 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: src/commands/produce.ts

    eggs remove

    remove eggs and others stuff

    USAGE
      $ eggs remove [-p] [-a] [-h] [-v]
    
    FLAGS
      -a, --autoremove  remove eggs packages dependencies
      -h, --help        Show CLI help.
      -p, --purge       remove eggs configurations files
      -v, --verbose     verbose
    
    DESCRIPTION
      remove eggs and others stuff
    
    EXAMPLES
      $ sudo eggs remove 
      remove eggs
    
      $ sudo eggs remove --purge 
      remove eggs, eggs configurations, configuration's files
    
      $ sudo eggs remove --autoremove 
      remove eggs, eggs configurations, packages dependencies
    

    See code: src/commands/remove.ts

    eggs syncfrom

    Restore users, server and datas from luks-eggs-backup

    USAGE
      $ eggs syncfrom [--delete <value>] [-f <value>] [-r <value>] [-h] [-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, server and datas from luks-eggs-backup
    
    EXAMPLES
      $ sudo eggs restore
    

    See code: src/commands/syncfrom.ts

    eggs syncto

    saving users' datas and accounts on LUKS volume

    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
      saving users' datas and accounts on LUKS volume
    
    EXAMPLES
      $ sudo eggs syncto
    

    See code: src/commands/syncto.ts

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

    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] [-v] [-h]
    
    ARGUMENTS
      REPO  repository to get
    
    FLAGS
      -h, --help     Show CLI help.
      -v, --verbose
    
    DESCRIPTION
      get warorobe
    

    eggs wardrobe ironing [COSTUME]

    ordered show of costumes or accessories in wardrobe

    USAGE
      $ eggs wardrobe ironing [COSTUME] [-w <value>] [-v] [-h]
    
    ARGUMENTS
      COSTUME  costume
    
    FLAGS
      -h, --help              Show CLI help.
      -v, --verbose
      -w, --wardrobe=<value>  wardrobe
    
    DESCRIPTION
      ordered show of costumes or accessories in wardrobe
    

    eggs wardrobe list [WARDROBE]

    list costumes and accessoires in wardrobe

    USAGE
      $ eggs wardrobe list [WARDROBE] [-v] [-h]
    
    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] [-w <value>] [-j] [-v] [-h]
    
    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] [-w <value>] [-a] [-f] [-s] [-v] [-h]
    
    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
    

    Terminal samples

    terminal samples

    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

    Copyright and licenses

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

    Install

    npm i penguins-eggs

    DownloadsWeekly Downloads

    997

    Version

    9.1.37

    License

    MIT

    Unpacked Size

    18.2 MB

    Total Files

    538

    Last publish

    Collaborators

    • pieroproietti