Repository files navigation

Curses based file manager that caters to power users

Meant to be insanely FAST and LIGHTWEIGHT

Licensed underGNU GPL v3

1. Ranger like traversal of directories (vim keybinds supported)
2. String search along with next occurance functionalities
3. Easy and Fast addition, deletion of files and directories
4. Clean and responsive TUI thanks to ncurses with cool colors and unicodes
5. Incredibly fast extraction and compression functions thanks tolibarchive
6. Very transient and logical workflow
7. InsanelyFAST andMODULAR Syntax Highlighting systemSYNHASH

-> Currently LiteFM has only been tested on the following Linux Distros:

1. Arch Linux kernels >= 6.9 (zen and base) x86_64 arch (1920x1080)
2. Ubuntu versions >= 20 x86_64 arch
3. Linux Mint >= 20 x86_64 arch

-> There are no plans on expanding this beyond Linux distributions

echo'export EDITOR=/sbin/nvim'>>~/.bashrc

As LiteFM can only be built manually, here is a table of all deps used:

The above are the listed32-bit and64-bit libraries that are used in this project.

-> Only 64-bit libs have been tested to fruition so far

Refer to this table to understand theBuilding procedure better

REFER TODependencies TO BETTER UNDERSTAND THE BUILDING PROCESS AND FLOW.

LiteFM cannot be installed in any UNIX-like distribution but can be easily built!

chmod +x build.sh./build.sh

Ensure you have CMake installed first

->cmake -S . -B build/ to create abuild/ directory with all libraries linked as perCMakeLists.txt

->cmake --build build/ to get the./build/litefm executable

-> Set it as an alias in your respective shell rc and enjoy!

cmake -S. -B build cmake --build build/./build/litefm

-> Runmake in the current directory

-> This should give a./litefm executable, just run it to enjoy LiteFM!

-> To cleanup, runmake clean

make ./litefm

-> Ensure that you havemeson andninja (orninja-build) installed in your distribution.

meson setup build/meson compile -C build/./build/litefm

NOTE: Runningsudo ninja install will MOVE the litefm executable to/usr/local/bin directory.

If you DO NOT want this, ignore the last step and simple run./litefm

In any case, to uninstall (stay in the build dir):

sudo ninja uninstall

-> Run the executablelitefm and enjoy!

In order check how LiteFM works under the hood and further understand any issues, redundancies or vulnerabilities,

Check outdebug to build LiteFM withAddressSanitizer (ASan)

You can add the man page for LiteFM in your system by the following commands:

[NOTE: You will have to keep updating this man page manually every time a new functionality is introduced.]

sudo cp components/litefm.1 /usr/share/man/man1cd /usr/share/man/man1/&& sudo gzip litefm.1

Thats it! The man page is ready to be used viaman litefm

As this is a file manager that is able to perform some VERY cool and dangerous tasks like deleting any directory recursively, I definitely have tried to set up security measures to avoid any form of code vulnerability or CWE.

Other steps I plan on taking to ensure that you are always in control of the file manager are:

1. Alitefm.log and it's functionality has been implemented (src/logging.c) that will log EVERY file/dir control in every litefm instance
2. Possibly set up a trash system so that accidental deletion of any file/dir can be restored [priority/low]
3. Trying to add password protected files [priority/med]

Check outSECURITY for the security policy that this repository follows.

Security Tools that can be used in LiteFM:

-> AddressSanitizer (ASan): Gives an in-depth view of how memory leaks take place, overflows and much more

This file manager is far from done there are a lot of cool and essential features that are planned:

• Adding a basic file preview for readable files (and stat info for directories)

• Integrating current file tasks to multiple files selection (copy, paste, move)

• GO-TO a particular file or directory through string input (might be tough)

• Color coding for file groups (green - general files, pink - images, red - unextracted archives, orange - audio files) [implementation through struct mostly]

• Bugfixes and massive code refactor

• Improve the build script

• Integration of adding a text editor

• Better handling ofdynamically linked files andsymbolic links

• Handling resizing of litefm window (maybe throughSIGWINCH)

• UPCOMING: Modular Syntax highlighting throughyaml.h andHashtables

• UPCOMING: Adding a privacy guard (using GPG maybe)