lf/README.md

# LF

[Google Groups](https://groups.google.com/forum/#!forum/lf-fm)

[![Build Status](https://travis-ci.org/gokcehan/lf.svg?branch=master)](https://travis-ci.org/gokcehan/lf)
[![Join the chat at https://gitter.im/lf-fm/Lobby](https://badges.gitter.im/lf-fm/Lobby.svg)](https://gitter.im/lf-fm/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![GoDoc](https://godoc.org/github.com/gokcehan/lf?status.svg)](https://godoc.org/github.com/gokcehan/lf)

> 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](http://i.imgur.com/DaTUenu.png)
![singlecol-screenshot](http://i.imgur.com/p95xzUj.png)

## Features

- Single binary without any runtime dependencies (except for terminfo database)
- Fast startup and low memory footprint (due to native code and static binaries)
- Server/client architecture to share file selection between multiple instances
- Custom commands as shell commands
- Sync (waiting and non-waiting) and async commands
- Fully customizable keybindings
- Preview filtering (for source highlight, archives, pdfs/images as text etc.)

## Non-Features

- Tabs or windows (handled by the window manager or the terminal multiplexer)
- Built-in pager (handled by your pager of choice)
- Image previews (cool but no standard available)
- Periodic refresh (use explicit renew instead)

## May-Futures

- Bookmarks
- Colorschemes

## 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.

Run `lf -help` to see command line options.

Run `lf -doc` to see the [documentation](https://godoc.org/github.com/gokcehan/lf).

See [etc](etc) directory to integrate `lf` to your shell or editor.
An example configuration file can also be found in this directory.
initial commit 2016-08-13 12:49:04 +00:00			`# LF`

add link to google groups 2016-09-04 13:09:09 +00:00			`[Google Groups](https://groups.google.com/forum/#!forum/lf-fm)`

add travis CI 2016-09-01 15:07:49 +00:00			`[![Build Status](https://travis-ci.org/gokcehan/lf.svg?branch=master)](https://travis-ci.org/gokcehan/lf)`
organize badges 2016-09-04 13:32:27 +00:00			`[![Join the chat at https://gitter.im/lf-fm/Lobby](https://badges.gitter.im/lf-fm/Lobby.svg)](https://gitter.im/lf-fm/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)`
point to the new documentation in the readme 2016-09-14 23:26:05 +00:00			`[![GoDoc](https://godoc.org/github.com/gokcehan/lf?status.svg)](https://godoc.org/github.com/gokcehan/lf)`
add travis CI 2016-09-01 15:07:49 +00:00
shorten warning in readme 2016-09-04 13:33:54 +00:00			`> This is a work in progress. Use at your own risk.`
initial commit 2016-08-13 12:49:04 +00:00
			`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](http://i.imgur.com/DaTUenu.png)`
			`![singlecol-screenshot](http://i.imgur.com/p95xzUj.png)`

			`## Features`

update features 2016-10-01 22:10:31 +00:00			`- Single binary without any runtime dependencies (except for terminfo database)`
			`- Fast startup and low memory footprint (due to native code and static binaries)`
			`- Server/client architecture to share file selection between multiple instances`
			`- Custom commands as shell commands`
			`- Sync (waiting and non-waiting) and async commands`
			`- Fully customizable keybindings`
			`- Preview filtering (for source highlight, archives, pdfs/images as text etc.)`
initial commit 2016-08-13 12:49:04 +00:00
			`## Non-Features`

update features 2016-10-01 22:10:31 +00:00			`- Tabs or windows (handled by the window manager or the terminal multiplexer)`
			`- Built-in pager (handled by your pager of choice)`
			`- Image previews (cool but no standard available)`
			`- Periodic refresh (use explicit renew instead)`
initial commit 2016-08-13 12:49:04 +00:00
			`## May-Futures`

update features 2016-10-01 22:10:31 +00:00			`- Bookmarks`
			`- Colorschemes`
initial commit 2016-08-13 12:49:04 +00:00
			`## Installation`

add releases link to readme 2016-09-06 21:57:17 +00:00			`See [releases](https://github.com/gokcehan/lf/releases) for pre-built binaries.`
initial commit 2016-08-13 12:49:04 +00:00
cleanup 2016-09-06 22:47:08 +00:00			`If you like to build from the source:`
initial commit 2016-08-13 12:49:04 +00:00
add releases link to readme 2016-09-06 21:57:17 +00:00			`go get -u github.com/gokcehan/lf`
initial commit 2016-08-13 12:49:04 +00:00
			`## Usage`

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

point to the new documentation in the readme 2016-09-14 23:26:05 +00:00			Run `lf -help` to see command line options.
initial commit 2016-08-13 12:49:04 +00:00
point to the new documentation in the readme 2016-09-14 23:26:05 +00:00			Run `lf -doc` to see the [documentation](https://godoc.org/github.com/gokcehan/lf).
initial commit 2016-08-13 12:49:04 +00:00
			See [etc](etc) directory to integrate `lf` to your shell or editor.
point to the new documentation in the readme 2016-09-14 23:26:05 +00:00			`An example configuration file can also be found in this directory.`