eggs(1) -- A reproductive system for penguins

SYNOPSIS

$ npm install -g penguins-eggs
$ eggs COMMAND
running command...
$ eggs (-v|--version|version)
penguins-eggs/ amd64 v14.16.0}
$ eggs --help [COMMAND]

USAGE
$ eggs COMMAND

Most of the commands of eggs need sudo, but there are exceptions for export, info and mom.

examples:

sudo eggs init
sudo eggs produce
sudo eggs kill

There are too, two interactive helpers:

eggs mom
sudo eggs dad

Help yorself signing in the forum or in facebook group page or asking me.

DESCRIPTION

eggs is a console utility, in active development, who let you to remaster your system and redistribuite it as iso image.

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 easily install your live system with gui installer (calamares) or eggs cli installer.

COMMANDS

eggs adapt

adapt monitor resolution for VM only

USAGE
  $ eggs adapt

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

ALIASES
  $ eggs adjust

eggs autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ eggs autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

EXAMPLES
  $ eggs autocomplete
  $ eggs autocomplete bash
  $ eggs autocomplete zsh
  $ eggs autocomplete --refresh-cache

eggs calamares

calamares or install or configure it

USAGE
  $ eggs calamares

OPTIONS
  -f, --final    final: remove calamares and all it's dependencies after the installation
  -h, --help     show CLI help
  -i, --install  install calamares and it's dependencies
  -r, --remove   remove calamares and it's dependencies
  -v, --verbose
  --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

eggs config

Configure eggs and install packages prerequisites to run it

USAGE
  $ eggs config

OPTIONS
  -c, --clean          remove old configuration before to create
  -h, --help           show CLI help
  -n, --nointeractive  assume yes
  -v, --verbose        verbose

ALIASES
  $ eggs prerequisites

EXAMPLE
  ~$ sudo eggs config
  Configure eggs and install prerequisites

eggs dad

ask help from daddy - configuration helper

USAGE
  $ eggs dad

OPTIONS
  -c, --clean    remove old configuration before to create
  -h, --help     show CLI help
  -v, --verbose

eggs export:deb

export deb/docs/iso to the destination host

USAGE
  $ eggs export:deb

OPTIONS
  -c, --clean  remove old .deb before to copy
  -h, --help   show CLI help
  --all        export all archs
  --amd64      export amd64 arch
  --armel      export armel arch
  --i386       export i386 arch

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

eggs export:iso

export iso in the destination host

USAGE
  $ eggs export:iso

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

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

eggs info

informations about system and eggs

USAGE
  $ eggs info

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

eggs install

system installer - the egg became a penguin

USAGE
  $ eggs install

OPTIONS
  -c, --cli        force use eggs CLI installer
  -h, --help       show CLI help
  -l, --lvmremove  remove lvm /dev/pve
  -m, --mx         try to use GUI MX installer
  -u, --umount     umount devices
  -v, --verbose    verbose

ALIASES
  $ eggs hatch

EXAMPLE
  $ eggs install
  Install the system using GUI or CLI installer

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

eggs mom

ask for mommy - gui helper

USAGE
  $ eggs mom

OPTIONS
  -h, --help  show CLI help

eggs produce

the system produce an egg: iso image of your system

USAGE
  $ eggs produce

OPTIONS
  -b, --basename=basename  basename
  -f, --fast               fast compression
  -h, --help               show CLI help
  -m, --max                max compression
  -n, --normal             normal compression
  -p, --prefix=prefix      prefix
  -s, --script             script mode. Generate scripts to manage iso build
  -v, --verbose            verbose
  -y, --yolk               -y force yolk renew
  --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 (fastest but about 30%
  less compressed than xz)

  $ sudo eggs produce -vm
  the same as the previuos, compression xz (normal compression xz)

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

  $ 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

eggs remove

remove eggs and others stuff

USAGE
  $ eggs remove

OPTIONS
  -a, --autoremove  remove eggs packages dependencies
  -h, --help        show CLI help
  -p, --purge       remove eggs configurations files
  -v, --verbose     verbose

EXAMPLES
  $ sudo eggs remove 
  remove eggs

  $ sudo eggs remove --prerequisites 
  remove eggs, eggs configurations, packages prerequisites

eggs tools:clean

clean system log, apt, etc

USAGE
  $ eggs tools:clean

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

ALIASES
  $ eggs clean

eggs tools:locales

install/clean locales

USAGE
  $ eggs tools:locales

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

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

ALIASES
  $ eggs skel

EXAMPLE
  $ 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

OPTIONS
  -h, --help   show CLI help
  -m, --month  current month
  -y, --year   current year

ALIASES
  $ eggs stat

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

eggs update

update the penguin's eggs tool

USAGE
  $ eggs update

OPTIONS
  -a, --apt      if eggs package is .deb, update from distro repositories
  -b, --basket   if eggs package is .deb, update from eggs basket
  -h, --help     show CLI help
  -n, --npm      if eggs package is .npm, update from npmjs.com
  -v, --verbose  verbose

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

FILES

  /etc/penguins-eggs.d
    all eggs configurations are here

  /usr/local/share/penguins-eggs/exclude.list
    exclude.list rsync

  /usr/lib/penguins-eggs (deb package)
    here eggs is installed
  OR
  /usr/lib/node_modules/penguins-eggs/ (npm package)
    here eggs is installed

TROUBLES

Different versions of eggs can have differents configurations files. This can lead to get errors.

A fast workaround for this trouble can be:

Here are the commands to do:

BUGS

Report problems o new ideas in: https://github.com/pieroproietti/penguins-eggs/issues

RESOURCES AND DOCUMENTATION

Consult website to find documentation, forum. There is a facebook gruop and page too.

AUTHOR

Piero Proietti piero.proietti@gmail.com