Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/nore-dev/fman

TUI File Manager
https://github.com/nore-dev/fman

bubbletea console file filemanager go golang hacktoberfest terminal tui

Last synced: about 2 months ago
JSON representation

TUI File Manager

Host: GitHub
URL: https://github.com/nore-dev/fman
Owner: nore-dev
License: mit
Created: 2022-09-13T17:19:44.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2022-11-28T16:49:02.000Z (over 1 year ago)
Last Synced: 2024-03-27T01:43:22.677Z (3 months ago)
Topics: bubbletea, console, file, filemanager, go, golang, hacktoberfest, terminal, tui
Language: Go
Homepage:
Size: 2.77 MB
Stars: 312
Watchers: 4
Forks: 21
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

cli-apps - fman - TUI File Manager (<a name="file-manager"></a>File manager)
awesome-stars - nore-dev/fman - TUI File Manager (Go)
awesome-cli-apps - fman - TUI File Manager (<a name="file-manager"></a>File manager)

README

        

# FMAN

![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nore-dev/fman) ![GitHub](https://img.shields.io/github/license/nore-dev/fman) [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fnore-dev%2Ffman%2Fbadge%3Fref%3Dmain&style=flat)](https://actions-badge.atrox.dev/nore-dev/fman/goto?ref=main) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)

> **Awesome TUI File Manager**



[Features](#rocket-features) • [Installation](#zap-installation) • [Built With](#heart-built-with) • [Themes](#lipstick-themes) • [License](#pagefacingup-license)



![Preview](./assets/fman.gif)

## :rocket: Features

- Mouse Support

- Clean UI

- File Preview

- Syntax Highlighting

- Themes

- Copy Path to Clipboard

  > More on the way!!

> NOTE: If you want to edit your files in the terminal you must set the `EDITOR` environment variable to your favorite editor. Example: `vim, nvim, emacs...`

## :zap: Installation

### Pre-built Binaries

You can install pre-built binaries on the [releases](https://github.com/nore-dev/fman/releases) page

### GO

```

$ go install github.com/nore-dev/fman@latest

```

### NPM

```

$ npm i @nore-dev/fman

```

### Brew

```sh

brew install fman/tap/fman

```

## :keyboard: Keybindings

|      Key      |                Description                |

| :-----------: | :---------------------------------------: |

|  `q, Ctrl+C`  |           Exit from application           |

| `a, h, left`  |         Move to parent directory          |

| `d, l, right` |        Move to selected directory         |

| `s, j, down`  |             Move cursor down              |

|  `w, k, up`   |              Move cursor up               |

|    `enter`    |      Open file with default program       |

|      `c`      | Copy selected entry path to the clipboard |

|   `shift+g`   |        Move to the end of the list        |

|      `g`      |     Move to the beginning of the list     |

|      `m`      |        Toggle showing hidden Files        |

|    `~, .`     |        Move to the home directory         |

|  `shift+down`  |            Scroll preview down            |

|   `shift+up`   |             Scroll preview up             |

|      `?`      |                Toggle help                |

## :computer: CLI options

|    Key    |   Type   |        Values         | Default value |

| :-------: | :------: | :-------------------: | :-----------: |

| `--theme` | `string` | `dracula,brogrammer`  |   `dracula`   |

| `--icons` | `string` | `nerdfont,emoji,none` |  `nerdfont`   |

## :heart: Built With

Without these projects this project would not have existed at all.

- [Bubbletea](https://github.com/charmbracelet/bubbletea/)

- [Lipgloss](https://github.com/charmbracelet/lipgloss)

- [Bubblezone](https://github.com/lrstanley/bubblezone)

- [stickers](https://github.com/76creates/stickers)

- [Chroma](https://github.com/alecthomas/chroma)

- [go-arg](https://github.com/alexflint/go-arg)

## :lipstick: Themes

|                                                                              |                                                                              |

| :--------------------------------------------------------------------------: | :--------------------------------------------------------------------------: |

|      dracula      |  catppuccin |

|           nord          |      gruvbox      |

|  brogrammer |   everblush   |

## :busts_in_silhouette: CONTRIBUTING

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request

## :page_facing_up: LICENSE

Distributed under the MIT License. See `LICENSE` for more information.

## :question: Acknowledgments

Inspired by [knipferrc/fm](https://github.com/knipferrc/fm)