README
¶
Keep those files organized
About The Project
A terminal based file manager
Built With
Installation
Curl
curl -sfL https://raw.githubusercontent.com/mistakenelf/fm/main/install.sh | sh
Go
go install github.com/mistakenelf/fm@latest
AUR
Install through the Arch User Repository with your favorite AUR helper. There are currently two possible packages:
- fm-git: Builds the package from the main branch
paru -S fm-git
- fm-bin: Uses the github release package
paru -S fm-bin
Features
- File icons (requires nerd font)
- Layout adjusts to terminal resize
- Syntax highlighting for source code with customizable themes using styles from chroma (dracula, monokai etc.)
- Render pretty markdown
- Mouse support
- Themes (
default,gruvbox,nord) - Render PNG, JPG and JPEG as strings
- Colors adapt to terminal background, for syntax highlighting to work properly on light/dark terminals, set the appropriate theme flags
- Open selected file in editor set in EDITOR environment variable
- Copy selected directory items path to the clipboard
- Read PDF files
Themes
Default
Gruvbox
Nord
Usage
fmwill start fm in the current directoryfm updatewill update fm to the latest versionfm --start-dir=/some/start/dirwill start fm in the specified directoryfm --selection-path=/tmp/tmpfilewill write the selected items path to the selection path when pressing E and exit fmfm --start-dir=/some/dirstart fm at a specific directoryfm --enable-logging=truestart fm with logging enabledfm --pretty-markdown=truerender markdown using glamour to make it look nicefm --theme=defaultset the theme of fmfm --show-icons=falseset whether to show icons or notfm --syntax-theme=draculasets the syntax theme to render code with
Local Development
Follow the instructions below to get setup for local development
- Clone the repo
git clone https://github.com/mistakenelf/fm
- Run
make
- Build a binary
make build
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package code implements a code bubble which renders syntax highlighted source code based on a filename.
|
Package code implements a code bubble which renders syntax highlighted source code based on a filename. |
|
Package csv implements a csv bubble which renders a table with the content of the csv.
|
Package csv implements a csv bubble which renders a table with the content of the csv. |
|
Package filesystem is a collection of various different filesystem helper functions.
|
Package filesystem is a collection of various different filesystem helper functions. |
|
Package help implements a help bubble which can be used to display help information such as keymaps.
|
Package help implements a help bubble which can be used to display help information such as keymaps. |
|
Package image provides an image bubble which can render images as strings.
|
Package image provides an image bubble which can render images as strings. |
|
internal
|
|
|
Package markdown provides an markdown bubble which can render markdown in a pretty manor.
|
Package markdown provides an markdown bubble which can render markdown in a pretty manor. |
|
Package pdf provides an pdf bubble which can render pdf files as strings.
|
Package pdf provides an pdf bubble which can render pdf files as strings. |
|
Package statusbar provides an statusbar bubble which can render four different status sections
|
Package statusbar provides an statusbar bubble which can render four different status sections |
Click to show internal directories.
Click to hide internal directories.