giorgosxou/tuifimanager

A cross-platform terminal-based termux-oriented file manager (and component), meant to be used with a Uni-Curses project or as is.

TUIFI Manager

A cross-platform terminal-based termux-oriented file manager (and component), meant to be used with a Uni-Curses project or as is. This project is mainly an attempt to get more attention to the Uni-Curses project.

⚙️ Installation

sudo pip3 install tuifimanager --upgrade

pip3 install TUIFIManager --upgrade

or just ^^^ if it works for you. (eg. on termux?)

💥 Usage

Run tuifi in your terminal to use it as is or import it in one of your Uni-Curses project as a component like:

from TUIFIManager import *

for more details look into the __main__.py

_{FONT: Cartograph CF}

📦 Features

• 📌 Current:

• Supports most of the common mouse events so far
• It is somewhat fully customizable?
• Can be used as a component
• Uses only ~30MB of RAM
• It is pretty snappy
• Supports Termux
• Cross Platform
• and more

• 🔮 Desired:

• Undo\Redo
• tool-tips
• Scroll bar
• Sixel support
• Multiple tabs
• Better performance
• Effect on cutted Files
• Drop files into GUI apps

⌨️ Keybindings

In vim_mode both normal and vim shortcuts work

Normal	vim_mode	Action
SHIFT + TAB		Moves selected file to the previous directory
KEY_BACKSPACE	J	Opens\Goes to the previous directory
ALT + DOWN		Opens\Closes the "right-click menu"
KEY_HOME	H	Navigates to the $HOME directory
KEY_F5		Reload\Refresh current directory
CTRL + V	p	Pastes the Copied or Cuted files
DEL	CTRL+d	Deletes the selected files
CTRL + F	i	Find Files (if not auto_find_on_typing)
CTRL + O	O	Open whole directory in editor
CTRL + A		Select all files in current folder
CTRL + C	yy	Copies the selected files
CTRL + K		Copies the selected files
CTRL + X	c	Cuts the selected files
CTRL + R	r	Rename selected file
CTRL + T		Toggle hidden files
CTRL + N	W	Create new folder
CTRL + W	w	Create new file
ARROW KEYS	l k j h	Navigates files
KEY_ENTER	K	Opens files
CTRL + E	e	Exit with cd
ESCAPE		Exit

(TIP: 🐁 use ALT + CLICK for multiple mouse selection if SHIFT not working)

TERMUX only Shortcuts\Keybindings

Shortcut	Action
CTRL + DOWN	Goes in&out of select-mode while also automatically copies the selected file(s)
CTRL + LEFT	Goes out of select-mode while also cuts the seleccted file(s)
CTRL + END	Goes out of select-mode while also deleting the selected file(s)
CTRL + UP	Same as CTRL + V, Pastes the Copied or Cuted files
END	Deletes selected files

👨‍💻 Commands

(Default & Custom Comands) - To perform a command under the normal-mode, you first have to press the space-bar and then type the command. Alternatively, use vim_mode or enable the tuifi_auto_command_on_typing env-variable (notice: it disables tuifi_auto_find_on_typing). The default commands can be seen below and can be found under the ~/.config/tuifi/cmds.conf where you can add your custom ones too:

Cmd	Type	Attributes	Label Comment
gt	open	'directory':'~/.config/tuifi'	- tuifi -
gh	open	'directory':'~/'	- Home -
owv	open	'directory':None,'_with':'vim'	Opened With Vim
yat	copy	'pattern':'.+.txt'
yy	copy	'pattern':None

There are also some "static" ones like the m+character which marks the current directory into the character, so you can navigate back to it by using ` or ;+that_character

📜 Documentation

_{Work in progress 🛠️🏗 ...}

💭 Customization

How do I enable vim_mode?

Set tuifi_vim_mode enviroment variable to True

How do I change the default keys (besides commands)?

This is not possible right now althought you could play around with the content of toggle_vim_mode function under __init__.py

How do I set the default editor?

Set tuifi_default_editor enviroment variable to vim or whatever you prefer

How do I disable the auto-find-mode?

You can just set tuifi_auto_find_on_typing enviroment variable to False

How do I change the scroll sensitivity?

You can set either or both tuifi_scroll_sensitivity, tuifi_ctrl_scroll_sensitivity enviromental variables, to the disered number of characters per scroll action (they default to 1 and 7)

How do I change the number of visible lines of filenames that are visible?

You can set how mnay lines you want using tuifi_visible_filename_lines (Defaults to 4)

How do I change the default configuration path?

Set tuifi_config_path enviroment variable to whatever you prefer most

How do I toggle hidden files/folders?

You can either CTRL + T or set tuifi_show_hidden enviroment variable to True

How do I change the default colors?

look here for more informations

💗 Donation

I do really need money to survive, I have no job, living in a basement, making things for free, because I love to.

• Paypal Address
• Monero Address: 897ehhSQJQpGF7tYDhQM51jiX7nnHmzuYAW4q8JGwJxu8JKXvaK6AivCzatuJxnifjZ2qy98ks2g2PhmTaYCMMta2Ga2LJx

🫶 Special thanks to

• @KORBEN for this article
• Bryan Lunduke for this article
• Brodie Robertson for this video
• r/linux community for their comments
• r/cyberDeck community for their comments
• r/commandline community for their comments

🕳️ Help

Any Idea with this issue unicurses/unicurses#21 ?

tuifimanager's Issues

Using EDITOR instead of tuifi_default_editor

Is there any benefit to using a custom variable for the editor? Using EDITOR will use the correct editor out of the box for most users, since most people heavily using the terminal will have it set. If you want to offer the ability to use an editor other than what EDITOR is set to, perhaps you could check if tuifi_default_editor is set, and otherwise fallback to EDITOR?

OSError

shell=True , make it a string and maybe remove os.system('clear')

TUIFIManager/TUIFIManager/__init__.py

Line 270 in c526026

proc = subprocess.Popen([open_with, directory])

recreating the issue, open any file with DEFAULT_OPENER at least on windows

CTRL+C raises auto-search function

just a reminder to return when event is null 0, because i forgot about it and i was wondering why i had this issue lol

just add this line, under the handle_events function

if event == 0: return

Typing support

I'd like to see (maybe add by myself) typing support as it is a good practice and would help to understand a bit more of what is going on, often allowing to spot more complex issues and code simplifying.

What are your thoughts about it?

Error when starting tuifi

os: Arch GNU/Linux
version: Latest commit from git

When starting TUIFIManager using the command provided from setup.py in a local installation, it crashes with the following error:

(venv) [sigmanificient@Sigmachine TUIFIManager]$ tuifi
Traceback (most recent call last):
  File "/home/sigmanificient/TUIFIManager/venv/bin/tuifi", line 33, in <module>
    sys.exit(load_entry_point('TUIFIManager', 'console_scripts', 'tuifi')())
  File "/home/sigmanificient/TUIFIManager/venv/bin/tuifi", line 25, in importlib_load_entry_point
    return next(matches).load()
  File "/usr/lib/python3.10/importlib/metadata/__init__.py", line 171, in load
    module = import_module(match.group('module'))
  File "/usr/lib/python3.10/importlib/__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1050, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1027, in _find_and_load
  File "<frozen importlib._bootstrap>", line 992, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "<frozen importlib._bootstrap>", line 1050, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1027, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1006, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 688, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 883, in exec_module
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "/home/sigmanificient/TUIFIManager/TUIFIManager/__init__.py", line 11, in <module>
    from       .TUIMenu import    *
  File "/home/sigmanificient/TUIFIManager/TUIFIManager/TUIMenu.py", line 3, in <module>
    from TUItilities import BEGIN_MOUSE,END_MOUSE
ModuleNotFoundError: No module named 'TUItilities'

This is caused by the line 3 from TUIFile.py:

from TUItilities import BEGIN_MOUSE,END_MOUSE

Add license?

subj

Using a static configuration for the setup process

I noticed that the setup process is pretty simple, and thus setting up a static configuration could be a nice to have.
I'm thinking of using setup.cfg as it is natively supported by setup-tools, but poetry can be a nice alternative too.

Using a dynamic approach is a bit criticized by some as it may lead to ACE at installation. Anyway, it always better to have a clean easy and standard way for the setup.

suffixes and search

just realised how wrong my implementation of search + suffixes was, especially for the component side of the project.

Hover Effect on Windows

I'm really buffled by the mouse support of PDcurses, wierd stuff happening, where if the bstate is 0 (or even quit the app with bstate 0), then real-time mouse coordinates work fine unitl I click or scroll and the bstate change then I get nothing

Reminder: I forgot to remove the last line from __init__.py

If you ctrl+c and random characters appear on the side of the selected fille, it is because I forgot this line .

I'll remove it tommorow, now I'm going to sleep.

Scroll wheel not working on Windows

TUIFIManager/TUIFIManager/__init__.py

Line 751 in 6efabe6

in_range, id, x, y, z, bstate = self.get_mouse()

TUIFIManager/TUIFIManager/TUItilities.py

Line 115 in 6efabe6

id, x, y, z, bstate = uc.getmouse()

So it seems like pdcurses having issues with returning the position when (and only when) scrolling is performed

Drop files from TUI into GUI

We need to figure out, how to drop a file from terminal into GUIs (especially browsers) [...]

Create links sortcut

symlinks

Thank you very much 🤗

How do I change the default colors?

You said:

A bit complicated to explain here just make an issue and I will explain it there

So I did.

ncurses not found but existing on macOS

Installed via:
% pip3 install TUIFIManager --upgrade

Run as:
% tuifi

Got:

goetz@host ~ % tuifi
Traceback (most recent call last):
  File "/opt/homebrew/bin/tuifi", line 5, in <module>
    from TUIFIManager.__main__ import main
  File "/opt/homebrew/lib/python3.10/site-packages/TUIFIManager/__init__.py", line 9, in <module>
    from       .TUIMenu import    *
  File "/opt/homebrew/lib/python3.10/site-packages/TUIFIManager/TUIMenu.py", line 2, in <module>
    import unicurses
  File "/opt/homebrew/lib/python3.10/site-packages/unicurses/__init__.py", line 119, in <module>
    ncurses,panel = get_libncursesw_paths()
  File "/opt/homebrew/lib/python3.10/site-packages/unicurses/__init__.py", line 79, in get_libncursesw_paths
    raise Exception('NCursesNotFound: ' + msg)
Exception: NCursesNotFound: No version of shared-libraries of ncurses found on this system, please try `brew install ncurses` if this won't work please create an issue

goetz@host ~ % brew install ncurses
==> Auto-updated Homebrew!
[…]
Running `brew update --auto-update`...
[…]

Warning: ncurses 6.3 is already installed and up-to-date.
To reinstall 6.3, run:
  brew reinstall ncurses

goetz@host ~ % sw_vers
ProductName:		macOS
ProductVersion:		13.1
BuildVersion:		22C65

… on ARM64.

TUIFIManager does not start in current working directory.

Hello,

I see no reason why TUIFIManager should not start in the current working directory $PWD (os.path.curdir in Python).

Instead, it appears the default is to always start in the user's home directory ($HOME).

Please consider changing the behavior.

Multiple instances when opening and closing a file

https://github.com/GiorgosXou/TUIFIManager/blob/19487a82f9c42152b46c58e2a04a942585533eda/TUIFIManager/__init__.py#L255/

CTRL + S is default for stop processing terminal

Just wanted to point out that for a terminal based utility, the default keybinding CTRL +S is highly problematic,
as for most environments it means freeze / don't update / stop scrolling the terminal.
(with CTRL + Q meaning continue / unfreeze / resume scrolling).

Please consider to replace this default binding with something less irritating to most users.

Thanks.

Display Hidden files after Non-Hidden files

Not sure this is an issue but displaying both hidden and non-hidden files/folders together makes it kinda messy for the user to distinguish.
Normally, non-hidden files are displayed first and then the hidden files at last.
Also, a shortcut can be created to unhide hidden files and to hide again.

Issue initializing colors on Windows

TUIFIManager/TUIFIManager/TUItilities.py

Line 66 in 6efabe6

if uc.pair_content(i+color_pair_offset) == (0,0): # if it exists in some way

AFAICT, both are "correct" -- trying to use a color pair you haven't set up is undefined behavior.

Which means that we have to replace = (0,0) with in ((0,0),(7,0)) ( [usingin] just in case that they change it in the future to (0,0) and we don't relise it)

Oppsie | re.error

I'll just use pathlib's glob to fix it asap, my fault

TUIFIManager/TUIFIManager/__init__.py

Line 137 in c526026

if not len(glob(file_directory + sep + suffix)) == 0:

TUIFIManager/TUIFIManager/__init__.py

Line 158 in c526026

glob_files.extend(glob(directory + sep + suffix))

Reproducing the issue: create a folder named [what-ever]

Deleting in TERMUX

Permisions are limmited in TERMUX when it comes to the access of storage, and send2trash fails to create a trash-folder in the root directory of the emulated or SD storage

Just a reminder nothing important at all

Reminder to make the same icon of excel to say TUIFI, take a screenshot and put it in README.md (extension too)

Yank when no file selected

TUIFIManager/TUIFIManager/__init__.py

Line 668 in a4fffb8

else:

elif self.__clicked_file:

Move file to trash instead of deleting

As Brodie Robertson mentioned in his video, I think completely deleting files is not intuitive and makes deleting files unnecessarily stressful. I think a good solution for this would be to instead move the files to ~/.local/share/Trash/ (and the equivalent on other platforms). This way the files would be automatically removed after a certain amount of time on Windows and Mac, (and on linux if the user or another trash program configured it to do so) but if the user accidentally deleted the file they could easily recover it. This would also help when undoing is added.

replace profile when renaming extension

My time is so limited

Typo

TUIFIManager/TUIFIManager/TUIFIProfile.py

Line 51 in 22be2bf

'.conf':TUIFIProfile((

Add xdg-open as Default External Opener on media formats

xdg-open (or termux-open) would be a good fall back for mp3, mp4 etc.

Also the OGG profile has a typo (.ogv)

Potential Issue with Open

Potential issue when opening files without extension and without DEFAULT_EDITOR
https://github.com/GiorgosXou/TUIFIManager/blob/master/TUIFIManager/__init__.py#L253

Nix OS support

The package fail to initialize on Nix OS. As no configuration is provided, is make it hard to install properly.

Traceback (most recent call last):
  File "/data/dev/GiorgosXou/TUIFIManager/venv/bin/tuifi", line 5, in <module>
    from TUIFIManager.__main__ import main
  File "/data/dev/GiorgosXou/TUIFIManager/TUIFIManager/__init__.py", line 12, in <module>
    from       .TUIMenu import TUIMenu
  File "/data/dev/GiorgosXou/TUIFIManager/TUIFIManager/TUIMenu.py", line 2, in <module>
    import unicurses
  File "/data/dev/GiorgosXou/TUIFIManager/venv/lib/python3.10/site-packages/unicurses/__init__.py", line 124, in <module>
    lib1 = ctypes.CDLL(ncurses,mode=ctypes.RTLD_GLOBAL)
  File "/nix/store/hhk4wr7hwry854sq69chmrjqyi964p7y-python3-3.10.9/lib/python3.10/ctypes/__init__.py", line 374, in __init__
    self._handle = _dlopen(self._name, mode)
OSError: libncursesw.so.6: cannot open shared object file: No such file or directory

Scroll sensitivity

We need a Scroll sensitivity variable, maybe "smoth scrolling" with an offset too?

Add a nox ci for various configuration

The project needs a nox CI to ensure installation is going as planned.

A GitHub action with various configuration (python version and os) would make it easy to sport potential issues.

Flickering of menu (?)

For some very wierd reason, the issue gets solved the momment I open a file to an external app (it doesn't matter if the external app is a TUI or not), I'm guessing this has to do with the print(BEGIN_MOUSE) in main

\r vs \n vs \r\n etc.

What's wrong with Popen in Windows?

TUIFIManager/TUIFIManager/__init__.py

Line 285 in 32b59ba

proc = subprocess.Popen([open_with, *dirs], shell=IS_WINDOWS)

Can't figure out why paths with spaces, don't start properly even when set in double quotation marks

Code Formatting

I noticed during my small dig into the source that the formatting is pretty unusual, making it hard to understand a lot of what is happening and how to structure the code i want to add. Moreover, my code editor is going absolutely crazy, with pretty much every line being underlined.

It would be nice to provide a configuration for your code styling via pylint to a similar tooling, or maybe use a more broad formatting like black (mostly based on python pep8) or flake. The second option would allow to use contigeous integration to insure future code to be well formatted and would keep it under close standard to python developers.

What are your thoughts about it?

Oopsie, version

TUIFIManager/TUIFIManager/__main__.py

Line 48 in 5b45e00

if "-v" in sys.argv or "--version" in sys.argv:

tuifi calls main() not the file __main_.py

Select mode navigation to '..'

I forgot to auto-disable select mode when navigating to ".." but nvm, tommorow I'll do it

Freeze

Randomly freezes when using

python 3.9
tuifi from pipy 1.3.3
unicurses from pipy 2.1.0
ncurses6 6.3-p20220507
alacritty 0.11.0

recording.mp4

Is this free?

Extracting "ascii images" to files

It would be really nice to have a separation for the ASCII files icons into their own files outside the codebase.

This would make organization easier, adding new files type an easy manner and improve the possibility for customization.
I would think of having metadata along the ascii art, such a the file extensions.

For later on it could be a way to add better / small icons too while keeping the code clean with a simple loader helper

Git keeps corrupting the peek gif

DUE to CRLF replacement in the, git keeps corrupting the Peek.gif file.
From git logs:

warning: in the working copy of 'Peek.gif', CRLF will be replaced by LF the next time Git touches it

Installation with pip is giving an error on pyproject.toml: LICENSE not found.

Running both:
sudo pip3 install tuifimanager --upgrade
pip3 install TUIFIManager --upgrade outputs the same error.

Defaulting to user installation because normal site-packages is not writeable
Collecting TUIFIManager
  Using cached TUIFIManager-2.3.2.tar.gz (41 kB)
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Installing backend dependencies ... done
  Preparing metadata (pyproject.toml) ... error
  error: subprocess-exited-with-error
  
  × Preparing metadata (pyproject.toml) did not run successfully.
  │ exit code: 1
  ╰─> [6 lines of output]
      running dist_info
      creating /tmp/pip-modern-metadata-ti7k196i/TUIFIManager.egg-info
      writing manifest file '/tmp/pip-modern-metadata-ti7k196i/TUIFIManager.egg-info/SOURCES.txt'
      listing git files failed - pretending there aren't any
      writing manifest file '/tmp/pip-modern-metadata-ti7k196i/TUIFIManager.egg-info/SOURCES.txt'
      error: [Errno 2] No such file or directory: 'LICENSE'
      [end of output]
  
  note: This error originates from a subprocess, and is likely not a problem with pip.
error: metadata-generation-failed

× Encountered error while generating package metadata.
╰─> See above for output.

note: This is an issue with the package mentioned above, not pip.

Not sure if its a problem on my end or permission errors because sudo didn't work either. I tried updating my packages, ran pip again and got the same errors.

Platform: Pop!OS 22.04 LTS

Vim motions?

Thinking of adding some basic motions, although this is not the priority right now.

Over-lapping files when exiting search mode

Weird Issue resulting in the over-drawing of another icon, when exiting find-mode (in position 0) and then proceeding to move:

it has been fixed, it will not be present in the next release

v.1.1.3 Issue with termux first copy paste and navigation to ".."

somewhere i did something a bit wrong and ctrl + down dows work always,i ll check it out tomorrow

Double dot extensions

Seems to have issues with ".tar.gz" and so on extensions?

FIle formats not supported

Following file formats are currently not supported:

• .docx
• .csv
• .pptx
• .ppt
• .odp

Adding more file types

I open this issue as I would present a few design a file type i made and may post more of them in the future.
This issue is meant to collect every proposition instead of opening an issue for each

double dot extensions.

libwhatever.so.1 .so.+ version, not showing any profile\icon