57 lines
2.0 KiB
Markdown
57 lines
2.0 KiB
Markdown
# LF
|
|
|
|
[Google Groups](https://groups.google.com/forum/#!forum/lf-fm)
|
|
|
|
[](https://travis-ci.org/gokcehan/lf)
|
|
[](https://gitter.im/lf-fm/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
> 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.
|
|
|
|
|
|
|
|
|
|
## 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](https://github.com/gokcehan/lf/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.
|
|
|
|
See [tutorial](doc/tutorial.md) for an introduction to the configuration.
|
|
|
|
See [reference](doc/reference.md) for the list of keys, options and variables with their default values.
|
|
|
|
See [etc](etc) directory to integrate `lf` to your shell or editor.
|