search

hkdb / app

A cross-platform package management assistant with super powers!
https://hkdb.github.io/app/
Apache License 2.0
55 stars 2 forks source link

readme

app - A Package Management Assistant with Super Powers

maintained by: @hkdb

ScreenShot

SUMMARY

A Unified Package Management Experience for users who either want a reproduceable workstation build or simply handle a lot of machines with ease.

App is a cross-platform package management wrapper written in Go that remembers all the additional packages a user installs on a machine beyond the base installation so that all the same packages can be automatically reinstalled on another machine with one command. It also provides the same command line interface across different distros/OS's and package managers so you don't have to remember the various syntax across different OS's and package managers. Last but not least, it allows users to upgrade all software packages installed on a system with a user defined set of package managers (ex. apt, flatpak, and AppImage) via a single command.

Supported OS:

Supported Package Managers:

This fun project came to life because I have multiple machines and am constantly re-installing them. I also review and or get new laptops fairly often.

THIS IS STILL ALPHA SOFTWARE

Skip all the mumbo jumbo if you just want to see how to INSTALL and UPGRADE app.

BACKGROUND (Probably TL;DR for most)

>>> Why app was created...

HOW IT WORKS

Instead of using your package manager, you use the app command to install/remove packages so that it records everything inside ~/.config/app. So when you move that directory to a new machine of the same based distro or OS, you can just install all the packages you have installed on the old machine with one command. In fact, if you move your ~/.config directory on a Linux machine to the next, it should retain most of your app settings that reside in ~/.config as well but be aware of config structual changes between varying versions of the same software.

See APP CONFIG DIRECTORY STRUCTURE to learn more about what's inside ~/.config/app.

See the available options (flags) of app.

See USAGE EXAMPLES to see a more complete dive into how to use app.

IN ACTION

asciicast

INSTALL

Run the below command in the terminal:

bash <(curl -sL https://hkdb.github.io/app/getapp.sh)

You can also install app by compiling yourself:

  1. Make sure all the package managers you want app to manage and are installed and configured properly
  2. Install git manually if it's not already installed
  3. cd into a directory of choice where you want to keep the app repo. If you are an end user and can't decide, I suggest ~/.config (mkdir ~/.config if it doesn't already exist)
  4. git clone https://github.com/hkdb/app.git`
  5. cd app
  6. Optionally git checkout <version>
  7. ./install.sh # Note, for FreeBSD, bash must first be installed.

UPDATE/UPGRADE

Run the below command in the terminal:

app -m app update

You can also update app by compiling it yourself:

Tracking versioned release:

  1. cd back into the repo whereever you put it. ~/.config/app if you took my recommendation
  2. git pull
  3. git checkout <version tag>
  4. ./update.sh # FreeBSD requires bash to be installed

Tracking main branch:

  1. cd back into the repo whreever you put it. ~/.config/app if you took my recommendation
  2. git pull
  3. ./update.sh # FreeBSD requires bash to be installed

SUPPORT & ROADMAP

Currently in the roadmap:

Pre-requisites:

Curl and Unzip must be installed

There's an install script that comes with this repo which is the preferred way to install app. However, I leave having each of your package managers proper setup/configuration to the end user before running app. For example, if you don't have the right packages installed to have add-apt-repository work properly on Debian or flatpak can't be used without sudo, then app will inevitably fail.

See the below notes on package manager setup:

If there are enabled package managers that you absolutely hate and want out of the auto restore/install all loop, you can disable them manually (ie. app -m snap disable) and app will remember this whereever you bring your ~/.config/app directory. You can also re-enable them anytime by just running app -m <package manager> enable

Other distros:

Some distros are easily supported by just simply identifying them under each of the 3 base distros respectively so if there's a distro that it doesn't support already, feel free to submit an issue including the output of cat /etc/*-release to request for it to be added and I will try to find time to get it added on.

Also, I primarily use Pop, Ubuntu, Debian, Fedora, Arch, and Garuda so other distros are a bit less tested. If you notice any issues on the other "supported" distros, please let me know by submitting an issue here.

Immutable distros and distros like nixos will most likely never make it to this list since for example, nixos' package manager pretty much addresses the same problem but just in a different way and perhaps maybe even better...

Caveat: Arch Derivatives

add-repo and rm-repo actions for Arch based distros only take bash scripts as arguments and only for pacman (not yay). There are various reasons why. Among them all, perhaps the more important ones are:

app does not handle local packages for Arch based distros as most of the time, users in Arch that deal with local packages are compiling their own packages from source which is sort of out of scope for what app is trying to solve. Unless someone tells me I am wrong, there aren't really pre-compiled packages out there that you can't really get from a combination of pacman, Arch AUR, and Chaotic. If someone tells me that they have a use case that says otherwise, it's most likely involving only 1 or 2 packages or some very specific dev project related subset which again, makes this feature fall under "not worth the time to automate" and "out of scope".

Caveat: Snap

As far as I know, there's no way to easily add third party repos especially since the whole backend is closed source.

Caveat: AppImage

If your AppImage app updates itself, you may need to manually edit your .desktop file in $HOME/.local/share/applications/ to point to the correct AppImage file in $HOME/.config/app/packages/local/appimage/ since the new file has a new version on the file name.

go/pip/cargo:

The go, pip, and cargo support is not meant to be a replacement for development purposes but rather for users that use software that are distributed via go, pip, and cargo.

SUPPORT US!

If this repo was useful to you, feel free to buy us some coffee! :)

"Buy Me A Coffee"

VERSIONS

v0.14

v0.13

v0.12

v0.11

v0.10

v0.09

v0.08

v0.07

v0.06

v0.05 - Feb 10th, 2024

v0.04 - Feb 1st, 2024

v0.03 - Jan 17th, 2024

v0.02 - Jan 10th, 2024

If you are upgrading rather than installing for the first time on Linux, after upgrading to this version, execute the following command:

echo "BREW = n" >> ~/.config/app/settings.conf

v0.01 - Jan 6th, 2024

DISCLAIMER

THIS IS STILL ALPHA SOFTWARE

This repo is sponsored by 3DF OSI and is maintained by volunteers. 3DF Limited, 3DF OSI, and its volunteers in no way make any guarantees. Please use at your own risk!

To Learn more, please visit:

https://osi.3df.io

https://3df.io