diff --git a/README.md b/README.md new file mode 100644 index 0000000..c3e4440 --- /dev/null +++ b/README.md @@ -0,0 +1,94 @@ +# apt-plus + +Linux `apt-get` wrapper which lets you store installed/removed/purged packages. + +### Install + +> ##### (1) Launch the install script +```bash +bash ./install_apt-plus.sh; +``` + +> ##### (2) Create a _manifest_ file +```bash +touch ~/.apt-plus; +``` + +> ##### (3) Give apt-plus the manifest file path +```bash +apt-plus -m ~/.apt-plus; +``` + + + + +### Commands + +#### [1] Fetches packages from remote +Strict equivalent to `apt-get update`. + +> `apt-plus -f` +> `apt-plus --fetch` + +#### [2] Update your system packages +It first fetches the packages from remote, then upgrades your packages, your kernel and finally removes useless data. + +> `apt-plus -u` +> `apt-plus --update` + + +#### [3] Install one or multiple packages +It installs the given packages and store it in the _manifest_. +Package names must be separated by spaces. + +> `apt-plus -i ` +> `apt-plus --install ` + +You can specify a group for packages with the following syntax: +> `apt-plus :group_name: -i ` +> `apt-plus :group_name: --install ` + +#### [4] Install from a .deb file +It installs the given package and store it in the _manifest_. +The path does not need to be absolute; + +> `apt-plus -d ` +> `apt-plus --deb ` + +You can specify a group for the package with the following syntax: +> `apt-plus :group_name: -d ` +> `apt-plus :group_name: --deb ` + +#### [5] Remove one or multiple packages +It removes the given packages and store it in the _manifest_. +Package names must be separated by spaces. +In opposite of the **purge** command, it keeps the configuration files. + +> `apt-plus -r ` +> `apt-plus --remove ` + +You can specify a group for packages with the following syntax: +> `apt-plus :group_name: -r ` +> `apt-plus :group_name: --remove ` + +#### [6] Purge one or multiple packages +It purges the given packages and store it in the _manifest_. +Package names must be separated by spaces. +In opposite of the **remove** command, it does not keep the configuration files. + +> `apt-plus -p ` +> `apt-plus --purge ` + +You can specify a group for packages with the following syntax: +> `apt-plus :group_name: -p ` +> `apt-plus :group_name: --purge ` + + +#### [7] List stored packages +It shows you the list of stored packages (managed with apt-plus). +> `apt-plus -l` +> `apt-plus --list` + +You can specify a group to show only with the syntax: +> `apt-plus :group_name: -l` +> `apt-plus :group_name: --list` \ No newline at end of file