2016-08-13 12:49:04 +00:00
# LF
2017-11-02 20:38:02 +00:00
[Google Groups ](https://groups.google.com/forum/#!forum/lf-fm )
| [Wiki ](https://github.com/gokcehan/lf/wiki )
2017-11-04 16:06:47 +00:00
| [#lf ](https://webchat.freenode.net/?channels=lf ) (on Freenode)
| [#lf:matrix.org ](https://matrix.to/#/#lf:matrix.org ) (with IRC bridge)
2016-09-04 13:09:09 +00:00
2016-09-01 15:07:49 +00:00
[](https://travis-ci.org/gokcehan/lf)
2016-12-18 18:55:30 +00:00
[](https://goreportcard.com/report/github.com/gokcehan/lf)
2016-09-14 23:26:05 +00:00
[](https://godoc.org/github.com/gokcehan/lf)
2017-11-04 16:06:47 +00:00
[](https://gitter.im/lf-fm/Lobby?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2016-09-01 15:07:49 +00:00
2016-09-04 13:33:54 +00:00
> This is a work in progress. Use at your own risk.
2016-08-13 12:49:04 +00:00
2018-10-02 11:41:07 +00:00
> I will not have access to computers until 27th October 2018. Then hopefully I will come back and remove this notice. In the meantime, feel free to send PRs, create issues, or leave comments though I will not be able to respond.
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.
2017-09-08 20:46:31 +00:00
Some of the missing features are deliberately omitted since they are better handled by external tools.
2018-07-05 20:15:16 +00:00
See [faq ](https://github.com/gokcehan/lf/wiki/FAQ ) for more information and [tutorial ](https://github.com/gokcehan/lf/wiki/Tutorial ) for a gentle introduction with screencasts.
2016-08-13 12:49:04 +00:00
## Features
2016-10-01 22:35:57 +00:00
- Cross-platform (Linux, OSX, BSDs, Windows (partial))
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
2018-04-20 21:11:54 +00:00
- Configuration with shell commands
2017-09-08 20:46:31 +00:00
- Customizable keybindings (vi and readline defaults)
2016-10-01 22:10:31 +00:00
- Preview filtering (for source highlight, archives, pdfs/images as text etc.)
2016-08-13 12:49:04 +00:00
## Non-Features
2017-09-08 20:46:31 +00:00
- Tabs or windows (handled by window manager or terminal multiplexer)
- Builtin pager/editor (handled by your pager/editor of choice)
2016-10-01 22:10:31 +00:00
- Image previews (cool but no standard available)
2016-08-13 12:49:04 +00:00
## May-Futures
2018-06-16 13:59:41 +00:00
- Mouse control
2016-08-13 12:49:04 +00:00
## Installation
2016-09-06 21:57:17 +00:00
See [releases ](https://github.com/gokcehan/lf/releases ) for pre-built binaries.
2016-08-13 12:49:04 +00:00
2016-09-06 22:47:08 +00:00
If you like to build from the source:
2016-08-13 12:49:04 +00:00
2016-09-06 21:57:17 +00:00
go get -u github.com/gokcehan/lf
2016-08-13 12:49:04 +00:00
2016-10-08 10:24:18 +00:00
See [packages ](https://github.com/gokcehan/lf/wiki/Packages ) for community maintained packages.
2016-08-13 12:49:04 +00:00
## Usage
2018-06-16 13:59:41 +00:00
After the installation `lf` command should start the application in the current directory.
2016-09-14 23:26:05 +00:00
Run `lf -help` to see command line options.
2016-08-13 12:49:04 +00:00
2016-09-14 23:26:05 +00:00
Run `lf -doc` to see the [documentation ](https://godoc.org/github.com/gokcehan/lf ).
2016-08-13 12:49:04 +00:00
See [etc ](etc ) directory to integrate `lf` to your shell or editor.
2016-09-14 23:26:05 +00:00
An example configuration file can also be found in this directory.
2017-09-08 20:46:31 +00:00
2017-10-22 14:36:50 +00:00
See [integrations ](https://github.com/gokcehan/lf/wiki/Integrations ) to integrate `lf` to other tools.
2017-09-08 20:46:31 +00:00
See [tips ](https://github.com/gokcehan/lf/wiki/Tips ) for more examples.
## Contributing
See [contributing ](https://github.com/gokcehan/lf/wiki/Contributing ) for guidelines.
