Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 2.64 KB

README.md

File metadata and controls

33 lines (24 loc) · 2.64 KB
Raw

Flattool Logo a simple icon of a tower crane holding a dangling letter F in front of "lattool"

Flattool is a command line script designed to improve the experience of working with flatpaks through the command line.

Main Features:

  1. Handling Multiple Installs: Flattool allows you to handle multiple flatpak installs in a loop, ensuring that if a match is not found, your entire queue is not lost.
  2. Simplified App Execution: Running apps from the command line becomes easier with Flattool. Instead of using the app's full Application ID, you can simply enter a query for Flattool to match.
  3. Cleanup of Orphaned User Files: Flattool helps you clean up orphaned user data files. It identifies user data files that are not associated with any installed flatpak and offers options to either trash the folder or attempt to install the associated flatpak.

Important Notes:

  • This is my first major project. As a new developer, I appreciate your understanding if there are any bugs.
  • Flattool assumes that flatpak user data is stored within the default location: ~/.var/app.
  • Flattool is not meant to replace flatpak; it simply sends appropriate flatpak commands for the desired actions.

Dependencies:

To use Flattool effectively, you need to ensure the following dependencies are installed on your system:

  • flatpak: Since Flattool is specifically designed for managing flatpak applications, you must have flatpak installed on your system.

Optional dependancies:

  • trash-cli - Utilized to move files to your user's trash instead of perminantly deleting them.
  • gio - gio trash is utilized to move files to your user's trash if trash-cli is not installed.
  • Unfortunately, gio trash is usually only preinstalled with gnome, so if that is not present, then flattool wil default to rm -rf, which will permanently delete specified files.

Installation Steps:

  1. Run the command printf $PATH in your terminal to view the directories in your PATH.
  2. Download the flattool script to one of the directories shown in the previous step. You can use the following command: wget -P /path/to/bin/directory https://raw.githubusercontent.com/heliguy4599/flattool/main/flattool
  3. Navigate to the directory where you downloaded the flattool file and run chmod +x flattool to make it executable.

You're all set! Now you can run flattool using the command flattool --help.

Graphical User interface:

Warehouse is a graphical user interface for flattool, which uses libadwaita and provides the same features (and some others) of flattool-cli.