Fm

Keep those files organized

About The Project

A terminal based file manager

Built With

• Go
• bubbletea
• bubbles
• lipgloss
• Glamour
• Chroma
• Cobra

Installation

Curl

curl -sfL https://raw.githubusercontent.com/knipferrc/fm/main/install.sh | sh

Go

go install github.com/knipferrc/[email protected]

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

• Double pane layout
• File icons
• 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 themes in the config file
• 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

• fm will start fm in the current directory
• fm update will update fm to the latest version
• fm --start-dir=/some/start/dir will start fm in the specified directory
• fm --selection-path=/tmp/tmpfile will write the selected items path to the selection path when pressing E and exit fm

Navigation

Configuration

A config file will be generated when you first run fm. Depending on your operating system it can be found in one of the following locations:

• macOS: ~/Library/Application\ Support/fm/config.yml
• Linux: ~/.config/fm/config.yml
• Windows: C:\Users\me\AppData\Roaming\fm\config.yml

It will include the following default settings:

settings:
  borderless: false
  enable_logging: false
  pretty_markdown: true
  show_icons: true
  start_dir: .
theme:
  app_theme: default
  syntax_theme:
    dark: dracula
    light: pygments

Local Development

Follow the instructions below to get setup for local development

1. Clone the repo

git clone https://github.com/knipferrc/fm

2. Run

make

3. Build a binary

make build

Credit

• Thank you to this repo Yash-Handa/logo-ls for the icons