Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/salman-abedin/faint
Extensible TUI fuzzy file file explorer
https://github.com/salman-abedin/faint
fuzzy-matching fuzzy-search
Last synced: 3 months ago
JSON representation
Extensible TUI fuzzy file file explorer
- Host: GitHub
- URL: https://github.com/salman-abedin/faint
- Owner: salman-abedin
- License: gpl-2.0
- Created: 2020-09-07T00:14:50.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-08T09:13:57.000Z (about 2 years ago)
- Last Synced: 2024-07-11T01:10:38.903Z (4 months ago)
- Topics: fuzzy-matching, fuzzy-search
- Language: Shell
- Homepage:
- Size: 8.6 MB
- Stars: 95
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-github-stars - salman-abedin/faint - Extensible TUI fuzzy file file explorer (Shell)
README
# faint: Extensible TUI fuzzy file explorer
**faint** is a fuzzy file explorer for the CLI that supports various extensible features.
## Features
- ### Fuzzy Finding & Depth Searching.
- ### Custom Operations
- ### Custom Launch Behaviors
- ### Filters & Hidden Files
- ### Bookmarking
- ### Multiple Instances
## Dependencies
- [fzf](https://github.com/junegunn/fzf)
- [fd](https://github.com/sharkdp/fd)
- [xdotool](https://github.com/jordansissel/xdotool)
- `diff, sort, sed, pkill & awk`
- `setsid` (Optional; For better launching experience)
- [hulk](https://github.com/salman-abedin/alfred/blob/master/src/hulk) (Optional; For bulk moving/renaming)
## Installation
#### Git
```sh
git clone https://github.com/salman-abedin/faint.git && cd faint && make && sudo make install
```
#### AUR
```sh
yay -S --noconfirm faint
# Or
yay -S --noconfirm faint-git # Nightly
```
## Commands
| Command | Effect |
| -------------- | ------------------------------ |
| `faint` | Explore current directory |
| `faint ` | Explore specified directory |
| `faint -l` | Explore last visited directory |
## Functions
```sh
# Leaves on the last visited directory (Recommended as default)
faint(){
faint
read -r faint_last_dir < ~/.local/share/faint/FAINT_FINAL
cd "$faint_last_dir" || exit
}
```
## Default Bindings
### Navigation
| Key | Effect |
| ------- | --------------------------------------------------------- |
| `;` | `cd` into directory/launch file + resets query & position |
| `:` | Launches file without resetting the query & position |
| `,` | Changes directory backward |
| `enter` | Drops down to shell on the current directory |
| `esc` | Clears the query / quits the program |
| `tab` | Navigates down |
| `btab` | Navigates up |
### List
| Key | Effect |
| --- | ----------------------------- |
| `.` | Toggles filtered files visual |
| `>` | Toggles hidden files visual |
| `=` | Increases max depth |
| `-` | Decreases max depth |
| `_` | Resets max depth |
| `<` | Refreshes the list |
### Operations
| Key | Effect |
| ------- | --------------------------------------------- |
| `]` | Toggles mark down |
| `[` | Toggles mark up |
| `\` | Toggles mark All |
| `space` | Launches operations menu for the marked files |
### Bookmarks
| Key | Effect |
| --- | ---------------------------------------------------- |
| `'` | Launches bookmark browser / Remove selected bookmark |
| `"` | Adds current directory to bookmark list |
### Modifications
- Consult the `~/.config/faintrc` for all your modifications need
## Update
#### Git
```sh
cd faint
git pull rebase && sudo make install
```
#### AUR
```sh
yay -Syu --noconfirm
```
## Uninstallation
```sh
cd faint
sudo make uninstall
```
## Contributors
- [orhun](https://github.com/orhun) ( AUR package maintainer)
- [NICHOLAS85](https://github.com/NICHOLAS85)
---
## Shameful Plug
| Name | Description |
| ------------------------------------------------------- | ------------------------------- |
| [devour](https://github.com/salman-abedin/devour) | X11 window swallower |
| [bolt](https://github.com/salman-abedin/bolt) | The launcher wrapper |
| [uniblocks](https://github.com/salman-abedin/uniblocks) | The status bar wrapper |
| [tide](https://github.com/salman-abedin/tide) | Minimal Transmission CLI client |
| [puri](https://github.com/salman-abedin/puri) | Minimal URL launcher |
| [Magpie](https://github.com/salman-abedin/magpie) | The dotfiles |
| [Alfred](https://github.com/salman-abedin/alfred) | The scripts |
---
## Contact