penguins-eggs 9.6.22 → 9.6.34
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.oclif.manifest.json +1 -1
- package/README.md +926 -414
- package/conf/derivatives.yaml +21 -3
- package/conf/distros/README.md +25 -0
- package/conf/distros/bionic/calamares/calamares-modules/sources-yolk/module.yml +8 -0
- package/conf/distros/bionic/calamares/calamares-modules/sources-yolk/sources-yolk.sh +82 -0
- package/conf/distros/bionic/calamares/modules/packages.yml +6 -0
- package/conf/distros/{rolling/calamares-32 → bionic/calamares}/modules/removeuser.yml +2 -3
- package/conf/distros/bionic/calamares/modules/unpackfs.yml +6 -0
- package/conf/distros/buster/calamares/modules/bootloader.yml +2 -1
- package/conf/distros/buster/calamares/modules/mount.yml +2 -2
- package/conf/distros/focal/calamares/modules/after_bootloader_context.yml +10 -1
- package/conf/distros/focal/calamares/modules/before_bootloader_mkdirs_context.yml +4 -4
- package/conf/distros/focal/calamares/modules/mount.yml +2 -2
- package/conf/distros/focal/calamares/modules/shellprocess_bug-LP#1829805.yml +1 -1
- package/conf/distros/focal/calamares/modules/shellprocess_logs.yml +1 -1
- package/conf/distros/stretch/krill/krill-modules/bootloader-config/bootloader-config.sh +28 -0
- package/conf/distros/stretch/krill/krill-modules/bootloader-config/module.yml +8 -0
- package/conf/distros/stretch/krill/krill-modules/remove-link/module.yml +9 -0
- package/conf/distros/stretch/krill/krill-modules/remove-link/remove-link.sh +5 -0
- package/conf/distros/stretch/krill/krill-modules/sources-yolk/module.yml +8 -0
- package/conf/distros/stretch/krill/krill-modules/sources-yolk/sources-yolk.sh +75 -0
- package/conf/distros/stretch/krill/krill-modules/sources-yolk-unmount/module.yml +8 -0
- package/conf/distros/stretch/krill/modules/partitions.yml +8 -0
- package/conf/distros/stretch/krill/modules/removeuser.yml +15 -0
- package/conf/distros/{rolling/calamares-32 → stretch/krill}/settings.yml +50 -11
- package/conf/eggs.yaml +2 -9
- package/conf/exclude.list.custom +2 -2
- package/conf/exclude.list.template +9 -51
- package/conf/exclude.list.usr +43 -0
- package/dist/classes/distro.js +2 -2
- package/dist/classes/families/archlinux.js +5 -4
- package/dist/classes/incubation/branding.js +4 -3
- package/dist/classes/incubation/fisherman.js +15 -1
- package/dist/classes/incubation/installer.js +3 -1
- package/dist/classes/ovary.js +41 -17
- package/dist/classes/pacman.js +9 -5
- package/dist/classes/settings.js +2 -1
- package/dist/classes/utils.js +19 -4
- package/dist/classes/xdg.js +21 -8
- package/dist/commands/produce.js +26 -8
- package/dist/commands/status.js +2 -0
- package/dist/commands/wardrobe/get.js +1 -0
- package/dist/commands/wardrobe/list.js +1 -0
- package/dist/commands/wardrobe/show.js +1 -0
- package/dist/lib/dependencies.js +18 -18
- package/manpages/doc/man/eggs.1.gz +0 -0
- package/manpages/doc/man/eggs.html +10 -12
- package/mkinitcpio/biglinux/live.conf +74 -0
- package/mkinitcpio/biglinux/mkinitcpio.conf +73 -0
- package/package.json +23 -23
- package/scripts/_eggs +3 -2
- package/scripts/eggs.bash +1 -1
- package/conf/distros/rolling/calamares-32/modules/displaymanager.yml +0 -23
- package/conf/distros/rolling/calamares-32/modules/finished.yml +0 -6
- package/conf/distros/rolling/calamares-32/modules/fstab.yml +0 -14
- package/conf/distros/rolling/calamares-32/modules/locale.yml +0 -11
- package/conf/distros/rolling/calamares-32/modules/mount.yml +0 -39
- package/conf/distros/rolling/calamares-32/modules/packages.yml +0 -11
- package/conf/distros/rolling/calamares-32/modules/partition.yml +0 -283
- package/conf/distros/rolling/calamares-32/modules/shellprocess_removelink.yml +0 -8
- package/conf/distros/rolling/calamares-32/modules/unpackfs.yml +0 -7
- package/conf/distros/rolling/calamares-32/modules/users.yml +0 -20
package/README.md
CHANGED
|
@@ -15,7 +15,7 @@ penguins-eggs
|
|
|
15
15
|
# Index
|
|
16
16
|
<!-- toc -->
|
|
17
17
|
* [Index](#index)
|
|
18
|
-
* [
|
|
18
|
+
* [Introduction](#Introduction)
|
|
19
19
|
* [Technology](#technology)
|
|
20
20
|
* [Features](#features)
|
|
21
21
|
* [Packages](#packages)
|
|
@@ -25,183 +25,370 @@ penguins-eggs
|
|
|
25
25
|
* [That's all Folks!](#thats-all-folks)
|
|
26
26
|
<!-- tocstop -->
|
|
27
27
|
|
|
28
|
-
# Presentation
|
|
29
|
-
**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.
|
|
30
28
|
|
|
31
|
-
|
|
29
|
+
# Introduction
|
|
30
|
+
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 concept behind Penguins’ Eggs stems from the idea of “reproduction” and “population selection” applied to operating systems. During the era of popular remastering programs like Remastersys and Systemback, both of which experienced maintenance issues and were eventually abandoned, the need for a new, modern tool became evident. The inspiration for Penguins’ Eggs led to the development of a new tool written in a modern, cross-distribution language, utilizing its own packaging system. Initially built with node.js and later transitioning to Typescript as the primary development language, the tool’s design resembles an egg production process, consisting of operations such as “produce” for creating the eggs, “hatch” for installation, and other commands like “kill” for removing produced ISOs, “update” for software updates, and “install” for configuring the graphical installer. It also has prerequisites to install the .deb packages necessary for the process, namely, calamares.
|
|
32
31
|
|
|
33
|
-
|
|
32
|
+
> Considered a work-in-progress, the ultimate goal for Penguins’ Eggs is to implement a PXE server for local network distribution, drawing inspiration from the behavior of the cuckoo bird, which relies on others to hatch its eggs. Written primarily in TypeScript, Penguins’ Eggs is designed to be compatible with various Linux distributions, despite differences in package managers, file paths, and more. The tool currently supports Debian, Devuan, Ubuntu, Arch, Manjaro, and their derivatives, across multiple architectures including amd64, i386, and arm64. With the release of version 9.6.x, Penguins’ Eggs is now available as a Debian package, catering to a wide range of systems including PCs, older machines, and single-board ARM systems like the Raspberry Pi, across amd64, i386, and arm64 architectures. For more information and updates, visit the Penguins’ Eggs official website.
|
|
34
33
|
|
|
35
|
-
It is possible to have also unattended installation using **--unattended** flag.
|
|
36
34
|
|
|
37
|
-
|
|
35
|
+
> [!TIP]
|
|
36
|
+
> "Penguins-eggs" is an actively developed console tool designed to help you customize and distribute your system as live images on USB sticks or through PXE. By using this tool, you can remaster your system according to your preferences.
|
|
38
37
|
|
|
39
|
-
|
|
38
|
+
> [!TIP]
|
|
39
|
+
> By default, "penguins-eggs" completely removes the system's data and users. However, it also offers the option to remaster the system while including the data and accounts of existing users. This can be done using the "--clone" flag. Additionally, you can preserve the users and files by storing them in an encrypted LUKS file within the resulting ISO file, which can be achieved with the "--cryptedclone" flag.
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
> [!TIP]
|
|
42
|
+
> The resulting live system can be easily installed using either the Calamares installer or the internal TUI Krill installer. Furthermore, if you prefer an unattended installation, you can utilize the "--unattended" flag.
|
|
43
|
+
|
|
44
|
+
> [!TIP]
|
|
45
|
+
> One interesting feature of "penguins-eggs" is its integration with the "penguins-wardrobe." This allows you to create or utilize scripts to switch between different configurations. For example, you can start with a bare version of the system, featuring only a command-line interface (CLI), and then easily transition to a full graphical user interface (GUI) or server configurations.
|
|
46
|
+
|
|
47
|
+
> [!NOTE]
|
|
48
|
+
> For more information and customization options, you can explore "penguins-wardrobe," a related project. You can fork it and adapt it to meet your specific needs.
|
|
42
49
|
|
|
43
|
-
|
|
50
|
+
See [penguins-wardrobe](https://github.com/pieroproietti/penguins-wardrobe), fork it, and adapt it to your needs.
|
|
51
|
+
|
|
52
|
+
# Technology
|
|
53
|
+
"eggs" is primarily written in TypeScript and is designed to be compatible with various Linux distributions. While there may be differences in package managers, paths, and other aspects, the underlying programs used to build the live system are generally the same.
|
|
54
|
+
Currently, "eggs" supports several Linux distributions, including [Debian](https://www.debian.org/), [Devuan](https://www.devuan.org/), [Ubuntu](https://ubuntu.com/), [Arch](https://archlinux.org/), [Manjaro](https://manjaro.org/) and [derivatives](./conf/derivatives.yaml); and their derivatives. It also caters to different architectures, namely amd64, i386, and arm64.
|
|
55
|
+
Starting from version 9.6.x, "Penguins' eggs" is released as a Debian package, available for amd64, i386, and arm64 architectures. This allows it to support a wide range of PCs, including older machines, as well as single-board ARM systems like the Raspberry Pi. You can learn more about this release in the article titled Triple Somersault! [Triple somersault!](https://penguins-eggs.net/blog/triple-somersault).
|
|
56
|
+
For more information on the supported distributions and architectures, you can visit the blog [blog](https://penguins-eggs.net/blog/distros-that-can-be-remastered-with-eggs). Additionally, you can find examples of remastered ISO images created with "eggs" on the project's SourceForge page [sourceforge page of the project](https://sourceforge.net/projects/penguins-eggs/files/ISOS/).
|
|
44
57
|
|
|
45
|
-
Currently eggs supports: [Debian](https://www.debian.org/), [Devuan](https://www.devuan.org/), [Ubuntu](https://ubuntu.com/), [Arch](https://archlinux.org/), [Manjaro](https://manjaro.org/) and [derivatives](./conf/derivatives.yaml); regarding architectures eggs currently support amd64, i386 and arm64.
|
|
46
58
|
|
|
47
|
-
|
|
59
|
+
**penGUI take cure of eggs!**
|
|
48
60
|
|
|
49
|
-
|
|
61
|
+

|
|
50
62
|
|
|
63
|
+
The development of a GUI for "penguins-eggs" with the penGUI project sounds promising. It's exciting to see that work on the GUI has started and is progressing rapidly. GUIs can greatly enhance the user experience and make it more accessible to a wider range of users. I hope the penGUI [penGUI](https://github.com/pieroproietti/pengui) project continues to thrive and brings a user-friendly interface to "penguins-eggs". If you have any specific questions or need further information about the penGUI project, feel free to ask!
|
|
51
64
|
|
|
52
65
|
# Features
|
|
66
|
+
Penguins-eggs is a versatile tool that offers an array of features and benefits for Linux users. Whether you want to create an installable ISO from your current Linux system or explore various customization options, Penguins-eggs has got you covered. To get started with Penguins-eggs, you'll need to install it on your Linux distribution. The tool supports a wide range of Linux distributions and their major derivatives, including Arch, Debian, Devuan, Manjaro, Ubuntu, and more. Additionally, you can easily add support for additional derivatives, expanding the tool's capabilities even further.
|
|
67
|
+
|
|
68
|
+
1. fast and efficient
|
|
69
|
+
Penguins-eggs is designed to be fast and efficient. Unlike traditional methods that involve copying the entire file system, Penguins-eggs utilizes livefs, which allows for instant acquisition of the live system. By default, the tool.
|
|
70
|
+
|
|
71
|
+
2. Supports Compression Algorithm
|
|
72
|
+
Employs the zstd compression algorithm, significantly reducing the time required for the process, often up to 10 times faster. When creating an installable ISO.
|
|
73
|
+
|
|
74
|
+
3. Supports Clone
|
|
75
|
+
Penguins-eggs provides various options to suit your needs. With the --clone flag, you can preserve the data and accounts of unencrypted users, ensuring a seamless experience for users accessing the live system. Moreover, you can opt for a crypted clone, where user data and accounts are saved in an encrypted LUKS volume within the ISO image, enhancing security and privacy.
|
|
76
|
+
|
|
77
|
+
4. Cuckoo and PXE boot
|
|
78
|
+
In addition to ISO creation, Penguins-eggs offers a unique feature called Cuckoo. By starting Cuckoo from the live system, you can set up a PXE boot server, making it accessible to all computers on the network. This functionality opens up possibilities for network booting and streamlined deployment. Penguins Eggs Linux ushers in a new era of innovation and convenience with its groundbreaking default feature, Cuckoo live network boot, which transforms any computer running Penguins Eggs into a PXE (Preboot eXecution Environment) boot server. This revolutionary paradigm of network booting and seamless deployment underscores Penguins Eggs Linux’s commitment to redefining the parameters of accessibility and efficiency within the realm of Linux distributions.
|
|
79
|
+
|
|
80
|
+
5. Supports Both TUI/GUI Installer
|
|
81
|
+
To simplify the installation process, Penguins-eggs provides its own system installer called krill. This installer is particularly useful when a GUI (Graphical User Interface) is not available, allowing for installation in various situations. However, if you are using a desktop system, Penguins-eggs recommends and configures the calamares GUI installer, ensuring a seamless and user-friendly experience.
|
|
82
|
+
Penguins Eggs Linux spearheads a transformative revolution in the realm of system installation with the incorporation of its TUI (Text-based User Interface) / GUI (Graphical User Interface) installer, setting a new standard of versatility and accessibility within the landscape of Linux distributions.
|
|
83
|
+
|
|
84
|
+
6. repository lists
|
|
85
|
+
One of the key advantages of Penguins-eggs is its commitment to utilizing only the original distro's packages. This means that no modifications are made to your repository lists, ensuring a safe and reliable environment. Penguins-eggs prioritizes maintaining the integrity and authenticity of your Linux distribution.
|
|
86
|
+
|
|
87
|
+
7. Wardrobe
|
|
88
|
+
To enhance customization options, Penguins-eggs introduces the concept of Wardrobe. With Wardrobe and its various components, such as costumes, you can easily organize and manage your customizations, samples, and more. This feature enables a streamlined and efficient workflow, allowing you to tailor your Linux system to your preferences.
|
|
53
89
|
|
|
54
|
-
|
|
90
|
+
8. supporting multiple distributions
|
|
91
|
+
Eggs supporting multiple distributions and their derivatives
|
|
92
|
+
Supports: Arch, Debian, Devuan, Manjaro, Ubuntu,
|
|
93
|
+
and major derivatives: Linuxmint, KDE neon, EndeavourOS, Garuda, etc. You can easily add more derivatives.
|
|
55
94
|
|
|
56
|
-
|
|
95
|
+
10. supports hardware architectures
|
|
96
|
+
supports a wide range of hardware architectures.
|
|
97
|
+
Supports: i386, amd64 and arm64 architecture, from old PCs, and common PCs to single board computers like Raspberry Pi 4/5
|
|
57
98
|
|
|
58
|
-
|
|
99
|
+
11. Supports privacy and security
|
|
100
|
+
Safe: only use the original distro's packages, without any modification in your repository lists. Penguins Eggs Linux embarks on a steadfast commitment to user security and system integrity through its default practice of exclusively utilizing original distributions’ packages without any modifications in the repository lists. This resolute dedication to maintaining the pristine authenticity of packages reinforces Penguins Eggs’ fundamental ethos of safety and reliability, fostering an environment characterized by unwavering trust in the integrity of the software ecosystem.
|
|
59
101
|
|
|
60
|
-
|
|
102
|
+
## more features
|
|
103
|
+
[More feautures](https://github.com/pieroproietti/penguins-eggs/tree/master/changelog.d).
|
|
61
104
|
|
|
62
|
-
Consult [wardrobe users' guide](https://penguins-eggs.net/docs/Tutorial/wardrobe-users-guide).
|
|
63
105
|
|
|
64
|
-
##
|
|
65
|
-
|
|
106
|
+
## Wardrobe, Themes, and Addons
|
|
107
|
+
In April 2022, the "wardrobe" feature was introduced to "eggs." This addition serves as a comprehensive tool to assist and streamline the process of creating a customized version of Linux, starting from a command-line interface (CLI) system. I have embraced wardrobe for all my editions to enhance convenience, enabling me to better organize, consolidate, and manage my work effectively.
|
|
108
|
+
To add a unique touch to my customizations, I have assigned bird names to each edition. Except for the "naked" edition, there are various options available, including "Colibri," "eagle," "duck," "owl," and "chicks" under the bookworm and plastilinux distributions. [bookworm](https://sourceforge.net/projects/penguins-eggs/files/ISOS/debian/bookworm/) and [plastilinux](https://sourceforge.net/projects/penguins-eggs/files/ISOS/plastilinux/),.Furthermore, under Waydroid on the eggs' SourceForge page, you can find "wagtail" and "warbier."
|
|
109
|
+
I have high hopes that people will take an interest in wardrobe and consider forking the main repository to incorporate their own customizations. By collaborating, we can achieve significant progress that would be challenging for a single developer to accomplish. If you would like to delve deeper into the wardrobe, I recommend reading the Penguins' eggs blog [Penguins' eggs blog](https://penguins-eggs.net/blog/wardrobe-colibri-duck-eagle-and-owl/). post titled Wardrobe: Colibri, Duck, Eagle, and Owl, which provides further insights into its features and benefits.
|
|
110
|
+
Furthermore, addons, predominantly themes, have been organized under the vendor's folder in the penguin's wardrobe. I encourage utilizing your wardrobe for all your customization needs to maintain consistency and organization throughout your work.
|
|
66
111
|
|
|
67
|
-
|
|
112
|
+
> [!NOTE]
|
|
113
|
+
> For detailed instructions on using a wardrobe, please consult the wardrobe users' guide [wardrobe users' guide](https://penguins-eggs.net/docs/Tutorial/wardrobe-users-guide).
|
|
68
114
|
|
|
69
|
-
Completely removes user data from live, this is the preset mode
|
|
70
115
|
|
|
71
|
-
|
|
116
|
+
## Clone/Cryptedclone
|
|
117
|
+
When creating a live distribution of your system, you have different options to consider: the default mode, clone, and cryptedclone.
|
|
118
|
+
• The default mode, achieved by using the command "eggs produce," completely removes user data from the live distribution. This ensures that no private data remains in the live system.
|
|
119
|
+
|
|
120
|
+
• The "eggs produce --clone" command allows you to save both user data and system data directly in the generated ISO. This means that if someone obtains a copy of the ISO, they will be able to see and access the
|
|
121
|
+
user data directly from the live system. It's important to note that this data is not encrypted, so it may not be suitable for sensitive information.
|
|
122
|
+
|
|
123
|
+
• On the other hand, the "eggs produce --cryptedclone" command saves the data within the generated ISO using a LUKS (Linux Unified Key Setup) volume. With this option, the user data will not be visible in the live system. However, it can be automatically reinstalled during the system installation process using the "krill" installer. Even if someone has the generated ISO, they won't be able to access the user data without the LUKS passphrase. This ensures that your data remains protected.
|
|
72
124
|
|
|
73
|
-
|
|
125
|
+
To summarize the available options:
|
|
74
126
|
|
|
75
|
-
|
|
127
|
+
• "eggs produce" (default): All private data is removed from the live system.
|
|
76
128
|
|
|
77
|
-
|
|
129
|
+
• "eggs produce --clone": All user data is included unencrypted directly in the live system.
|
|
78
130
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
131
|
+
• "eggs produce --cryptedclone": All user data is included encrypted within a LUKS volume inside the ISO.
|
|
132
|
+
> [!TIP]
|
|
133
|
+
> During the installation process, you can use the "krill" installer to restore your crypted data automatically. By running the command "sudo eggs install" with the "krill" installer, your encrypted data will be securely transferred and made available in the installed system.
|
|
82
134
|
|
|
83
|
-
Using krill: ```sudo eggs install``` will automaticaly restore your CRYPTED data during the installation.
|
|
84
135
|
|
|
85
136
|
## calamares and krill
|
|
86
|
-
|
|
137
|
+
Calamares and Krill are powerful tools in the Eggs project [calamares](https://calamares.io), offering versatile installation options for Linux systems. The Eggs project was specifically designed to utilize Calamares as the default system installer, providing users with the flexibility to customize their installations using themes. However, Eggs goes beyond Calamares by introducing its own installer called Krill, which focuses on command-line interface (CLI) installations, particularly for server environments.
|
|
87
138
|
|
|
88
|
-
|
|
89
|
-
|
|
139
|
+
Krill, like Calamares, adopts a CLI interface that closely resembles Calamares, ensuring a consistent user experience. Leveraging the same configuration files created by Eggs for Calamares, Krill maintains compatibility and allows for seamless transitions between desktop and server installations. By simply adding the flag during installation, Krill enables unattended installations, streamlining the process for system administrators. Fine-tuning installation parameters becomes effortless as the configuration values can be modified in the ```/etc/penguins-eggs.d/krill.yaml``` file, facilitating automated deployments.
|
|
140
|
+
|
|
141
|
+
> [!TIP]
|
|
142
|
+
> Thanks to the Eggs project's integration of Calamares and the introduction of Krill, users can enjoy a comprehensive installation toolkit. Whether one prefers the graphical interface of Calamares or the command-line efficiency of Krill, Eggs caters to diverse installation needs, making Linux setup a breeze.
|
|
143
|
+
|
|
144
|
+
## cuckoo
|
|
145
|
+
ust like the cuckoo bird lays its eggs in the nests of other birds, the Eggs project introduces a similar concept in the form of a self-configuring PXE service. This service allows you to boot and install your ISO on networked computers that are not originally configured for your specific ISO.
|
|
146
|
+
With the command "cuckoo," you can deploy a newly created ISO on an already installed system, or you can live to boot the ISO itself. This means that you can either install your ISO on existing systems or directly run the ISO without the need for a permanent installation.
|
|
147
|
+
|
|
148
|
+
> [!TIP]
|
|
149
|
+
> By leveraging the cuckoo command, the Eggs project provides a convenient method for deploying and testing your ISO on a variety of networked computers, expanding the possibilities for system installations and evaluations.
|
|
90
150
|
|
|
91
151
|
## mom and dad
|
|
92
|
-
I
|
|
152
|
+
I have introduced two helpful built-in assistants: Mom and Dad. Mom, based on the easybashgui [easybashgui](https://github.com/BashGui/easybashgui) script, serves as a comprehensive guide, providing explanations of various commands and documentation. This ensures that users have access to clear instructions and information as they navigate through Eggs' functionalities.
|
|
153
|
+
On the other hand, Dad serves as a convenient shortcut for properly configuring Eggs. By simply typing ```sudo eggs dad``` and following the straightforward instructions, users can quickly configure Eggs to meet their specific requirements. For even faster configuration, utilizing the command ```sudo eggs dad -d``` allows for a complete reset of the configuration, loading default settings, and deleting any created ISOs.
|
|
154
|
+
Once Eggs is properly configured, generating your live environment becomes a breeze. Just type ```sudo produce``` to effortlessly generate your live ISO. With this streamlined workflow, Eggs empowers users to efficiently create customized live environments tailored to their needs. Whether you rely on Mom's guidance or Dad's configuration shortcuts, Eggs offers a user-friendly experience for ISO creation and customization.
|
|
93
155
|
|
|
94
156
|
## yolk
|
|
95
|
-
|
|
157
|
+
Yolk is a local repository that is bundled within the LiveCD of Eggs. This repository contains a carefully curated selection of essential packages required for installation. Yolk serves as a valuable resource, as it allows you to install your system confidently, even without an active internet connection.
|
|
158
|
+
By including Yolk in the LiveCD, Eggs ensures that all the necessary packages are readily available during the installation process. This eliminates the dependency on an internet connection, making it possible to install your system in offline environments or situations where internet access is limited or unavailable.
|
|
159
|
+
Yolk acts as a safety net, providing the minimum set of indispensable packages required for a successful installation. This guarantees a smooth and reliable installation experience, regardless of the availability of an internet connection. With Yolk by your side, you can confidently proceed with system installations, knowing that the essential packages are at your disposal.
|
|
96
160
|
|
|
97
161
|
# Packages
|
|
98
|
-
|
|
162
|
+
Eggs offers support for a variety of packages. Specifically, for Debian, Devuan, and Ubuntu, Eggs utilizes .deb packages that are compatible with both amd_64 and i386 architectures. This ensures seamless integration with these distributions, allowing users to easily install and utilize Eggs' features.
|
|
163
|
+
On the other hand, Arch and ManjaroLinux have their own packaging system known as PKGBUILDs. Eggs is designed to work harmoniously with these distributions, leveraging the specific packaging structure provided by PKGBUILDs. This ensures that Eggs can seamlessly integrate into Arch and ManjaroLinux environments, providing users with a consistent and optimized experience.
|
|
164
|
+
By adapting to the packaging systems used by different distributions, Eggs ensures compatibility and ease of use across a wide range of Linux environments. Whether you're using Debian, Devuan, Ubuntu, Arch, or ManjaroLinux, Eggs is equipped to support your preferred distribution, enabling you to make the most of its features and functionalities.
|
|
165
|
+
|
|
99
166
|
|
|
100
167
|
## Debian families
|
|
101
|
-
|
|
168
|
+
Eggs caters to the Debian family of distributions, offering a seamless installation experience through deb packages. These deb packages are available for multiple architectures, including amd64, i386, and arm64.The availability of Eggs as a deb package simplifies the installation process for users of Debian-based distributions. Whether you are running a 64-bit (amd64) or 32-bit (i386) architecture, or even an arm64 architecture, Eggs has you covered. This ensures that users across a wide range of Debian-based systems can easily download, install, and utilize Eggs' features.
|
|
169
|
+
By providing deb packages for various architectures, Eggs promotes accessibility and inclusivity, allowing users on different hardware platforms to benefit from its functionality. Whether you're using a traditional desktop computer or an ARM-based device, Eggs ensures compatibility and a consistent experience across the Debian family of distributions.
|
|
102
170
|
|
|
103
|
-
|
|
171
|
+
The packages can be installed on Debian, Devuan, or Ubuntu-based distributions without the need to worry about the specific version. Whether you're using Buster, Bullseye, Bookworm, Trixie, Chimaera, Daedalus, Bionic, Focal, or Jammy, Eggs is reported to work across these versions. However, it's important to ensure compatibility with the respective processor architecture.
|
|
172
|
+
The packages provided by Eggs include standard scripts for preinst, postinst, prerm, and postrm. These scripts play a crucial role in the installation and management of the packages. The preinst script is executed before the package is installed, allowing for any necessary preparations or configurations. The postinst script is executed after the package installation, enabling additional setup or customization. Similarly, the prerm script is executed before the package is removed, while the postrm script is executed after the package removal.
|
|
173
|
+
In addition to the scripts, Eggs packages also include man pages. These man pages serve as documentation for the installed packages, providing detailed information on their usage, configuration options, and other relevant details. The inclusion of man pages ensures that users have access to comprehensive documentation, enabling them to effectively utilize and manage the Eggs packages.
|
|
174
|
+
Overall, Eggs' packages offer a comprehensive and user-friendly experience, with standard scripts and detailed documentation, making installation and management hassle-free on Debian, Devuan, and Ubuntu-based distributions.
|
|
104
175
|
|
|
105
|
-
The packages includes standard scripts for preinst, postinst, prerm and postrm and man pages.
|
|
106
176
|
|
|
107
177
|
### Install eggs
|
|
108
|
-
|
|
178
|
+
there are multiple methods available, but one of the most practical approaches is to utilize the penguins-eggs-ppa repository.
|
|
179
|
+
The penguins-eggs-ppa repository provides a convenient and reliable way to access and install Eggs on your system. By adding this repository to your package manager's sources list, you gain access to the latest versions of Eggs and can easily install or update it with a few simple commands.Adding the penguins-eggs-ppa repository ensures that you have a trusted and official source for Eggs, which simplifies the installation process and ensures that you receive updates and security patches on time.By leveraging the penguins-eggs-ppa repository, you can enjoy the benefits of a streamlined installation process, convenient updates, and a reliable source for Eggs. It's a practical solution that allows you to effortlessly install and manage Eggs as a .deb package, enhancing your overall experience with this powerful software.
|
|
180
|
+
|
|
109
181
|
|
|
110
|
-
#### Download the package and install with dpkg
|
|
182
|
+
#### Download the package and install it with dpkg
|
|
111
183
|
|
|
112
|
-
|
|
184
|
+
To install Eggs, the simplest method is to download the package from the project's SourceForge page [package eggs](https://sourceforge.net/projects/penguins-eggs/files/DEBS/) and install it on your system. You can find the Eggs package on the SourceForge page here.
|
|
185
|
+
After downloading the appropriate package based on your system's architecture, you can proceed with the installation. If you are using an amd64 system, run the following command in the terminal:
|
|
186
|
+
```sudo dpkg -i eggs_9.6.24_amd64.deb```
|
|
187
|
+
For i386 systems, the command would be:
|
|
188
|
+
```sudo dpkg -i eggs_9.6.24_i386.deb```
|
|
189
|
+
Executing these commands will initiate the installation process and install Eggs on your system.
|
|
190
|
+
Once Eggs is successfully installed, you have the option to enhance its functionality by adding the penguins-eggs-ppa repository. This repository provides additional tools and features for Eggs. To add the penguins-eggs-ppa repository, run the following command in the terminal:
|
|
191
|
+
```sudo eggs tools ppa --install```
|
|
192
|
+
This command will add the penguins-eggs-ppa repository to your system, allowing you to access updated versions of Eggs and additional tools provided by the repository.
|
|
193
|
+
By following these steps, you can easily install Eggs, add the penguins-eggs-ppa repository, [penguins-eggs-ppa](https://pieroproietti.github.io/penguins-eggs-ppa), and unlock further capabilities and enhancements for your Eggs installation.
|
|
113
194
|
|
|
195
|
+
#### Using penguins-eggs-ppa (stable version)
|
|
196
|
+
To simplify the process of using the penguins-eggs-ppa repository and installing Eggs, you can utilize a utility called `get-eggs`. Follow these steps to use `get-eggs`:
|
|
197
|
+
1. Clone the `get-eggs` repository by running the following command:
|
|
114
198
|
```
|
|
115
|
-
|
|
199
|
+
git clone https://github.com/pieroproietti/get-eggs
|
|
116
200
|
```
|
|
117
201
|
|
|
118
|
-
|
|
202
|
+
2. Navigate into the `get-eggs` directory:
|
|
119
203
|
```
|
|
120
|
-
|
|
204
|
+
cd get-eggs
|
|
121
205
|
```
|
|
122
206
|
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
You can use a little utility I wrote: `get-eggs`. Use it in this way:
|
|
128
|
-
|
|
129
|
-
* `git clone https://github.com/pieroproietti/get-eggs`
|
|
130
|
-
* `cd get-eggs`
|
|
131
|
-
* `sudo ./get-eggs`
|
|
132
|
-
|
|
133
|
-
On Debian, Devuan and Ubuntu get-eggs will add the ppa and install eggs.
|
|
207
|
+
3. Execute the utility with root privileges:
|
|
208
|
+
```
|
|
209
|
+
sudo ./get-eggs
|
|
210
|
+
```
|
|
134
211
|
|
|
135
|
-
|
|
212
|
+
On Debian, Devuan, and Ubuntu, running `get-eggs` will add the penguins-eggs-ppa repository and install Eggs seamlessly.
|
|
213
|
+
> [!TIP]
|
|
214
|
+
> For derivatives of Debian, Devuan, and Ubuntu, such as Linuxmint, LMDE, etc., `get-eggs` will typically work as well. However, if needed, you can manually add the penguins-eggs-ppa repository by copying and pasting the following two lines into a terminal:
|
|
136
215
|
|
|
137
216
|
```
|
|
138
217
|
curl -fsSL https://pieroproietti.github.io/penguins-eggs-ppa/KEY.gpg | sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/penguins-eggs.gpg
|
|
139
218
|
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
|
|
140
219
|
```
|
|
141
220
|
|
|
142
|
-
|
|
221
|
+
After adding the repository, update your package repositories and install Eggs by running the following command:
|
|
143
222
|
|
|
144
223
|
```
|
|
145
224
|
sudo apt update && sudo apt install eggs
|
|
146
225
|
```
|
|
147
226
|
|
|
227
|
+
Executing these commands will update your package sources and install Eggs on your system.
|
|
228
|
+
|
|
229
|
+
> [!TIP]
|
|
230
|
+
> By using the `get-eggs` utility or manually adding the penguins-eggs-ppa repository, you can easily install Eggs on various Debian, Devuan, and Ubuntu-based distributions, including their derivatives, ensuring a smooth and hassle-free installation process.
|
|
231
|
+
|
|
232
|
+
|
|
148
233
|
### Upgrade eggs
|
|
149
|
-
|
|
234
|
+
To upgrade Eggs, the process will vary depending on whether you are using the penguins-eggs-ppa repository or not. Here's how you can upgrade Eggs with both approaches:
|
|
235
|
+
If you have already added the penguins-eggs-ppa repository, you can upgrade Eggs alongside other packages on your system by running the following command:
|
|
236
|
+
```
|
|
237
|
+
sudo apt upgrade
|
|
238
|
+
```
|
|
239
|
+
> [!TIP]
|
|
240
|
+
> This command will check for updates for all installed packages, including Eggs, and upgrade them to their latest versions if available.
|
|
241
|
+
|
|
242
|
+
> [!NOTE]
|
|
243
|
+
> On the other hand, if you have not added the penguins-eggs-ppa repository, you can manually upgrade Eggs by downloading the new version from the SourceForge page [here](https://sourceforge.net/projects/penguins-eggs/files/DEBS/). Once you have downloaded the appropriate package for your system architecture, follow these steps:
|
|
244
|
+
|
|
245
|
+
1. Install the package using the `gdebi` command (assuming you have `gdebi` installed):
|
|
246
|
+
```
|
|
247
|
+
sudo gdebi eggs_9.6.24_amd64.deb
|
|
248
|
+
```
|
|
249
|
+
or for i386 systems:
|
|
250
|
+
```
|
|
251
|
+
sudo dpkg -i eggs_9.6.24_i386.deb
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
2. In case of any missing dependencies, you can resolve them by running the following command:
|
|
255
|
+
```
|
|
256
|
+
sudo apt install -f
|
|
257
|
+
```
|
|
258
|
+
This will automatically install any required dependencies for Eggs.
|
|
259
|
+
> [!TIP]
|
|
260
|
+
> By following these instructions, you can upgrade Eggs either through the penguins-eggs-ppa repository or by manually downloading and installing the latest version from the SourceForge page. Ensure that you choose the appropriate method based on your current setup to keep Eggs up to date with the latest enhancements and bug fixes.
|
|
150
261
|
|
|
151
262
|
## Arch families
|
|
152
|
-
|
|
263
|
+
Eggs have been available in the Arch User Repository (AUR) for quite some time, thanks to the support of the Arch Linux community. Although I was initially unaware of its presence, I am now directly maintaining the AUR version of [penguins-eggs](https://aur.archlinux.org/packages/penguins-eggs). Additionally, I am actively participating in the Manjaro Community Repository, specifically for the [penguins-eggs](https://gitlab.manjaro.org/packages/community/penguins-eggs) package.
|
|
264
|
+
|
|
265
|
+
Being present in the AUR signifies that Eggs is available for Arch Linux users to easily install and manage through their package managers. The AUR is a community-driven repository that allows users to contribute and maintain packages that are not officially supported by Arch Linux. By maintaining the AUR version of penguins-eggs, I can ensure that Arch Linux users have access to the latest updates and improvements for Eggs.
|
|
266
|
+
|
|
267
|
+
> [!TIP]
|
|
268
|
+
> Furthermore, my participation in the Manjaro Community Repository demonstrates my commitment to providing support for Eggs on the Manjaro distribution. Manjaro is a popular Arch-based Linux distribution known for its user-friendly approach and community-driven development. By actively contributing to the Manjaro Community Repository, I can ensure that Eggs remains compatible and well-integrated with the Manjaro ecosystem.
|
|
269
|
+
|
|
270
|
+
> [!TIP]
|
|
271
|
+
> In summary, Eggs is available in the AUR and is directly maintained by me. Additionally, I am actively involved in the Manjaro Community Repository to provide support for Eggs on the Manjaro distribution. This ensures that users of Arch Linux and its derivatives, such as Manjaro, can easily access and benefit from using Eggs in their systems.
|
|
153
272
|
|
|
154
|
-
The development versions of penguins eggs and other PKGBUILDs are instead in my [eggs-pkgbuilds](https://github.com/pieroproietti/eggs-pkgbuilds) repository.
|
|
155
273
|
|
|
156
274
|
### Arch
|
|
157
|
-
|
|
275
|
+
To install penguins-eggs on Arch Linux, there are multiple methods available. One option is to install it directly from the Arch User Repository (AUR) by adding the Chaotic-AUR repository. Here's how you can do it:
|
|
158
276
|
|
|
159
|
-
|
|
277
|
+
1. Add the Chaotic-AUR repository to your system. You can find the repository at [https://aur.chaotic.cx/](https://aur.chaotic.cx/).
|
|
160
278
|
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
279
|
+
2. After adding the Chaotic-AUR repository, open a terminal and run the following command to install penguins-eggs using `pacman`:
|
|
280
|
+
```
|
|
281
|
+
sudo pacman -Sy penguins-eggs
|
|
282
|
+
```
|
|
283
|
+
This command will synchronize the package databases and install penguins-eggs on your system.
|
|
164
284
|
|
|
165
|
-
get-eggs
|
|
285
|
+
Alternatively, you can use a utility called `get-eggs` that I have written. Here's how to use it:
|
|
166
286
|
|
|
167
|
-
|
|
287
|
+
1. Clone the `get-eggs` repository by running the following command:
|
|
288
|
+
```
|
|
289
|
+
git clone https://github.com/pieroproietti/get-eggs
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
2. Change to the `get-eggs` directory:
|
|
293
|
+
```
|
|
294
|
+
cd get-eggs
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
3. Run the `get-eggs` script with sudo privileges:
|
|
298
|
+
```
|
|
299
|
+
sudo ./get-eggs
|
|
300
|
+
```
|
|
301
|
+
This script will add the AUR repository and install penguins-eggs on your system.
|
|
302
|
+
|
|
303
|
+
Additionally, you have the option to use the popular AUR helper tool called `yay`. Simply run the following command:
|
|
304
|
+
```
|
|
305
|
+
yay penguins-eggs
|
|
306
|
+
```
|
|
307
|
+
`yay` will handle the installation process for you, including any necessary dependencies.
|
|
308
|
+
|
|
309
|
+
If you prefer to build from source, you can download the sources from the AUR repository. Here are the steps:
|
|
168
310
|
|
|
311
|
+
1. Clone the `penguins-eggs` repository from the AUR:
|
|
169
312
|
```
|
|
170
313
|
git clone https://aur.archlinux.org/packages/penguins-eggs
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
2. Change to the `penguins-eggs` directory:
|
|
317
|
+
```
|
|
171
318
|
cd penguins-eggs
|
|
319
|
+
```
|
|
320
|
+
|
|
321
|
+
3. Build and install the package using `makepkg`:
|
|
322
|
+
```
|
|
172
323
|
makepkg -srcCi
|
|
173
324
|
```
|
|
325
|
+
> [!TIP]
|
|
326
|
+
> This command will compile the source code, create a package, and install it on your system.
|
|
327
|
+
These methods provide various ways to install penguins-eggs on Arch Linux, allowing you to choose the one that suits your preferences and workflow.
|
|
328
|
+
|
|
329
|
+
|
|
174
330
|
### Manjaro
|
|
175
|
-
|
|
331
|
+
Starting from version 9.4.3, penguins-eggs is now included in the Manjaro community repository, making it even easier to install on Manjaro Linux. To install penguins-eggs on Manjaro, you can use the `pamac` package manager with the following command:
|
|
332
|
+
```
|
|
333
|
+
pamac install penguins-eggs
|
|
334
|
+
```
|
|
335
|
+
This command will fetch the package from the Manjaro community repository and install it on your system.
|
|
336
|
+
|
|
337
|
+
Alternatively, if you prefer to manually manage the installation process, you can clone the penguins-eggs package from the Manjaro community repository and build it from source. Here are the steps:
|
|
176
338
|
|
|
177
|
-
|
|
339
|
+
1. Clone the penguins-eggs package from the Manjaro community repository:
|
|
178
340
|
```
|
|
179
341
|
git clone https://gitlab.manjaro.org/packages/community/penguins-eggs/
|
|
180
|
-
cd penguins-eggs
|
|
181
|
-
makepkg -srcCi
|
|
182
342
|
```
|
|
183
343
|
|
|
184
|
-
|
|
344
|
+
2. Change to the penguins-eggs directory:
|
|
345
|
+
```
|
|
346
|
+
cd penguins-eggs
|
|
347
|
+
```
|
|
185
348
|
|
|
186
|
-
|
|
349
|
+
3. Build and install the package using `makepkg`:
|
|
350
|
+
```
|
|
351
|
+
makepkg -srcCi
|
|
352
|
+
```
|
|
353
|
+
> [!TIP]
|
|
354
|
+
> This command will compile the source code, create a package, and install it on your system.
|
|
187
355
|
|
|
188
|
-
|
|
356
|
+
By including penguins-eggs in the Manjaro community repository, Manjaro Linux users can easily access and install the package using their preferred package manager. The Manjaro community repository is specifically dedicated to packages that are supported by the Manjaro community, ensuring that penguins-eggs is well-integrated and compatible with the Manjaro distribution.
|
|
189
357
|
|
|
190
|
-
|
|
358
|
+
> [!TIP]
|
|
359
|
+
> Whether you choose to install penguins-eggs using `pamac` or by manually building it from source, you can enjoy the benefits of this package on your Manjaro Linux system.
|
|
191
360
|
|
|
192
|
-
```sudo eggs produce ```
|
|
193
361
|
|
|
194
|
-
|
|
362
|
+
# Usage
|
|
363
|
+
Once the package has been installed, you can have the new ```eggs``` command. Typing ```eggs``` will get the list of commands, and 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.
|
|
195
364
|
|
|
196
|
-
|
|
365
|
+
## Examples
|
|
366
|
+
Here are some examples of how to use penguins-eggs to create live systems with different configurations:
|
|
197
367
|
|
|
198
|
-
|
|
368
|
+
1. To create a live system without user data, run the following command with `sudo`:
|
|
369
|
+
```
|
|
370
|
+
sudo eggs produce
|
|
371
|
+
```
|
|
372
|
+
This command will generate a live system without any user data included.
|
|
199
373
|
|
|
200
|
-
|
|
374
|
+
2. To create a live system with user data that is not encrypted, use the `--clone` flag:
|
|
375
|
+
```
|
|
376
|
+
sudo eggs produce --clone
|
|
377
|
+
```
|
|
378
|
+
This command will produce a live system that includes user data without encryption.
|
|
201
379
|
|
|
202
|
-
|
|
380
|
+
3. If you want to create a live system with encrypted user data, use the `--cryptedclone` flag:
|
|
381
|
+
```
|
|
382
|
+
sudo eggs produce --cryptedclone
|
|
383
|
+
```
|
|
384
|
+
This command will generate a live system with encrypted user data.
|
|
203
385
|
|
|
204
|
-
|
|
386
|
+
By default, penguins-eggs uses fast compression for efficiency during the creation process. However, if you want a more compressed ISO file, you can use the `--max` flag during the final compression step. For example:
|
|
387
|
+
```
|
|
388
|
+
sudo eggs produce --max
|
|
389
|
+
```
|
|
390
|
+
> [!TIP]
|
|
391
|
+
> This command will apply maximum compression to the ISO file, resulting in a smaller file size. In addition to the command descriptions provided in this README, you can refer to the [Penguins' eggs official guide](https://penguins-eggs.net/docs/Tutorial/eggs-users-guide) for more detailed information on how to use penguins-eggs and its various features. The official guide offers comprehensive documentation to help you make the most out of this tool.
|
|
205
392
|
|
|
206
393
|
# Commands
|
|
207
394
|
<!-- commands -->
|
|
@@ -235,8 +422,8 @@ In addition to the description of the commands in this README, you can consult t
|
|
|
235
422
|
* [`eggs wardrobe wear [COSTUME]`](#eggs-wardrobe-wear-costume)
|
|
236
423
|
|
|
237
424
|
## `eggs adapt`
|
|
238
|
-
|
|
239
|
-
|
|
425
|
+
The `eggs adapt` command is used to adjust the monitor resolution specifically for virtual machines (VMs). It provides a convenient way to optimize the display settings within a VM environment.
|
|
426
|
+
Here is the usage information for the `eggs adapt` command:
|
|
240
427
|
|
|
241
428
|
```
|
|
242
429
|
USAGE
|
|
@@ -248,16 +435,27 @@ FLAGS
|
|
|
248
435
|
|
|
249
436
|
DESCRIPTION
|
|
250
437
|
adapt monitor resolution for VM only
|
|
438
|
+
```
|
|
251
439
|
|
|
252
|
-
|
|
253
|
-
|
|
440
|
+
To use the command, you simply need to run `eggs adapt` in the terminal. There are also two optional flags you can include:
|
|
441
|
+
|
|
442
|
+
- `-h` or `--help`: This flag displays the help information for the `eggs adapt` command, providing a brief description of its usage and available flags.
|
|
443
|
+
- `-v` or `--verbose`: Including this flag enables verbose mode, which provides more detailed output during the resolution adaptation process.
|
|
444
|
+
|
|
445
|
+
> [!NOTE]
|
|
446
|
+
> Here is an example of how to use the `eggs adapt` command:
|
|
447
|
+
|
|
448
|
+
```
|
|
449
|
+
$ eggs adapt
|
|
254
450
|
```
|
|
451
|
+
> [!TIP]
|
|
452
|
+
> By running this command, the monitor resolution will be adjusted specifically for the virtual machine environment. The `eggs adapt` command is particularly useful when working with VMs, as it allows you to optimize the display settings to match your specific requirements. Whether you need to adjust the resolution for better readability or to ensure compatibility with certain applications, the `eggs adapt` command provides a straightforward way to achieve the desired monitor configuration within your VM.
|
|
255
453
|
|
|
256
454
|
_See code: [src/commands/adapt.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/adapt.ts)
|
|
257
455
|
|
|
258
|
-
## `eggs analyze`
|
|
259
456
|
|
|
260
|
-
|
|
457
|
+
## `eggs analyze`
|
|
458
|
+
The `eggs analyze` command is used to perform an analysis specifically for the syncto feature. It provides a way to examine and gather information related to the syncto functionality in the penguins-eggs tool. Here is the usage information for the `eggs analyze` command:
|
|
261
459
|
|
|
262
460
|
```
|
|
263
461
|
USAGE
|
|
@@ -269,16 +467,29 @@ FLAGS
|
|
|
269
467
|
|
|
270
468
|
DESCRIPTION
|
|
271
469
|
analyze for syncto
|
|
470
|
+
```
|
|
471
|
+
To use the command, you can simply run `eggs analyze` in the terminal. There are also two optional flags you can include:
|
|
472
|
+
|
|
473
|
+
- `-h` or `--help`: This flag displays the help information for the `eggs analyze` command, providing a brief description of its usage and available flags.
|
|
474
|
+
- `-v` or `--verbose`: Including this flag enables verbose mode, which provides more detailed output during the analysis process.
|
|
475
|
+
|
|
476
|
+
Here is an example of how to use the `eggs analyze` command:
|
|
272
477
|
|
|
273
|
-
EXAMPLES
|
|
274
|
-
sudo eggs analyze
|
|
275
478
|
```
|
|
479
|
+
sudo eggs analyze
|
|
480
|
+
```
|
|
481
|
+
|
|
482
|
+
By running this command with `sudo`, you initiate the analysis process specifically for the syncto feature. The `eggs analyze` command is a powerful tool for examining and gathering information related to syncto in penguins-eggs. It allows you to gain insights into the synchronization mechanism and analyze its behavior within your system. The analysis can help identify potential issues, optimize performance, and ensure the smooth operation of the syncto feature.
|
|
483
|
+
|
|
484
|
+
> [!TIP]
|
|
485
|
+
> To explore the code implementation of the `eggs analyze` command, you can refer to the [src/commands/analyze.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/analyze.ts) file in the penguins-eggs GitHub repository. This file contains the source code responsible for the `eggs analyze` functionality, providing a deeper understanding of how the command is implemented and executed.
|
|
276
486
|
|
|
277
|
-
_See code: [src/commands/analyze.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/analyze.ts)_
|
|
278
487
|
|
|
279
488
|
## `eggs autocomplete [SHELL]`
|
|
489
|
+
The `eggs autocomplete` command is used to display installation instructions for setting up autocomplete functionality with the penguins-eggs tool in your preferred shell. Autocomplete allows you to conveniently auto-fill commands and options as you type, enhancing your productivity and reducing errors.
|
|
280
490
|
|
|
281
|
-
|
|
491
|
+
> [!TIP]
|
|
492
|
+
> Here is the usage information for the `eggs autocomplete` command:
|
|
282
493
|
|
|
283
494
|
```
|
|
284
495
|
USAGE
|
|
@@ -292,22 +503,40 @@ FLAGS
|
|
|
292
503
|
|
|
293
504
|
DESCRIPTION
|
|
294
505
|
display autocomplete installation instructions
|
|
506
|
+
```
|
|
295
507
|
|
|
296
|
-
|
|
297
|
-
|
|
508
|
+
To use the command, you can run `eggs autocomplete` in the terminal. There is also an optional `SHELL` argument that you can provide to specify your shell type. The available shell options include bash and zsh. If no shell is specified, general autocomplete installation instructions will be displayed.
|
|
509
|
+
> [!TIP]
|
|
510
|
+
> Additionally, there is an optional `-r` or `--refresh-cache` flag. When included, this flag refreshes the cache and ignores displaying the installation instructions.
|
|
298
511
|
|
|
299
|
-
|
|
512
|
+
Here are some examples of how to use the `eggs autocomplete` command:
|
|
300
513
|
|
|
301
|
-
|
|
514
|
+
```
|
|
515
|
+
$ eggs autocomplete
|
|
516
|
+
```
|
|
517
|
+
This command displays general installation instructions for autocomplete functionality.
|
|
302
518
|
|
|
303
|
-
$ eggs autocomplete --refresh-cache
|
|
304
519
|
```
|
|
520
|
+
$ eggs autocomplete bash
|
|
521
|
+
```
|
|
522
|
+
This command provides installation instructions specifically for the bash shell.
|
|
305
523
|
|
|
306
|
-
|
|
524
|
+
```
|
|
525
|
+
$ eggs autocomplete zsh
|
|
526
|
+
```
|
|
527
|
+
This command provides installation instructions specifically for the zsh shell.
|
|
307
528
|
|
|
529
|
+
```
|
|
530
|
+
$ eggs autocomplete --refresh-cache
|
|
531
|
+
```
|
|
532
|
+
This command refreshes the cache for autocomplete, without displaying any installation instructions.
|
|
533
|
+
> [!TIP]
|
|
534
|
+
> To explore the code implementation of the `eggs autocomplete` command, you can refer to the [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.3.8/src/commands/autocomplete/index.ts) repository. This repository contains the source code responsible for the autocomplete functionality, providing a deeper understanding of its implementation and how it integrates with the penguins-eggs tool.
|
|
535
|
+
|
|
308
536
|
## `eggs calamares`
|
|
537
|
+
The `eggs calamares` command is used to configure, install, or remove the Calamares tool. Calamares is a powerful installation framework that simplifies the process of setting up operating systems on various platforms. With the `eggs calamares` command, you can easily manage Calamares and its associated tasks.
|
|
309
538
|
|
|
310
|
-
|
|
539
|
+
Here is the usage information for the `eggs calamares` command:
|
|
311
540
|
|
|
312
541
|
```
|
|
313
542
|
USAGE
|
|
@@ -325,22 +554,50 @@ FLAGS
|
|
|
325
554
|
|
|
326
555
|
DESCRIPTION
|
|
327
556
|
configure calamares or install or configure it
|
|
557
|
+
```
|
|
558
|
+
> [!NOTE]
|
|
559
|
+
> To use the command, you can run `eggs calamares` in the terminal. The command supports several flags and options:
|
|
328
560
|
|
|
329
|
-
|
|
330
|
-
|
|
561
|
+
- `-h` or `--help`: This flag displays the help information for the `eggs calamares` command, providing a brief description of its usage and available flags.
|
|
562
|
+
- `-i` or `--install`: Including this flag installs Calamares and its dependencies on your system.
|
|
563
|
+
- `-n` or `--nointeractive`: This flag enables non-interactive mode, where no user interaction is required during the Calamares configuration process.
|
|
564
|
+
- `-p` or `--policies`: Including this flag allows you to configure Calamares policies.
|
|
565
|
+
- `-r` or `--release`: This flag triggers the removal of Calamares and all its dependencies after the installation.
|
|
566
|
+
- `-v` or `--verbose`: Enabling this flag provides more detailed output.
|
|
331
567
|
|
|
332
|
-
|
|
568
|
+
There are two additional flags related to removing Calamares:
|
|
569
|
+
- `--remove`: Including this flag removes Calamares and its dependencies from your system.
|
|
570
|
+
- `--theme=<value>`: This option allows you to specify a theme or branding for both the `eggs` tool and Calamares.
|
|
333
571
|
|
|
334
|
-
|
|
572
|
+
Here are some examples of how to use the `eggs calamares` command:
|
|
573
|
+
|
|
574
|
+
```
|
|
575
|
+
sudo eggs calamares
|
|
576
|
+
```
|
|
577
|
+
This command configures Calamares without installing or removing it.
|
|
578
|
+
|
|
579
|
+
```
|
|
580
|
+
sudo eggs calamares --install
|
|
581
|
+
```
|
|
582
|
+
This command installs Calamares and its dependencies on your system.
|
|
583
|
+
|
|
584
|
+
```
|
|
585
|
+
sudo eggs calamares --install --theme=/path/to/theme
|
|
586
|
+
```
|
|
587
|
+
This command installs Calamares and applies a specific theme or branding to both the `eggs` tool and Calamares.
|
|
335
588
|
|
|
336
|
-
sudo eggs calamares --remove
|
|
337
589
|
```
|
|
590
|
+
sudo eggs calamares --remove
|
|
591
|
+
```
|
|
592
|
+
This command removes Calamares and its dependencies from your system.
|
|
338
593
|
|
|
339
|
-
|
|
594
|
+
> [!TIP]
|
|
595
|
+
> To explore the code implementation of the `eggs calamares` command, you can refer to the [src/commands/calamares.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/calamares.ts) file in the penguins-eggs GitHub repository. This file contains the source code responsible for the `eggs calamares` functionality, providing a deeper understanding of how the command is implemented and executed.
|
|
340
596
|
|
|
341
597
|
## `eggs config`
|
|
598
|
+
The `eggs config` command is used to configure and install the necessary Debian packages required to run the `eggs` tool. The `eggs` tool is a versatile utility that helps manage various tasks related to system configuration and administration. By running the `eggs config` command, you can easily set up the prerequisites and dependencies needed for the smooth execution of the `eggs` tool.
|
|
342
599
|
|
|
343
|
-
|
|
600
|
+
Here is the usage information for the `eggs config` command:
|
|
344
601
|
|
|
345
602
|
```
|
|
346
603
|
USAGE
|
|
@@ -354,20 +611,41 @@ FLAGS
|
|
|
354
611
|
|
|
355
612
|
DESCRIPTION
|
|
356
613
|
Configure and install prerequisites deb packages to run it
|
|
614
|
+
```
|
|
615
|
+
> [!NOTE]
|
|
616
|
+
> To use the command, you can run `eggs config` in the terminal. The command supports several flags and options:
|
|
357
617
|
|
|
358
|
-
|
|
359
|
-
|
|
618
|
+
- `-c` or `--clean`: Including this flag will remove the old configuration before creating a new one. This allows for a fresh setup of the `eggs` tool.
|
|
619
|
+
- `-h` or `--help`: This flag displays the help information for the `eggs config` command, providing a brief description of its usage and available flags.
|
|
620
|
+
- `-n` or `--nointeractive`: This flag enables non-interactive mode, where no user interaction is required during the configuration process.
|
|
621
|
+
- `-N` or `--noicons`: Including this flag disables the display of icons during the configuration process.
|
|
622
|
+
|
|
623
|
+
The `eggs config` command is primarily responsible for configuring and installing the required Debian packages needed to run the `eggs` tool. It ensures that the necessary dependencies are in place, allowing for seamless execution of subsequent `eggs` commands.
|
|
624
|
+
|
|
625
|
+
Here are some examples of how to use the `eggs config` command:
|
|
360
626
|
|
|
361
|
-
|
|
627
|
+
```
|
|
628
|
+
sudo eggs config
|
|
629
|
+
```
|
|
630
|
+
This command configures and installs the prerequisite Debian packages without removing any old configuration.
|
|
631
|
+
|
|
632
|
+
```
|
|
633
|
+
sudo eggs config --clean
|
|
634
|
+
```
|
|
635
|
+
This command removes the old configuration before creating a new one, ensuring a fresh setup of the `eggs` tool.
|
|
362
636
|
|
|
363
|
-
sudo eggs config --clean --nointeractive
|
|
364
637
|
```
|
|
638
|
+
sudo eggs config --clean --nointeractive
|
|
639
|
+
```
|
|
640
|
+
This command removes the old configuration and performs a fresh setup without requiring any user interaction.
|
|
641
|
+
> [!TIP]
|
|
642
|
+
> To explore the code implementation of the `eggs config` command, you can refer to the [src/commands/config.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/config.ts) file in the penguins-eggs GitHub repository. This file contains the source code responsible for the `eggs config` functionality, providing a deeper understanding of how the command is implemented and executed.
|
|
365
643
|
|
|
366
|
-
_See code: [src/commands/config.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/config.ts)_
|
|
367
644
|
|
|
368
645
|
## `eggs cuckoo`
|
|
646
|
+
The `eggs cuckoo` command is used to initiate a PXE start with proxy-dhcp using the `eggs` tool. PXE (Preboot Execution Environment) is a technology that allows computers to boot and install an operating system over a network connection. The `eggs` tool leverages this functionality to facilitate the PXE start process with the help of a proxy-dhcp server.
|
|
369
647
|
|
|
370
|
-
|
|
648
|
+
Here is the usage information for the `eggs cuckoo` command:
|
|
371
649
|
|
|
372
650
|
```
|
|
373
651
|
USAGE
|
|
@@ -378,16 +656,29 @@ FLAGS
|
|
|
378
656
|
|
|
379
657
|
DESCRIPTION
|
|
380
658
|
PXE start with proxy-dhcp
|
|
659
|
+
```
|
|
381
660
|
|
|
382
|
-
|
|
383
|
-
|
|
661
|
+
> [!NOTE]
|
|
662
|
+
> To use the command, you can run `eggs cuckoo` in the terminal. The command supports a single flag:
|
|
663
|
+
|
|
664
|
+
- `-h` or `--help`: This flag displays the help information for the `eggs cuckoo` command, providing a brief description of its usage.
|
|
665
|
+
|
|
666
|
+
The primary purpose of the `eggs cuckoo` command is to initiate a PXE start process with the assistance of a proxy-dhcp server. This allows the system to boot and install an operating system using network resources. By running this command, you can initiate the PXE start process seamlessly with the necessary configurations in place.
|
|
667
|
+
|
|
668
|
+
Here is an example of how to use the `eggs cuckoo` command:
|
|
669
|
+
|
|
670
|
+
```
|
|
671
|
+
sudo eggs cuckoo
|
|
384
672
|
```
|
|
385
673
|
|
|
386
|
-
|
|
674
|
+
This command initiates the PXE start process with proxy-dhcp by leveraging the `eggs` tool. It ensures that the necessary configurations are in place to facilitate the booting and installation of an operating system over the network.
|
|
675
|
+
> [!TIP]
|
|
676
|
+
> To explore the code implementation of the `eggs cuckoo` command, you can refer to the [src/commands/cuckoo.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/cuckoo.ts) file in the penguins-eggs GitHub repository. This file contains the source code responsible for the `eggs cuckoo` functionality, providing a deeper understanding of how the command is implemented and executed.
|
|
387
677
|
|
|
388
678
|
## `eggs dad`
|
|
679
|
+
The `eggs dad` command is used to seek assistance from a "daddy" figure, acting as a TUI (Text User Interface) configuration helper within the `eggs` tool. This command allows users to get guidance and support for configuring their system settings and options. By running the `eggs dad` command, users can interact with the TUI configuration helper to receive help and make necessary changes.
|
|
389
680
|
|
|
390
|
-
|
|
681
|
+
Here is the usage information for the `eggs dad` command:
|
|
391
682
|
|
|
392
683
|
```
|
|
393
684
|
USAGE
|
|
@@ -401,20 +692,40 @@ FLAGS
|
|
|
401
692
|
|
|
402
693
|
DESCRIPTION
|
|
403
694
|
ask help from daddy - TUI configuration helper
|
|
695
|
+
```
|
|
696
|
+
> [!NOTE]
|
|
697
|
+
> To use the command, you can run `eggs dad` in the terminal. The command supports several flags and options:
|
|
404
698
|
|
|
405
|
-
|
|
406
|
-
|
|
699
|
+
- `-c` or `--clean`: Including this flag will remove the old configuration before creating a new one. This allows for a fresh setup of the configuration settings.
|
|
700
|
+
- `-d` or `--default`: Including this flag will remove the old configuration and enforce the default settings. This can be useful when reverting back to the default configuration.
|
|
701
|
+
- `-h` or `--help`: This flag displays the help information for the `eggs dad` command, providing a brief description of its usage and available flags.
|
|
702
|
+
- `-v` or `--verbose`: Including this flag enables verbose mode, providing more detailed information during the configuration process.
|
|
703
|
+
|
|
704
|
+
The `eggs dad` command acts as a TUI configuration helper, allowing users to seek assistance from the "daddy" figure. It provides guidance and support for configuring system settings, ensuring a smooth and user-friendly experience.
|
|
407
705
|
|
|
408
|
-
|
|
706
|
+
Here are some examples of how to use the `eggs dad` command:
|
|
409
707
|
|
|
410
|
-
sudo dad --default
|
|
411
708
|
```
|
|
709
|
+
sudo eggs dad
|
|
710
|
+
```
|
|
711
|
+
This command initiates the TUI configuration helper, allowing users to seek help and guidance for configuring system settings.
|
|
712
|
+
|
|
713
|
+
```
|
|
714
|
+
sudo eggs dad --clean
|
|
715
|
+
```
|
|
716
|
+
This command removes the old configuration before creating a new one, ensuring a fresh setup of the configuration settings.
|
|
412
717
|
|
|
413
|
-
|
|
718
|
+
```
|
|
719
|
+
sudo eggs dad --default
|
|
720
|
+
```
|
|
721
|
+
This command removes the old configuration and enforces the default settings, reverting back to the default configuration.
|
|
722
|
+
> [!TIP]
|
|
723
|
+
> To explore the code implementation of the `eggs dad` command, you can refer to the [src/commands/dad.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/dad.ts) file in the penguins-eggs GitHub repository. This file contains the source code responsible for the `eggs dad` functionality, providing a deeper understanding of how the command is implemented and executed.
|
|
414
724
|
|
|
415
725
|
## `eggs export deb`
|
|
726
|
+
The `eggs export deb` command is used to export Debian packages (`deb`), documentation files (`docs`), or ISO images to a specified destination host using the `eggs` tool. This command enables users to transfer these files from one system to another conveniently. By running the `eggs export deb` command, users can export the desired files to the destination host.
|
|
416
727
|
|
|
417
|
-
|
|
728
|
+
Here is the usage information for the `eggs export deb` command:
|
|
418
729
|
|
|
419
730
|
```
|
|
420
731
|
USAGE
|
|
@@ -428,20 +739,39 @@ FLAGS
|
|
|
428
739
|
|
|
429
740
|
DESCRIPTION
|
|
430
741
|
export deb/docs/iso to the destination host
|
|
742
|
+
```
|
|
743
|
+
> [!NOTE]
|
|
744
|
+
> To use the command, you can run `eggs export deb` in the terminal. The command supports several flags and options:
|
|
431
745
|
|
|
432
|
-
|
|
433
|
-
|
|
746
|
+
- `-a` or `--all`: Including this flag will export all available architectures. This allows for exporting files for multiple architectures simultaneously.
|
|
747
|
+
- `-c` or `--clean`: Including this flag will remove the old `.deb` files before copying the new ones. This ensures a clean transfer of files to the destination host.
|
|
748
|
+
- `-h` or `--help`: This flag displays the help information for the `eggs export deb` command, providing a brief description of its usage and available flags.
|
|
749
|
+
- `-v` or `--verbose`: Including this flag enables verbose mode, providing more detailed information during the export process.
|
|
750
|
+
|
|
751
|
+
The `eggs export deb` command facilitates the export of Debian packages, documentation files, or ISO images to the destination host. This allows users to transfer these files conveniently and efficiently.
|
|
752
|
+
Here are some examples of how to use the `eggs export deb` command:
|
|
434
753
|
|
|
435
|
-
|
|
754
|
+
```
|
|
755
|
+
eggs export deb
|
|
756
|
+
```
|
|
757
|
+
This command exports the specified Debian packages, documentation files, or ISO images to the destination host.
|
|
436
758
|
|
|
437
|
-
$ eggs export deb --all
|
|
438
759
|
```
|
|
760
|
+
eggs export deb --clean
|
|
761
|
+
```
|
|
762
|
+
This command removes the old `.deb` files before copying the new ones, ensuring a clean transfer of files to the destination host.
|
|
439
763
|
|
|
440
|
-
|
|
764
|
+
```
|
|
765
|
+
eggs export deb --all
|
|
766
|
+
```
|
|
767
|
+
This command exports the files for all available architectures, facilitating the transfer of files for multiple architectures simultaneously.
|
|
768
|
+
> [!TIP]
|
|
769
|
+
> To explore the code implementation of the `eggs export deb` command, you can refer to the [src/commands/export/deb.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/export/deb.ts) file in the penguins-eggs GitHub repository. This file contains the source code responsible for the `eggs export deb` functionality, providing a deeper understanding of how the command is implemented and executed.
|
|
441
770
|
|
|
442
771
|
## `eggs export iso`
|
|
772
|
+
The `eggs export iso` command is used to export ISO images to a specified destination host using the `eggs` tool. This command allows users to transfer ISO images from one system to another conveniently. By running the `eggs export iso` command, users can export the desired ISO image to the destination host.
|
|
443
773
|
|
|
444
|
-
|
|
774
|
+
Here is the usage information for the `eggs export iso` command:
|
|
445
775
|
|
|
446
776
|
```
|
|
447
777
|
USAGE
|
|
@@ -455,18 +785,36 @@ FLAGS
|
|
|
455
785
|
|
|
456
786
|
DESCRIPTION
|
|
457
787
|
export iso in the destination host
|
|
788
|
+
```
|
|
789
|
+
> [!NOTE]
|
|
790
|
+
> To use the command, you can run `eggs export iso` in the terminal. The command supports several flags and options:
|
|
458
791
|
|
|
459
|
-
|
|
460
|
-
|
|
792
|
+
- `-c` or `--clean`: Including this flag will delete the old ISO images before copying the new ones. This ensures a clean transfer of ISO images to the destination host.
|
|
793
|
+
- `-C` or `--checksum`: Including this flag will export the checksums (md5 and sha256) for the ISO images. This provides additional verification for the integrity of the transferred ISO images.
|
|
794
|
+
- `-h` or `--help`: This flag displays the help information for the `eggs export iso` command, providing a brief description of its usage and available flags.
|
|
795
|
+
- `-v` or `--verbose`: Including this flag enables verbose mode, providing more detailed information during the export process.
|
|
796
|
+
|
|
797
|
+
The `eggs export iso` command facilitates the export of ISO images to the destination host. This allows users to conveniently transfer ISO images from one system to another.
|
|
461
798
|
|
|
462
|
-
|
|
799
|
+
Here are some examples of how to use the `eggs export iso` command:
|
|
800
|
+
|
|
801
|
+
```
|
|
802
|
+
eggs export iso
|
|
803
|
+
```
|
|
804
|
+
This command exports the specified ISO image to the destination host.
|
|
805
|
+
|
|
806
|
+
```
|
|
807
|
+
eggs export iso --clean
|
|
463
808
|
```
|
|
809
|
+
This command deletes the old ISO images before copying the new ones, ensuring a clean transfer of ISO images to the destination host.
|
|
464
810
|
|
|
465
|
-
|
|
811
|
+
> [!TIP]
|
|
812
|
+
> To explore the code implementation of the `eggs export iso` command, you can refer to the [src/commands/export/iso.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/export/iso.ts) file in the penguins-eggs GitHub repository. This file contains the source code responsible for the `eggs export iso` functionality, providing a deeper understanding of how the command is implemented and executed.
|
|
466
813
|
|
|
467
814
|
## `eggs help [COMMAND]`
|
|
815
|
+
The `eggs help [COMMAND]` command is used to display help information for the `eggs` tool. This command provides users with detailed instructions and explanations on how to use specific commands or the `eggs` tool in general. By running the `eggs help [COMMAND]` command, users can access comprehensive documentation and guidance.
|
|
468
816
|
|
|
469
|
-
|
|
817
|
+
Here is the usage information for the `eggs help [COMMAND]` command:
|
|
470
818
|
|
|
471
819
|
```
|
|
472
820
|
USAGE
|
|
@@ -481,12 +829,20 @@ FLAGS
|
|
|
481
829
|
DESCRIPTION
|
|
482
830
|
Display help for eggs.
|
|
483
831
|
```
|
|
832
|
+
> [!NOTE]
|
|
833
|
+
> To use the command, you can run `eggs help [COMMAND]` in the terminal. The command supports the following arguments and flags:
|
|
484
834
|
|
|
485
|
-
|
|
835
|
+
- `COMMAND`: This is an optional argument that specifies the particular command for which you want to view help information. By providing a command name, you can access detailed instructions and explanations for that specific command.
|
|
836
|
+
- `-n` or `--nested-commands`: Including this flag will include all nested commands in the output. This means that not only the specified command's help information will be displayed but also the help information for any sub-commands or nested commands associated with it.
|
|
837
|
+
|
|
838
|
+
The primary purpose of the `eggs help [COMMAND]` command is to provide users with detailed guidance and documentation for the `eggs` tool. It allows users to access comprehensive information about commands, their usage, and available options.
|
|
839
|
+
> [!TIP]
|
|
840
|
+
> To explore the code implementation of the `eggs help [COMMAND]` command, you can refer to the [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.23/src/commands/help.ts) file in the plugin-help GitHub repository. This file contains the source code responsible for the `eggs help [COMMAND]` functionality, providing a deeper understanding of how the command is implemented and executed.
|
|
486
841
|
|
|
487
842
|
## `eggs install` or `eggs krill`
|
|
843
|
+
The `eggs install` or `eggs krill` command is used to install the CLI system installer called "krill" using the `eggs` tool. This command allows users to conveniently install the krill CLI system installer, which is represented metaphorically as an egg transforming into a penguin. The installation process provides various options and configurations to cater to different installation requirements.
|
|
488
844
|
|
|
489
|
-
|
|
845
|
+
Here is the usage information for the `eggs install` or `eggs krill` command:
|
|
490
846
|
|
|
491
847
|
```
|
|
492
848
|
USAGE
|
|
@@ -497,33 +853,63 @@ FLAGS
|
|
|
497
853
|
-N, --none Swap none: 256M
|
|
498
854
|
-S, --suspend Swap suspend: RAM x 2
|
|
499
855
|
-c, --custom=<value> custom unattended configuration
|
|
500
|
-
-d, --domain=<value> Domain name,
|
|
856
|
+
-d, --domain=<value> Domain name, default: .local
|
|
501
857
|
-h, --help Show CLI help.
|
|
502
|
-
-i, --ip hostname as
|
|
858
|
+
-i, --ip hostname as IP, e.g., ip-192-168-1-33
|
|
503
859
|
-k, --crypted Crypted CLI installation
|
|
504
860
|
-n, --nointeractive no user interaction
|
|
505
861
|
-p, --pve Proxmox VE install
|
|
506
|
-
-r, --random Add random to hostname,
|
|
862
|
+
-r, --random Add random to hostname, e.g., colibri-ay412dt
|
|
507
863
|
-s, --small Swap small: RAM
|
|
508
864
|
-u, --unattended Unattended installation
|
|
509
865
|
-v, --verbose Verbose
|
|
510
866
|
|
|
511
867
|
DESCRIPTION
|
|
512
868
|
krill: the CLI system installer - the egg became a penguin!
|
|
869
|
+
```
|
|
870
|
+
> [!NOTE]
|
|
871
|
+
> To use the command, you can run `eggs install` or `eggs krill` in the terminal. The command supports numerous flags and options to customize the installation process:
|
|
513
872
|
|
|
514
|
-
|
|
515
|
-
|
|
873
|
+
- `-H` or `--halt`: Including this flag will halt the system after installation.
|
|
874
|
+
- `-N` or `--none`: Including this flag will configure no swap memory allocation (256M).
|
|
875
|
+
- `-S` or `--suspend`: Including this flag will configure swap memory allocation as double the RAM size.
|
|
876
|
+
- `-c` or `--custom=<value>`: This option allows users to provide a custom unattended configuration for the installation.
|
|
877
|
+
- `-d` or `--domain=<value>`: This option specifies the domain name for the installation. The default is set to `.local`.
|
|
878
|
+
- `-h` or `--help`: This flag displays the help information for the `eggs install` or `eggs krill` command, providing a brief description of its usage and available flags.
|
|
879
|
+
- `-i` or `--ip`: Including this flag will use the hostname as an IP address, such as `ip-192-168-1-33`.
|
|
880
|
+
- `-k` or `--crypted`: Including this flag enables crypted CLI installation.
|
|
881
|
+
- `-n` or `--nointeractive`: Including this flag ensures a non-interactive installation process, without requiring any user interaction.
|
|
882
|
+
- `-p` or `--pve`: Including this flag specifies a Proxmox VE installation.
|
|
883
|
+
- `-r` or `--random`: Including this flag adds a random string to the hostname, such as `colibri-ay412dt`.
|
|
884
|
+
- `-s` or `--small`: Including this flag configures swap memory allocation based on the RAM size.
|
|
885
|
+
- `-u` or `--unattended`: Including this flag enables unattended installation.
|
|
886
|
+
- `-v` or `--verbose`: Including this flag enables verbose mode, providing more detailed information during the installation process.
|
|
516
887
|
|
|
517
|
-
|
|
888
|
+
The primary purpose of the `eggs install` or `eggs krill` command is to install the krill CLI system installer. This allows users to configure and customize the installation process based on their specific requirements.
|
|
518
889
|
|
|
519
|
-
|
|
890
|
+
Here are some examples of how to use the `eggs install` or `eggs krill` command:
|
|
891
|
+
|
|
892
|
+
```
|
|
893
|
+
sudo eggs install
|
|
520
894
|
```
|
|
895
|
+
This command installs the krill CLI system installer.
|
|
521
896
|
|
|
522
|
-
|
|
897
|
+
```
|
|
898
|
+
sudo eggs install --unattended
|
|
899
|
+
```
|
|
900
|
+
This command performs an unattended installation of the krill CLI system installer.
|
|
901
|
+
|
|
902
|
+
```
|
|
903
|
+
sudo eggs install --custom it
|
|
904
|
+
```
|
|
905
|
+
This command installs the krill CLI system installer using a custom unattended configuration named "it".
|
|
906
|
+
> [!TIP]
|
|
907
|
+
> To explore the code implementation of the `eggs install` or `eggs krill` command, you can refer to the [src/commands/install.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/install.ts) file in the penguins-eggs GitHub repository. This file contains the source code responsible for the `eggs install` or `eggs krill` functionality, providing a deeper understanding of how the command is implemented and executed.
|
|
523
908
|
|
|
524
909
|
## `eggs kill`
|
|
910
|
+
The `eggs kill` command is used to terminate and remove eggs, metaphorically representing freeing the nest. This command allows users to delete eggs and perform additional actions related to the nest.
|
|
525
911
|
|
|
526
|
-
|
|
912
|
+
Here is the usage information for the `eggs kill` command:
|
|
527
913
|
|
|
528
914
|
```
|
|
529
915
|
USAGE
|
|
@@ -531,22 +917,37 @@ USAGE
|
|
|
531
917
|
|
|
532
918
|
FLAGS
|
|
533
919
|
-h, --help Show CLI help.
|
|
534
|
-
-i, --isos
|
|
535
|
-
-n, --nointeractive
|
|
536
|
-
-v, --verbose
|
|
920
|
+
-i, --isos Erase all ISOs on remote mount
|
|
921
|
+
-n, --nointeractive No user interaction
|
|
922
|
+
-v, --verbose Verbose
|
|
537
923
|
|
|
538
924
|
DESCRIPTION
|
|
539
|
-
|
|
925
|
+
Kill the eggs/free the nest
|
|
926
|
+
```
|
|
927
|
+
> [!NOTE]
|
|
928
|
+
> To use the command, you can run `eggs kill` in the terminal. The command supports several flags to customize the process:
|
|
540
929
|
|
|
541
|
-
|
|
542
|
-
|
|
930
|
+
- `-h` or `--help`: This flag displays the help information for the `eggs kill` command, providing a brief description of its usage and available flags.
|
|
931
|
+
- `-i` or `--isos`: Including this flag will erase all ISOs on the remote mount.
|
|
932
|
+
- `-n` or `--nointeractive`: Including this flag ensures a non-interactive execution, without requiring any user interaction.
|
|
933
|
+
- `-v` or `--verbose`: Including this flag enables verbose mode, providing more detailed information during the execution.
|
|
934
|
+
|
|
935
|
+
The primary purpose of the `eggs kill` command is to terminate and remove eggs, symbolizing the act of freeing the nest. It offers additional options, such as erasing ISOs on the remote mount.
|
|
936
|
+
|
|
937
|
+
Here is an example of how to use the `eggs kill` command:
|
|
938
|
+
|
|
939
|
+
```
|
|
940
|
+
sudo eggs kill
|
|
543
941
|
```
|
|
942
|
+
This command terminates and removes eggs, freeing the nest.
|
|
544
943
|
|
|
545
|
-
|
|
944
|
+
> [!TIP]
|
|
945
|
+
> To explore the code implementation of the `eggs kill` command, you can refer to the [src/commands/kill.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/kill.ts) file in the penguins-eggs GitHub repository. This file contains the source code responsible for the `eggs kill` functionality, providing a deeper understanding of how the command is implemented and executed.
|
|
546
946
|
|
|
547
947
|
## `eggs mom`
|
|
948
|
+
The `eggs mom` command is a feature that allows users to seek assistance from a "mommy" helper in a TUI (Text-based User Interface) environment. By invoking this command, users can request help and guidance from the "mommy" helper, who is specifically designed to provide support and aid within the TUI context.
|
|
548
949
|
|
|
549
|
-
|
|
950
|
+
Here is the usage information for the `eggs mom` command:
|
|
550
951
|
|
|
551
952
|
```
|
|
552
953
|
USAGE
|
|
@@ -556,17 +957,30 @@ FLAGS
|
|
|
556
957
|
-h, --help Show CLI help.
|
|
557
958
|
|
|
558
959
|
DESCRIPTION
|
|
559
|
-
|
|
960
|
+
Ask help from mommy - TUI helper
|
|
961
|
+
```
|
|
560
962
|
|
|
561
|
-
|
|
562
|
-
|
|
963
|
+
To utilize this command, you simply need to execute `eggs mom` in the terminal. The command includes a single flag:
|
|
964
|
+
|
|
965
|
+
- `-h` or `--help`: This flag displays the help information for the `eggs mom` command, providing a brief description of its usage and available flags.
|
|
966
|
+
|
|
967
|
+
The primary purpose of the `eggs mom` command is to seek assistance from the "mommy" helper, who is specifically designed as a TUI helper. This implies that the "mommy" helper is equipped to provide guidance, support, and help within a text-based user interface environment.
|
|
968
|
+
|
|
969
|
+
Here is an example of how to use the `eggs mom` command:
|
|
970
|
+
|
|
971
|
+
```
|
|
972
|
+
$ eggs mom
|
|
563
973
|
```
|
|
564
974
|
|
|
565
|
-
|
|
975
|
+
Executing this command allows users to seek help and guidance from the "mommy" helper within the TUI environment.
|
|
976
|
+
> [!TIP]
|
|
977
|
+
> If you are interested in exploring the code implementation of the `eggs mom` command, you can refer to the [src/commands/mom.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/mom.ts) file in the penguins-eggs GitHub repository. This file contains the source code responsible for implementing the functionality of the `eggs mom` command. By examining this code, you can gain a deeper understanding of how the command interacts with the "mommy" helper and facilitates user assistance within the TUI.
|
|
978
|
+
|
|
566
979
|
|
|
567
980
|
## `eggs produce`
|
|
981
|
+
The `eggs produce` command is a powerful feature that allows users to generate a live image from their system, excluding their personal data. This command enables users to create a self-contained image of their system, which can be used for various purposes such as system backup, distribution, or testing.
|
|
568
982
|
|
|
569
|
-
|
|
983
|
+
Here is the usage information for the `eggs produce` command:
|
|
570
984
|
|
|
571
985
|
```
|
|
572
986
|
USAGE
|
|
@@ -574,419 +988,517 @@ USAGE
|
|
|
574
988
|
[-s] [-f] [--theme <value>] [-v] [-y]
|
|
575
989
|
|
|
576
990
|
FLAGS
|
|
577
|
-
-C, --cryptedclone crypted clone
|
|
578
|
-
-c, --clone clone
|
|
579
|
-
-f, --standard standard compression
|
|
991
|
+
-C, --cryptedclone Enable crypted clone
|
|
992
|
+
-c, --clone Enable clone
|
|
993
|
+
-f, --standard Use standard compression
|
|
580
994
|
-h, --help Show CLI help.
|
|
581
|
-
-m, --max max compression
|
|
582
|
-
-N, --noicons
|
|
583
|
-
-n, --nointeractive
|
|
584
|
-
-p, --prefix=<value> prefix
|
|
585
|
-
-s, --script script mode. Generate scripts to manage
|
|
586
|
-
-u, --unsecure
|
|
587
|
-
-v, --verbose verbose
|
|
588
|
-
-y, --yolk
|
|
589
|
-
--addons=<value>... addons to be used: adapt, ichoice, pve, rsupport
|
|
590
|
-
--basename=<value> basename
|
|
591
|
-
--filters=<value>... filters to be used: custom
|
|
592
|
-
--release
|
|
593
|
-
--theme=<value> theme for livecd, calamares branding and partitions
|
|
995
|
+
-m, --max Use max compression
|
|
996
|
+
-N, --noicons Exclude icons
|
|
997
|
+
-n, --nointeractive Disable user interaction
|
|
998
|
+
-p, --prefix=<value> Set prefix
|
|
999
|
+
-s, --script Enable script mode. Generate scripts to manage ISO build
|
|
1000
|
+
-u, --unsecure Include /home/* and full /root contents in the live image
|
|
1001
|
+
-v, --verbose Enable verbose mode
|
|
1002
|
+
-y, --yolk Force yolk renew
|
|
1003
|
+
--addons=<value>... Specify addons to be used: adapt, ichoice, pve, rsupport
|
|
1004
|
+
--basename=<value> Set the basename
|
|
1005
|
+
--filters=<value>... Specify filters to be used: custom, dev, homes, usr
|
|
1006
|
+
--release Use max compression and remove penguins-eggs and calamares after installation
|
|
1007
|
+
--theme=<value> Set the theme for livecd, calamares branding, and partitions
|
|
594
1008
|
|
|
595
1009
|
DESCRIPTION
|
|
596
|
-
|
|
1010
|
+
Generate a live image from your system without including your personal data.
|
|
597
1011
|
|
|
598
1012
|
EXAMPLES
|
|
599
1013
|
sudo eggs produce
|
|
600
1014
|
|
|
601
|
-
sudo eggs produce --standard
|
|
602
|
-
|
|
603
1015
|
sudo eggs produce --max
|
|
604
1016
|
|
|
605
|
-
sudo eggs produce --max --basename=colibri
|
|
606
|
-
|
|
607
|
-
sudo eggs produce --cryptedclone
|
|
608
|
-
|
|
609
1017
|
sudo eggs produce --clone
|
|
610
|
-
|
|
1018
|
+
|
|
1019
|
+
sudo eggs produce --clone --max
|
|
1020
|
+
|
|
611
1021
|
sudo eggs produce --basename=colibri
|
|
612
1022
|
|
|
613
|
-
sudo eggs produce --
|
|
1023
|
+
sudo eggs produce --filters custom homes usr
|
|
1024
|
+
|
|
1025
|
+
sudo eggs produce --theme /path/to/theme --addons adapt
|
|
614
1026
|
```
|
|
615
1027
|
|
|
616
|
-
|
|
1028
|
+
> [!NOTE]
|
|
1029
|
+
> To use the `eggs produce` command, you can run it with various options and flags depending on your requirements. Here are some notable options and flags:
|
|
617
1030
|
|
|
618
|
-
|
|
1031
|
+
- `--addons`: Specify additional addons to be included in the live image, such as `adapt`, `ichoice`, `pve`, or `rsupport`.
|
|
1032
|
+
- `--basename`: Set a custom basename for the live image.
|
|
1033
|
+
- `-c` or `--clone`: Enable cloning functionality, allowing the live image to replicate the system's configuration.
|
|
1034
|
+
- `-m` or `--max`: Use maximum compression for the live image.
|
|
1035
|
+
- `-s` or `--script`: Enable script mode, which generates scripts to manage the ISO build process.
|
|
1036
|
+
- `-u` or `--unsecure`: Include `/home/*` and the full contents of `/root` in the live image.
|
|
1037
|
+
- `--theme`: Set a specific theme for the live CD, Calamares branding, and partitions.
|
|
1038
|
+
- `--filters`: Specify filters to be applied during the live image generation, such as `custom`, `dev`, `homes`, or `usr`.
|
|
1039
|
+
- `--release`: Use maximum compression, and remove `penguins-eggs` and `calamares` after installation.
|
|
1040
|
+
|
|
1041
|
+
The `eggs produce` command is highly customizable and offers flexibility in generating live images according to specific needs. It provides a comprehensive set of options and flags to tailor the output image and its behavior.
|
|
1042
|
+
> [!TIP]
|
|
1043
|
+
> If you are interested in exploring the code implementation of the `eggs produce` command, you can refer to the [src/commands/produce.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/produce.ts) file in the penguins-eggs GitHub repository. This file contains the source code responsible for implementing the functionality of the `eggs produce` command. Examining this code can provide further insights into the inner workings of the command and its interaction with the system to generate the live image.
|
|
619
1044
|
|
|
620
|
-
|
|
1045
|
+
## `eggs status`
|
|
1046
|
+
The `eggs status` command provides information about the status of eggs. It is a command-line interface (CLI) command that can be executed with various options. Here is a breakdown of the command's usage:
|
|
621
1047
|
|
|
1048
|
+
**USAGE**
|
|
1049
|
+
```
|
|
1050
|
+
eggs status [-h] [-v]
|
|
622
1051
|
```
|
|
623
|
-
USAGE
|
|
624
|
-
$ eggs status [-h] [-v]
|
|
625
1052
|
|
|
626
|
-
FLAGS
|
|
627
|
-
|
|
628
|
-
|
|
1053
|
+
**FLAGS**
|
|
1054
|
+
- `-h, --help`: Shows help information for the command.
|
|
1055
|
+
- `-v, --verbose`: Enables verbose mode, which provides more detailed output.
|
|
629
1056
|
|
|
630
|
-
DESCRIPTION
|
|
631
|
-
|
|
1057
|
+
**DESCRIPTION**
|
|
1058
|
+
The `eggs status` command provides information about the status of eggs. It likely retrieves and displays information such as the number of eggs, their condition, or any relevant details about their status.
|
|
632
1059
|
|
|
633
|
-
EXAMPLES
|
|
634
|
-
$ eggs status
|
|
1060
|
+
**EXAMPLES**
|
|
635
1061
|
```
|
|
1062
|
+
eggs status
|
|
1063
|
+
```
|
|
1064
|
+
This example executes the `eggs status` command without any additional options.
|
|
636
1065
|
|
|
637
|
-
|
|
638
|
-
|
|
1066
|
+
To learn more about the implementation and source code of the `eggs status` command, you can visit the following link: [src/commands/status.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/status.ts)
|
|
639
1067
|
## `eggs syncfrom`
|
|
1068
|
+
The `eggs syncfrom` command is used to restore users and user data from a LUKS (Linux Unified Key Setup) volume. It is a command-line interface (CLI) command that can be executed with various options. Here is a breakdown of the command's usage:
|
|
640
1069
|
|
|
641
|
-
|
|
642
|
-
|
|
1070
|
+
**USAGE**
|
|
1071
|
+
```
|
|
1072
|
+
eggs syncfrom [--delete <value>] [-f <value>] [-h] [-r <value>] [-v]
|
|
643
1073
|
```
|
|
644
|
-
USAGE
|
|
645
|
-
$ eggs syncfrom [--delete <value>] [-f <value>] [-h] [-r <value>] [-v]
|
|
646
|
-
|
|
647
|
-
FLAGS
|
|
648
|
-
-f, --file=<value> file LUKS volume encrypted
|
|
649
|
-
-h, --help Show CLI help.
|
|
650
|
-
-r, --rootdir=<value> rootdir of the installed system, when used from live
|
|
651
|
-
-v, --verbose verbose
|
|
652
|
-
--delete=<value> rsync --delete delete extraneous files from dest dirs
|
|
653
1074
|
|
|
654
|
-
|
|
655
|
-
|
|
1075
|
+
**FLAGS**
|
|
1076
|
+
- `-f, --file=<value>`: Specifies the file path of the LUKS volume that is encrypted.
|
|
1077
|
+
- `-h, --help`: Shows help information for the command.
|
|
1078
|
+
- `-r, --rootdir=<value>`: Specifies the root directory of the installed system when used from a live environment.
|
|
1079
|
+
- `-v, --verbose`: Enables verbose mode, which provides more detailed output.
|
|
1080
|
+
- `--delete=<value>`: Uses `rsync --delete` to delete extraneous files from the destination directories.
|
|
656
1081
|
|
|
657
|
-
|
|
658
|
-
|
|
1082
|
+
**DESCRIPTION**
|
|
1083
|
+
The `eggs syncfrom` command is used to restore users and user data from a LUKS volume. It likely performs operations such as decrypting the LUKS volume, copying user data, and restoring user accounts on the system.
|
|
659
1084
|
|
|
660
|
-
|
|
1085
|
+
**EXAMPLES**
|
|
661
1086
|
```
|
|
1087
|
+
sudo eggs syncfrom
|
|
1088
|
+
```
|
|
1089
|
+
This example executes the `eggs syncfrom` command with default options.
|
|
662
1090
|
|
|
663
|
-
|
|
1091
|
+
```
|
|
1092
|
+
sudo eggs syncfrom --file /path/to/fileLUKS
|
|
1093
|
+
```
|
|
1094
|
+
This example executes the `eggs syncfrom` command while specifying the file path of the LUKS volume to restore from.
|
|
1095
|
+
> [!TIP]
|
|
1096
|
+
> To learn more about the implementation and source code of the `eggs syncfrom` command, you can visit the following link: [src/commands/syncfrom.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/syncfrom.ts)
|
|
664
1097
|
|
|
665
1098
|
## `eggs syncto`
|
|
1099
|
+
The `eggs syncto` command is designed to save users and user data in a LUKS (Linux Unified Key Setup) volume located inside the iso. It is a command-line interface (CLI) command that can be executed with various options. Here is an expanded and rewritten explanation of the command:
|
|
666
1100
|
|
|
667
|
-
|
|
668
|
-
|
|
1101
|
+
**USAGE**
|
|
1102
|
+
```
|
|
1103
|
+
eggs syncto [--delete <value>] [-f <value>] [-h] [-v]
|
|
669
1104
|
```
|
|
670
|
-
USAGE
|
|
671
|
-
$ eggs syncto [--delete <value>] [-f <value>] [-h] [-v]
|
|
672
1105
|
|
|
673
|
-
FLAGS
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
1106
|
+
**FLAGS**
|
|
1107
|
+
- `-f, --file=<value>`: Specifies the file path of the LUKS volume that will be encrypted.
|
|
1108
|
+
- `-h, --help`: Displays help information for the command.
|
|
1109
|
+
- `-v, --verbose`: Enables verbose mode, providing more detailed output.
|
|
1110
|
+
- `--delete=<value>`: Utilizes `rsync --delete` to delete extraneous files from the destination directories.
|
|
678
1111
|
|
|
679
|
-
DESCRIPTION
|
|
680
|
-
|
|
1112
|
+
**DESCRIPTION**
|
|
1113
|
+
The `eggs syncto` command allows users to save users and user data within a LUKS volume that is located inside the iso. This command is typically used to create a secure and encrypted storage space within the iso, where user-related information can be stored and protected.
|
|
681
1114
|
|
|
682
|
-
|
|
683
|
-
|
|
1115
|
+
> [!NOTE]
|
|
1116
|
+
> By executing this command, the user data is encrypted and stored in a LUKS volume, ensuring the confidentiality and security of the information. The LUKS volume is embedded within the iso, making it portable and self-contained.
|
|
684
1117
|
|
|
685
|
-
|
|
1118
|
+
**EXAMPLES**
|
|
1119
|
+
```
|
|
1120
|
+
sudo eggs syncto
|
|
686
1121
|
```
|
|
1122
|
+
This example executes the `eggs syncto` command with default options.
|
|
687
1123
|
|
|
688
|
-
|
|
1124
|
+
```
|
|
1125
|
+
sudo eggs syncto --file /path/to/fileLUKS
|
|
1126
|
+
```
|
|
1127
|
+
This example executes the `eggs syncto` command while specifying the file path of the LUKS volume to create and save the user data.
|
|
1128
|
+
> [!TIP]
|
|
1129
|
+
> To gain a deeper understanding of the implementation and view the source code of the `eggs syncto` command, you can refer to the following link: [src/commands/syncto.js](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/syncto.ts)
|
|
689
1130
|
|
|
690
1131
|
## `eggs tools clean`
|
|
1132
|
+
The `eggs tools clean` command is used to clean various system logs, apt cache, and other unnecessary files. It is a command-line interface (CLI) command that can be executed with different options. Here is an expanded and rewritten explanation of the command:
|
|
691
1133
|
|
|
692
|
-
|
|
693
|
-
|
|
1134
|
+
**USAGE**
|
|
694
1135
|
```
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
-v, --verbose verbose
|
|
1136
|
+
eggs tools clean [-h] [-n] [-v]
|
|
1137
|
+
```
|
|
1138
|
+
**FLAGS**
|
|
1139
|
+
- `-h, --help`: Displays help information for the command.
|
|
1140
|
+
- `-n, --nointeractive`: Performs the cleaning process without any user interaction.
|
|
1141
|
+
- `-v, --verbose`: Enables verbose mode, providing more detailed output.
|
|
702
1142
|
|
|
703
|
-
DESCRIPTION
|
|
704
|
-
|
|
1143
|
+
**DESCRIPTION**
|
|
1144
|
+
The `eggs tools clean` command is designed to remove unnecessary files and clean up system logs and apt cache. By executing this command, you can free up disk space and improve system performance by removing temporary files, log files, and cached package files. The cleaning process may include deleting system logs, which contain records of system events and activities. It may also involve cleaning up the apt cache, which stores downloaded package files. By removing these files, you can reclaim disk space and ensure that your system operates more efficiently.
|
|
705
1145
|
|
|
706
|
-
EXAMPLES
|
|
707
|
-
|
|
1146
|
+
**EXAMPLES**
|
|
1147
|
+
```
|
|
1148
|
+
sudo eggs tools clean
|
|
708
1149
|
```
|
|
1150
|
+
This example executes the `eggs tools clean` command with default options.
|
|
709
1151
|
|
|
710
|
-
|
|
1152
|
+
**To gain a deeper understanding of the implementation and view the source code of the `eggs tools clean` command, you can refer to the following link:** [src/commands/tools/clean.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/tools/clean.ts)
|
|
711
1153
|
|
|
712
1154
|
## `eggs tools ppa`
|
|
1155
|
+
The `eggs tools ppa` command is used to add or remove PPA (Personal Package Archive) repositories in the Debian family of operating systems. It is a command-line interface (CLI) command that can be executed with different options. Here is an expanded and rewritten explanation of the command:
|
|
713
1156
|
|
|
714
|
-
|
|
715
|
-
|
|
1157
|
+
**USAGE**
|
|
1158
|
+
```
|
|
1159
|
+
eggs tools ppa [-a] [-h] [-n] [-r] [-v]
|
|
716
1160
|
```
|
|
717
|
-
USAGE
|
|
718
|
-
$ eggs tools ppa [-a] [-h] [-n] [-r] [-v]
|
|
719
1161
|
|
|
720
|
-
FLAGS
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
1162
|
+
**FLAGS**
|
|
1163
|
+
- `-a, --add`: Adds the penguins-eggs PPA repository.
|
|
1164
|
+
- `-h, --help`: Displays help information for the command.
|
|
1165
|
+
- `-n, --nointeractive`: Performs the operation without any user interaction.
|
|
1166
|
+
- `-r, --remove`: Removes the penguins-eggs PPA repository.
|
|
1167
|
+
- `-v, --verbose`: Enables verbose mode, providing more detailed output.
|
|
726
1168
|
|
|
727
|
-
DESCRIPTION
|
|
728
|
-
|
|
1169
|
+
**DESCRIPTION**
|
|
1170
|
+
The `eggs tools ppa` command allows users to manage PPA repositories in the Debian family of operating systems. PPA repositories are external software repositories that provide additional packages and updates not found in the official Debian repositories. By adding or removing PPA repositories, users can access a wider range of software packages and ensure their system stays up to date. To add a PPA repository, you can use the `-a` or `--add` flag. This will add the penguins-eggs PPA repository to your system, allowing you to install software packages from that repository. To remove a PPA repository, you can use the `-r` or `--remove` flag. This will remove the penguins-eggs PPA repository from your system, preventing you from installing or updating packages from that repository.
|
|
729
1171
|
|
|
730
|
-
EXAMPLES
|
|
731
|
-
|
|
1172
|
+
**EXAMPLES**
|
|
1173
|
+
```
|
|
1174
|
+
sudo eggs tools ppa --add
|
|
1175
|
+
```
|
|
1176
|
+
This example adds the penguins-eggs PPA repository to the system.
|
|
732
1177
|
|
|
733
|
-
sudo eggs tools ppa --remove
|
|
734
1178
|
```
|
|
735
|
-
|
|
1179
|
+
sudo eggs tools ppa --remove
|
|
1180
|
+
```
|
|
1181
|
+
This example removes the penguins-eggs PPA repository from the system.
|
|
1182
|
+
> [!TIP]
|
|
1183
|
+
> **To gain a deeper understanding of the implementation and view the source code of the `eggs tools ppa` command, you can refer to the following link:** [src/commands/tools/ppa.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/tools/ppa.ts)
|
|
736
1184
|
|
|
737
1185
|
## `eggs tools skel`
|
|
1186
|
+
The `eggs tools skel` command is used to update the "skel" directory with the configuration files from the user's home directory. It is a command-line interface (CLI) command that can be executed with different options. Here is an expanded and rewritten explanation of the command:
|
|
738
1187
|
|
|
739
|
-
|
|
740
|
-
|
|
1188
|
+
**USAGE**
|
|
1189
|
+
```
|
|
1190
|
+
eggs tools skel [-h] [-u <value>] [-v]
|
|
741
1191
|
```
|
|
742
|
-
USAGE
|
|
743
|
-
$ eggs tools skel [-h] [-u <value>] [-v]
|
|
744
1192
|
|
|
745
|
-
FLAGS
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
1193
|
+
**FLAGS**
|
|
1194
|
+
- `-h, --help`: Displays help information for the command.
|
|
1195
|
+
- `-u, --user=<value>`: Specifies the user whose home directory configuration files will be used to update the "skel" directory.
|
|
1196
|
+
- `-v, --verbose`: Enables verbose mode, providing more detailed output.
|
|
749
1197
|
|
|
750
|
-
DESCRIPTION
|
|
751
|
-
|
|
1198
|
+
**DESCRIPTION**
|
|
1199
|
+
The `eggs tools skel` command is designed to update the "skel" directory with configuration files from a user's home directory. The "skel" directory, short for "skeleton," is a directory in Linux systems that contains default configuration files and directories used as templates when creating new user accounts.By executing the `eggs tools skel` command, you can update the "skel" directory with the latest configuration files from a specified user's home directory. This ensures that new user accounts created on the system will have the same configuration settings as the specified user.
|
|
752
1200
|
|
|
753
|
-
EXAMPLES
|
|
754
|
-
|
|
1201
|
+
**EXAMPLES**
|
|
1202
|
+
```
|
|
1203
|
+
sudo eggs tools skel
|
|
1204
|
+
```
|
|
1205
|
+
This example updates the "skel" directory with the configuration files from the current user's home directory.
|
|
755
1206
|
|
|
756
|
-
sudo eggs tools skel --user user-to-be-copied
|
|
757
1207
|
```
|
|
758
|
-
|
|
1208
|
+
sudo eggs tools skel --user user-to-be-copied
|
|
1209
|
+
```
|
|
1210
|
+
This example updates the "skel" directory with the configuration files from the specified user's home directory (`user-to-be-copied`).
|
|
1211
|
+
> [!TIP]
|
|
1212
|
+
> **To gain a deeper understanding of the implementation and view the source code of the `eggs tools skel` command, you can refer to the following link:** [src/commands/tools/skel.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/tools/skel.ts)
|
|
759
1213
|
|
|
760
1214
|
|
|
761
1215
|
## `eggs tools stat`
|
|
1216
|
+
The `eggs tools stat` command is used to retrieve statistics from SourceForge. It is a command-line interface (CLI) command that can be executed with different options. Here is an expanded and rewritten explanation of the command:
|
|
762
1217
|
|
|
763
|
-
|
|
764
|
-
|
|
1218
|
+
**USAGE**
|
|
1219
|
+
```
|
|
1220
|
+
eggs tools stat [-h] [-m] [-y]
|
|
765
1221
|
```
|
|
766
|
-
USAGE
|
|
767
|
-
$ eggs tools stat [-h] [-m] [-y]
|
|
768
|
-
|
|
769
|
-
FLAGS
|
|
770
|
-
-h, --help Show CLI help.
|
|
771
|
-
-m, --month current month
|
|
772
|
-
-y, --year current year
|
|
773
|
-
|
|
774
|
-
DESCRIPTION
|
|
775
|
-
get statistics from sourceforge
|
|
776
1222
|
|
|
777
|
-
|
|
778
|
-
|
|
1223
|
+
**FLAGS**
|
|
1224
|
+
- `-h, --help`: Displays help information for the command.
|
|
1225
|
+
- `-m, --month`: Retrieves statistics for the current month.
|
|
1226
|
+
- `-y, --year`: Retrieves statistics for the current year.
|
|
779
1227
|
|
|
780
|
-
|
|
1228
|
+
**DESCRIPTION**
|
|
1229
|
+
The `eggs tools stat` command allows users to obtain statistics from SourceForge, a web-based service that provides version control, collaboration, and distribution tools for software development projects. By executing this command, users can retrieve various metrics and data related to their projects hosted on SourceForge.
|
|
781
1230
|
|
|
782
|
-
|
|
1231
|
+
**EXAMPLES**
|
|
1232
|
+
```
|
|
1233
|
+
eggs tools stat
|
|
783
1234
|
```
|
|
1235
|
+
This example retrieves general statistics from SourceForge, which may include information such as the number of downloads, active users, or project popularity.
|
|
784
1236
|
|
|
785
|
-
|
|
1237
|
+
```
|
|
1238
|
+
eggs tools stat --month
|
|
1239
|
+
```
|
|
1240
|
+
This example retrieves statistics specifically for the current month, providing more detailed insights into the project's performance during that period.
|
|
786
1241
|
|
|
1242
|
+
```
|
|
1243
|
+
eggs tools stat --year
|
|
1244
|
+
```
|
|
1245
|
+
This example retrieves statistics specifically for the current year, allowing users to analyze the project's overall progress and growth over time.
|
|
1246
|
+
> [!TIP]
|
|
1247
|
+
> **To gain a deeper understanding of the implementation and view the source code of the `eggs tools stat` command, you can refer to the following link:** [src/commands/tools/stat.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/tools/stat.ts)
|
|
787
1248
|
|
|
788
1249
|
## `eggs tools yolk`
|
|
1250
|
+
The `eggs tools yolk` command is used to configure the "eggs" tool to enable installation without an internet connection. It is a command-line interface (CLI) command that can be executed with different options. Here is an expanded and rewritten explanation of the command:
|
|
789
1251
|
|
|
790
|
-
|
|
791
|
-
|
|
1252
|
+
**USAGE**
|
|
1253
|
+
```
|
|
1254
|
+
eggs tools yolk [-h] [-v]
|
|
792
1255
|
```
|
|
793
|
-
USAGE
|
|
794
|
-
$ eggs tools yolk [-h] [-v]
|
|
795
1256
|
|
|
796
|
-
FLAGS
|
|
797
|
-
|
|
798
|
-
|
|
1257
|
+
**FLAGS**
|
|
1258
|
+
- `-h, --help`: Displays help information for the command.
|
|
1259
|
+
- `-v, --verbose`: Enables verbose mode, providing more detailed output.
|
|
799
1260
|
|
|
800
|
-
DESCRIPTION
|
|
801
|
-
|
|
1261
|
+
**DESCRIPTION**
|
|
1262
|
+
The `eggs tools yolk` command allows users to configure the "eggs" tool to enable installation without requiring an internet connection. The "eggs" tool is a software package manager or installer that is designed to simplify the process of installing and managing software packages on a computer system. By executing the `eggs tools yolk` command with the appropriate options, users can set up the "eggs" tool to work in an offline mode. This means that it will be able to install software packages from local sources, such as a local repository or package cache, without needing to connect to the internet.
|
|
802
1263
|
|
|
803
|
-
EXAMPLES
|
|
804
|
-
sudo eggs tools yolk
|
|
1264
|
+
**EXAMPLES**
|
|
805
1265
|
```
|
|
806
|
-
|
|
807
|
-
|
|
1266
|
+
sudo eggs tools yolk
|
|
1267
|
+
```
|
|
1268
|
+
This example configures the "eggs" tool to install software packages without an internet connection. The `sudo` command is used to run the command with administrative privileges.
|
|
1269
|
+
> [!TIP]
|
|
1270
|
+
> **To gain a deeper understanding of the implementation and view the source code of the `eggs tools yolk` command, you can refer to the following link:** [src/commands/tools/yolk.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/tools/yolk.ts)
|
|
808
1271
|
|
|
809
1272
|
## `eggs update`
|
|
1273
|
+
The `eggs update` command is used to update the Penguins' eggs tool. It is a command-line interface (CLI) command that can be executed with different options. Here is an expanded and rewritten explanation of the command:
|
|
810
1274
|
|
|
811
|
-
|
|
812
|
-
|
|
1275
|
+
**USAGE**
|
|
1276
|
+
```
|
|
1277
|
+
eggs update [-h] [-v]
|
|
813
1278
|
```
|
|
814
|
-
USAGE
|
|
815
|
-
$ eggs update [-h] [-v]
|
|
816
1279
|
|
|
817
|
-
FLAGS
|
|
818
|
-
|
|
819
|
-
|
|
1280
|
+
**FLAGS**
|
|
1281
|
+
- `-h, --help`: Displays help information for the command.
|
|
1282
|
+
- `-v, --verbose`: Enables verbose mode, providing more detailed output.
|
|
820
1283
|
|
|
821
|
-
DESCRIPTION
|
|
822
|
-
|
|
1284
|
+
**DESCRIPTION**
|
|
1285
|
+
The `eggs update` command allows users to update the Penguins' eggs tool to the latest version. The Penguins' eggs tool is a software utility or package manager that is specifically designed for managing and installing software packages related to the Penguins project. By executing the `eggs update` command, users can check for updates to the Penguins' eggs tool and install the latest version if available. This ensures that users have the most up-to-date features, bug fixes, and improvements for the Penguins' eggs tool.
|
|
823
1286
|
|
|
824
|
-
EXAMPLES
|
|
825
|
-
$ eggs update
|
|
1287
|
+
**EXAMPLES**
|
|
826
1288
|
```
|
|
1289
|
+
eggs update
|
|
1290
|
+
```
|
|
1291
|
+
This example checks for updates to the Penguins' eggs tool and installs the latest version if available.
|
|
1292
|
+
> [!TIP]
|
|
1293
|
+
> **To gain a deeper understanding of the implementation and view the source code related to the `eggs update` command, you can refer to the following link:** [src/update.js](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/update.ts)
|
|
827
1294
|
|
|
828
|
-
_See code: [src/update.js](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands//update.ts)_
|
|
829
1295
|
|
|
830
1296
|
## `eggs version`
|
|
1297
|
+
The `eggs version` command is used to retrieve information about the version of the "eggs" command-line interface (CLI). It is a command-line command that can be executed with different options. Here is an expanded and rewritten explanation of the command:
|
|
831
1298
|
|
|
1299
|
+
**USAGE**
|
|
1300
|
+
```
|
|
1301
|
+
eggs version [--json] [--verbose]
|
|
832
1302
|
```
|
|
833
|
-
USAGE
|
|
834
|
-
$ eggs version [--json] [--verbose]
|
|
835
1303
|
|
|
836
|
-
FLAGS
|
|
837
|
-
|
|
1304
|
+
**FLAGS**
|
|
1305
|
+
- `--verbose`: Shows additional information about the CLI.
|
|
1306
|
+
- `--json`: Formats the output as JSON.
|
|
838
1307
|
|
|
839
|
-
GLOBAL FLAGS
|
|
840
|
-
|
|
1308
|
+
**GLOBAL FLAGS**
|
|
1309
|
+
- `--json`: Formats the output as JSON.
|
|
841
1310
|
|
|
842
|
-
FLAG DESCRIPTIONS
|
|
843
|
-
|
|
1311
|
+
**FLAG DESCRIPTIONS**
|
|
1312
|
+
- `--verbose`: Shows additional information about the CLI. This includes details such as the architecture, Node.js version, operating system, and versions of plugins used by the CLI.
|
|
844
1313
|
|
|
845
|
-
|
|
846
|
-
```
|
|
1314
|
+
The `eggs version` command retrieves information about the version of the "eggs" CLI. By default, it provides basic version information. However, you can use the `--verbose` flag to get more detailed information, including the architecture, Node.js version, operating system, and versions of plugins used by the CLI.
|
|
847
1315
|
|
|
848
|
-
|
|
1316
|
+
Additionally, you can use the `--json` flag to format the output as JSON, which can be useful for automated processing or integration with other tools.
|
|
1317
|
+
> [!TIP]
|
|
1318
|
+
> **To gain a deeper understanding of the implementation and view the source code related to the `eggs version` command, you can refer to the following link:** [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.1.4/src/commands/version.ts)
|
|
849
1319
|
|
|
850
|
-
## `eggs wardrobe get [REPO]`
|
|
851
1320
|
|
|
852
|
-
get
|
|
1321
|
+
## `eggs wardrobe get [REPO]`
|
|
1322
|
+
The `eggs wardrobe get [REPO]` command is used to retrieve a wardrobe from a repository. It is a command-line interface (CLI) command that can be executed with different options. Here is an expanded and rewritten explanation of the command:
|
|
853
1323
|
|
|
1324
|
+
**USAGE**
|
|
1325
|
+
```
|
|
1326
|
+
eggs wardrobe get [REPO] [-h] [-v]
|
|
854
1327
|
```
|
|
855
|
-
USAGE
|
|
856
|
-
$ eggs wardrobe get [REPO] [-h] [-v]
|
|
857
1328
|
|
|
858
|
-
ARGUMENTS
|
|
859
|
-
|
|
1329
|
+
**ARGUMENTS**
|
|
1330
|
+
- `REPO`: The repository from which to retrieve the wardrobe.
|
|
860
1331
|
|
|
861
|
-
FLAGS
|
|
862
|
-
|
|
863
|
-
|
|
1332
|
+
**FLAGS**
|
|
1333
|
+
- `-h, --help`: Displays help information for the command.
|
|
1334
|
+
- `-v, --verbose`: Enables verbose mode, providing more detailed output.
|
|
864
1335
|
|
|
865
|
-
DESCRIPTION
|
|
866
|
-
get
|
|
1336
|
+
**DESCRIPTION**
|
|
1337
|
+
The `eggs wardrobe get [REPO]` command allows users to retrieve a wardrobe from a repository. A wardrobe, in this context, refers to a collection of clothing items that are stored and managed in a repository. By executing the `eggs wardrobe get [REPO]` command, users can specify the repository from which they want to retrieve the wardrobe. This allows users to access and view the clothing items stored in the specified repository.
|
|
867
1338
|
|
|
868
|
-
EXAMPLES
|
|
869
|
-
$ eggs wardrobe get
|
|
870
|
-
|
|
871
|
-
$ eggs wardrobe get your-wardrobe
|
|
1339
|
+
**EXAMPLES**
|
|
872
1340
|
```
|
|
1341
|
+
eggs wardrobe get
|
|
1342
|
+
```
|
|
1343
|
+
This example retrieves a wardrobe from a default repository.
|
|
873
1344
|
|
|
874
|
-
|
|
875
|
-
|
|
1345
|
+
```
|
|
1346
|
+
eggs wardrobe get your-wardrobe
|
|
1347
|
+
```
|
|
1348
|
+
This example retrieves a wardrobe from a specific repository called "your-wardrobe".
|
|
1349
|
+
> [!TIP]
|
|
1350
|
+
> **To gain a deeper understanding of the implementation and view the source code related to the `eggs wardrobe get [REPO]` command, you can refer to the following link:** [src/commands/wardrobe/get.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/wardrobe/get.ts)
|
|
876
1351
|
|
|
877
1352
|
## `eggs wardrobe list [WARDROBE]`
|
|
1353
|
+
The `eggs wardrobe list [WARDROBE]` command is used to list costumes and accessories stored in a wardrobe. It is a command-line interface (CLI) command that can be executed with different options. Here is an expanded and rewritten explanation of the command:
|
|
878
1354
|
|
|
879
|
-
|
|
880
|
-
|
|
1355
|
+
**USAGE**
|
|
1356
|
+
```
|
|
1357
|
+
eggs wardrobe list [WARDROBE] [-h] [-v]
|
|
881
1358
|
```
|
|
882
|
-
USAGE
|
|
883
|
-
$ eggs wardrobe list [WARDROBE] [-h] [-v]
|
|
884
1359
|
|
|
885
|
-
ARGUMENTS
|
|
886
|
-
|
|
1360
|
+
**ARGUMENTS**
|
|
1361
|
+
- `WARDROBE`: The specific wardrobe to list costumes and accessories from.
|
|
887
1362
|
|
|
888
|
-
FLAGS
|
|
889
|
-
|
|
890
|
-
|
|
1363
|
+
**FLAGS**
|
|
1364
|
+
- `-h, --help`: Displays help information for the command.
|
|
1365
|
+
- `-v, --verbose`: Enables verbose mode, providing more detailed output.
|
|
891
1366
|
|
|
892
|
-
DESCRIPTION
|
|
893
|
-
|
|
1367
|
+
**DESCRIPTION**
|
|
1368
|
+
The `eggs wardrobe list [WARDROBE]` command allows users to view a list of costumes and accessories stored in a wardrobe. A wardrobe, in this context, is a collection of clothing items and accessories that can be used for various purposes, such as dressing up or creating outfits.
|
|
894
1369
|
|
|
895
|
-
|
|
896
|
-
|
|
1370
|
+
> [!NOTE]
|
|
1371
|
+
> By executing the `eggs wardrobe list [WARDROBE]` command, users can specify the wardrobe they want to list costumes and accessories from. This command provides a convenient way to view the items available in a specific wardrobe.
|
|
897
1372
|
|
|
898
|
-
|
|
1373
|
+
**EXAMPLES**
|
|
1374
|
+
```
|
|
1375
|
+
eggs wardrobe list
|
|
899
1376
|
```
|
|
1377
|
+
This example lists costumes and accessories from a default wardrobe.
|
|
900
1378
|
|
|
901
|
-
|
|
1379
|
+
```
|
|
1380
|
+
eggs wardrobe list your-wardrobe
|
|
1381
|
+
```
|
|
1382
|
+
This example lists costumes and accessories from a specific wardrobe called "your-wardrobe".
|
|
1383
|
+
> [!TIP]
|
|
1384
|
+
> **To gain a deeper understanding of the implementation and view the source code related to the `eggs wardrobe list [WARDROBE]` command, you can refer to the following link:** [src/commands/wardrobe/list.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/wardrobe/list.ts)
|
|
902
1385
|
|
|
903
1386
|
|
|
904
1387
|
## `eggs wardrobe show [COSTUME]`
|
|
1388
|
+
The `eggs wardrobe show [COSTUME]` command is used to display costumes and accessories stored in a wardrobe. It is a command-line interface (CLI) command that can be executed with different options. Here is an expanded and rewritten explanation of the command:
|
|
905
1389
|
|
|
906
|
-
|
|
907
|
-
|
|
1390
|
+
**USAGE**
|
|
1391
|
+
```
|
|
1392
|
+
eggs wardrobe show [COSTUME] [-h] [-j] [-v] [-w <value>]
|
|
908
1393
|
```
|
|
909
|
-
USAGE
|
|
910
|
-
$ eggs wardrobe show [COSTUME] [-h] [-j] [-v] [-w <value>]
|
|
911
1394
|
|
|
912
|
-
ARGUMENTS
|
|
913
|
-
|
|
1395
|
+
**ARGUMENTS**
|
|
1396
|
+
- `COSTUME`: The specific costume or accessory to show.
|
|
914
1397
|
|
|
915
|
-
FLAGS
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
1398
|
+
**FLAGS**
|
|
1399
|
+
- `-h, --help`: Displays help information for the command.
|
|
1400
|
+
- `-j, --json`: Outputs the result in JSON format.
|
|
1401
|
+
- `-v, --verbose`: Enables verbose mode, providing more detailed output.
|
|
1402
|
+
- `-w, --wardrobe=<value>`: Specifies the wardrobe to show costumes and accessories from.
|
|
920
1403
|
|
|
921
|
-
DESCRIPTION
|
|
922
|
-
show costumes
|
|
1404
|
+
**DESCRIPTION**
|
|
1405
|
+
The `eggs wardrobe show [COSTUME]` command allows users to view details and information about specific costumes and accessories stored in a wardrobe. A wardrobe, in this context, is a collection of clothing items and accessories.
|
|
923
1406
|
|
|
924
|
-
|
|
925
|
-
|
|
1407
|
+
> [!NOTE]
|
|
1408
|
+
> By executing the `eggs wardrobe show [COSTUME]` command, users can specify the costume or accessory they want to view. This command provides a way to retrieve information about a particular item in the wardrobe.
|
|
1409
|
+
|
|
1410
|
+
**EXAMPLES**
|
|
1411
|
+
```
|
|
1412
|
+
eggs wardrobe show colibri
|
|
1413
|
+
```
|
|
1414
|
+
This example shows details about the "colibri" costume.
|
|
926
1415
|
|
|
927
|
-
|
|
1416
|
+
```
|
|
1417
|
+
eggs wardrobe show accessories/firmwares
|
|
1418
|
+
```
|
|
1419
|
+
This example shows details about the "firmwares" accessory within the "accessories" category.
|
|
928
1420
|
|
|
929
|
-
$ eggs wardrobe show accessories/
|
|
930
1421
|
```
|
|
931
|
-
|
|
1422
|
+
eggs wardrobe show accessories/
|
|
1423
|
+
```
|
|
1424
|
+
This example shows all available costumes and accessories within the "accessories" category.
|
|
1425
|
+
> [!TIP]
|
|
1426
|
+
> **To gain a deeper understanding of the implementation and view the source code related to the `eggs wardrobe show [COSTUME]` command, you can refer to the following link:** [src/commands/wardrobe/show.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/wardrobe/show.ts)
|
|
932
1427
|
|
|
933
|
-
## `eggs wardrobe wear [COSTUME]`
|
|
934
1428
|
|
|
935
|
-
|
|
1429
|
+
## `eggs wardrobe wear [COSTUME]`
|
|
1430
|
+
The `eggs wardrobe wear [COSTUME]` command is used to wear costumes and accessories from a wardrobe. It is a command-line interface (CLI) command that can be executed with various options. Here is an expanded and rewritten explanation of the command:
|
|
936
1431
|
|
|
1432
|
+
**USAGE**
|
|
1433
|
+
```
|
|
1434
|
+
eggs wardrobe wear [COSTUME] [-h] [-a] [-f] [-s] [-v] [-w <value>]
|
|
937
1435
|
```
|
|
938
|
-
USAGE
|
|
939
|
-
$ eggs wardrobe wear [COSTUME] [-h] [-a] [-f] [-s] [-v] [-w <value>]
|
|
940
1436
|
|
|
941
|
-
ARGUMENTS
|
|
942
|
-
|
|
1437
|
+
**ARGUMENTS**
|
|
1438
|
+
- `COSTUME`: The specific costume or accessory to wear.
|
|
943
1439
|
|
|
944
|
-
FLAGS
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
1440
|
+
**FLAGS**
|
|
1441
|
+
- `-a, --no_accessories`: Specifies not to install accessories when wearing the costume.
|
|
1442
|
+
- `-f, --no_firmwares`: Specifies not to install firmwares when wearing the costume.
|
|
1443
|
+
- `-h, --help`: Displays help information for the command.
|
|
1444
|
+
- `-s, --silent`: Enables silent mode, suppressing unnecessary output.
|
|
1445
|
+
- `-v, --verbose`: Enables verbose mode, providing more detailed output.
|
|
1446
|
+
- `-w, --wardrobe=<value>`: Specifies the wardrobe to wear costumes and accessories from.
|
|
951
1447
|
|
|
952
|
-
DESCRIPTION
|
|
953
|
-
|
|
1448
|
+
**DESCRIPTION**
|
|
1449
|
+
The `eggs wardrobe wear [COSTUME]` command allows users to wear specific costumes and accessories from a wardrobe. By executing this command, users can choose a costume or accessory they want to wear, and it will be applied or installed accordingly.
|
|
954
1450
|
|
|
955
|
-
|
|
956
|
-
|
|
1451
|
+
The command provides flexibility with the following options:
|
|
1452
|
+
- The `-a, --no_accessories` flag can be used to exclude installing accessories when wearing the costume.
|
|
1453
|
+
- The `-f, --no_firmwares` flag can be used to exclude installing firmwares when wearing the costume.
|
|
1454
|
+
- The `-s, --silent` flag enables silent mode, reducing unnecessary output.
|
|
1455
|
+
- The `-v, --verbose` flag enables verbose mode, providing more detailed output.
|
|
1456
|
+
> [!NOTE]
|
|
1457
|
+
> Users can also specify the wardrobe to wear the costumes and accessories by using the `-w, --wardrobe=<value>` option.
|
|
957
1458
|
|
|
958
|
-
|
|
1459
|
+
**EXAMPLES**
|
|
1460
|
+
```
|
|
1461
|
+
sudo eggs wardrobe wear duck
|
|
1462
|
+
```
|
|
1463
|
+
This example wears the "duck" costume from the wardrobe.
|
|
959
1464
|
|
|
960
|
-
sudo eggs wardrobe wear wagtail/waydroid
|
|
961
1465
|
```
|
|
1466
|
+
sudo eggs wardrobe wear accessories/firmwares
|
|
1467
|
+
```
|
|
1468
|
+
This example wears the "firmwares" accessory within the "accessories" category.
|
|
1469
|
+
|
|
1470
|
+
```
|
|
1471
|
+
sudo eggs wardrobe wear wagtail/waydroid
|
|
1472
|
+
```
|
|
1473
|
+
This example wears the "waydroid" costume from the "wagtail" category.
|
|
1474
|
+
> [!TIP]
|
|
1475
|
+
> **To gain a deeper understanding of the implementation and view the source code related to the `eggs wardrobe wear [COSTUME]` command, you can refer to the following link:** [src/commands/wardrobe/wear.ts](https://github.com/pieroproietti/penguins-eggs/blob/master/src/commands/wardrobe/wear.ts)
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
# Penguins' eggs official guide
|
|
1479
|
+
**Penguins' Eggs Official Guide and Resources**
|
|
1480
|
+
|
|
1481
|
+
Welcome to the Penguins' Eggs Official Guide! This comprehensive manual provides detailed instructions on using Penguins' Eggs, a software tool designed to facilitate various tasks. Initially released in Italian, the guide can be translated into other languages using machine translation for wider accessibility.
|
|
962
1482
|
|
|
963
|
-
|
|
1483
|
+
To access the guide, click [here](https://penguins-eggs.net/docs/Tutorial/eggs-users-guide). It offers valuable information and step-by-step tutorials to help users navigate through the software's features. However, please note that some of the terminal samples in the guide may need updating.
|
|
964
1484
|
|
|
965
|
-
|
|
1485
|
+
For a visual demonstration of Penguins' Eggs in action, check out these helpful [terminal samples](https://github.com/pieroproietti/penguins-eggs/blob/master/documents/terminal-lessons/eggs_help.gif?raw=true). They provide a practical overview of how to use the tool effectively.
|
|
966
1486
|
|
|
967
|
-
# Penguins' eggs official guide
|
|
968
|
-
The original edition of the eggs manual is released in Italian, of course other languages can be accessed using machine translation:
|
|
969
1487
|
|
|
970
|
-
|
|
1488
|
+
## That's all, Folks!
|
|
971
1489
|
|
|
972
|
-
|
|
1490
|
+
One of the standout features of Penguins' Eggs is its hassle-free setup. It comes with all the necessary configurations, making it a convenient choice for users. Just like in real life, the magic of Penguins' Eggs lies within - no additional setup required!
|
|
973
1491
|
|
|
974
|
-
|
|
1492
|
+
## More Information
|
|
975
1493
|
|
|
976
|
-
|
|
977
|
-
No need other configurations, penguins-eggs are battery included or better, as in the real, live is inside! :-D
|
|
1494
|
+
In addition to the official guide, there are other resources available for Penguins' Eggs users, particularly developers. These resources can be found in the [penguins-eggs repository](https://github.com/pieroproietti/penguins-eggs) under the [documents](https://github.com/pieroproietti/penguins-eggs/tree/master/documents) section.
|
|
978
1495
|
|
|
979
|
-
|
|
980
|
-
|
|
1496
|
+
Some noteworthy documents include:
|
|
1497
|
+
- [Hens: Different Species](https://github.com/pieroproietti/penguins-eggs/blob/master/documents/hens-different-species.md): A brief guide on using Penguins' Eggs in Debian, Arch, and Manjaro.
|
|
1498
|
+
- [Arch-naked](https://penguins-eggs.net/docs/Tutorial/archlinux-naked.html): A blog post detailing how to create an Arch naked live, install it, and customize the resulting system into a graphics development station.
|
|
1499
|
+
|
|
1500
|
+
If you have any questions or need further assistance, feel free to contact me via email at pieroproietti@gmail.com. You can also stay updated by following my blog [here](https://penguins-eggs.net) or connecting with me on [Facebook](https://www.facebook.com/groups/128861437762355/), [GitHub](https://github.com/pieroproietti/penguins-krill), [Jitsi](https://meet.jit.si/PenguinsEggsMeeting), [Reddit](https://www.reddit.com/user/Artisan61), [Telegram](https://t.me/penguins_eggs), or [Twitter](https://twitter.com/pieroproietti).
|
|
981
1501
|
|
|
982
|
-
You can contact me by [mail](mailto://pieroproietti@gmail.com) or follow me on
|
|
983
|
-
[blog](https://penguins-eggs.net),
|
|
984
|
-
[facebook](https://www.facebook.com/groups/128861437762355/),
|
|
985
|
-
[github](https://github.com/pieroproietti/penguins-krill),
|
|
986
|
-
[jtsi](https://meet.jit.si/PenguinsEggsMeeting),
|
|
987
|
-
[reddit](https://www.reddit.com/user/Artisan61),
|
|
988
|
-
[telegram](https://t.me/penguins_eggs),
|
|
989
|
-
[twitter](https://twitter.com/pieroproietti).
|
|
990
1502
|
|
|
991
1503
|
# Copyright and licenses
|
|
992
1504
|
Copyright (c) 2017, 2023 [Piero Proietti](https://penguins-eggs.net/about-me.html), dual licensed under the MIT or GPL Version 2 licenses.
|