lf/README.md

2.1 KiB

LF

Google Groups

Build Status Join the chat at https://gitter.im/lf-fm/Lobby GoDoc

This is a work in progress. Use at your own risk.

lf (as in "list files") is a terminal file manager written in Go. It is heavily inspired by ranger with some missing and extra features. Some of the missing features are deliberately ommited since it is better if they are handled by external tools.

multicol-screenshot singlecol-screenshot

Features

  • no external runtime dependencies (except for terminfo database)
  • fast startup and low memory footprint (due to native code and static binaries)
  • server/client architecture to share selection between multiple instances
  • custom commands as shell scripts (hence any other language as well)
  • sync (waiting and skipping) and async commands
  • fully customizable keybindings

Non-Features

  • tabs or windows (handled by the window manager or the terminal multiplexer)
  • built-in pager (handled by your pager of choice)

May-Futures

  • enchanced previews (image, pdf etc.)
  • bookmarks
  • colorschemes
  • periodic refresh
  • progress bar for file yank/delete paste

Installation

See releases for pre-built binaries.

If you like to build from the source:

go get -u github.com/gokcehan/lf

Usage

After the installation lf command should start the application in the current directory.

Run lf -help to see command line options.

Run lf -doc to see the documentation.

See etc directory to integrate lf to your shell or editor. An example configuration file can also be found in this directory.