2022-03-23

eggs

eggs(1) -- the reproductive system of penguins: eggs v9.0.7-1

SYNOPSIS

deb package

$ sudo dpkg -i eggs_9.0.7-1_amd64.deb

npm package

$ npm install -g penguins-eggs
$ eggs COMMAND
running command...
$ eggs (-v|--version|version)

penguins-eggs/9.0.7-1 linux-x64 node-v16.13.2
$ 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 config
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 cle installer (krill).

COMMANDS

eggs adapt
eggs autocomplete [SHELL]
eggs bro
eggs calamares
eggs config
eggs dad
eggs export deb
eggs export docs
eggs export iso
eggs help [COMMAND]
eggs info
eggs install
eggs kill
eggs mom
eggs produce
eggs remove
eggs tools clean
eggs tools locales
eggs tools skel
eggs tools stat
eggs tools yolk
eggs update
eggs version

`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

ALIASES
  $ eggs adjust

`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

`eggs bro`

bro: waydroid helper

USAGE
  $ eggs bro [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  bro: waydroid helper

`eggs calamares`

calamares or install or configure it

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

FLAGS
  -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=<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

`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

ALIASES
  $ eggs prerequisites

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

`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

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

`eggs info`

re-thinking for a different approach to CLI

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

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

DESCRIPTION
  re-thinking for a different approach to CLI

`eggs install`

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

USAGE
  $ eggs install [-c] [-h] [-v]

FLAGS
  -c, --cli      force use CLI installer
  -h, --help     Show CLI help.
  -v, --verbose  verbose

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

ALIASES
  $ eggs hatch
  $ eggs krill

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

`eggs mom`

ask for mommy - gui helper

USAGE
  $ eggs mom [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  ask for mommy - gui helper

`eggs produce`

the system produce an egg: iso image of your system

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
  the system produce an egg: iso image of your system

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

`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

`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

ALIASES
  $ eggs clean

`eggs tools locales`

install/clean locales

USAGE
  $ eggs tools locales [-h] [-r] [-v]

FLAGS
  -h, --help       Show CLI help.
  -r, --reinstall  reinstall locales
  -v, --verbose    verbose

DESCRIPTION
  install/clean locales

`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

ALIASES
  $ eggs skel

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

ALIASES
  $ eggs stat

`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] [-a] [-b] [-v]

FLAGS
  -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.
  -v, --verbose  verbose

DESCRIPTION
  update the penguin's eggs tool

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

`eggs version`

USAGE
  $ eggs version

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

sudo eggs update # select basket, choose the version and download it but not install. The package will saver in /tmp;

remove old version:

sudo apt --purge eggs # remove eggs

and, finally install the new one:

sudo dpkg -i /tmp/eggs_7.7.9-1_amd64.deb # install eggs from downloaded package

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.

website: https://penguins-eggs.net
gitHub repository: https://github.com/pieroproietti/penguins-eggs

AUTHOR

Piero Proietti piero.proietti@gmail.com