103 lines
3.3 KiB
Markdown
103 lines
3.3 KiB
Markdown
# LF
|
|
|
|
[Google Groups](https://groups.google.com/forum/#!forum/lf-fm)
|
|
| [Wiki](https://github.com/gokcehan/lf/wiki)
|
|
| [#lf](https://web.libera.chat/#lf) (on Libera.Chat)
|
|
| [#lf:matrix.org](https://matrix.to/#/#lf:matrix.org) (with IRC bridge)
|
|
|
|
[](https://goreportcard.com/report/github.com/gokcehan/lf)
|
|
[](https://pkg.go.dev/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 with a heavy inspiration from ranger file manager.
|
|
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.
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
- Cross-platform (Linux, MacOS, BSDs, Windows)
|
|
- Single binary without any runtime dependencies
|
|
- Fast startup and low memory footprint due to native code and static binaries
|
|
- Asynchronous IO operations to avoid UI locking
|
|
- Server/client architecture and remote commands to manage multiple instances
|
|
- Extendable and configurable with shell commands
|
|
- Customizable keybindings (vi and readline defaults)
|
|
- A reasonable set of other features (see the [documentation](https://pkg.go.dev/github.com/gokcehan/lf))
|
|
|
|
## Non-Features
|
|
|
|
- Tabs or windows (better handled by window manager or terminal multiplexer)
|
|
- Builtin pager/editor (better handled by your pager/editor of choice)
|
|
|
|
## Installation
|
|
|
|
See [packages](https://github.com/gokcehan/lf/wiki/Packages) for community maintained packages.
|
|
|
|
See [releases](https://github.com/gokcehan/lf/releases) for pre-built binaries.
|
|
|
|
Building from the source requires [Go](https://go.dev/).
|
|
|
|
On Unix (Go version < 1.17):
|
|
|
|
```bash
|
|
env CGO_ENABLED=0 GO111MODULE=on go get -u -ldflags="-s -w" github.com/gokcehan/lf
|
|
```
|
|
|
|
On Unix (Go version >= 1.17):
|
|
|
|
```bash
|
|
env CGO_ENABLED=0 go install -ldflags="-s -w" github.com/gokcehan/lf@latest
|
|
```
|
|
|
|
On Windows `cmd` (Go version < 1.17):
|
|
|
|
```cmd
|
|
set CGO_ENABLED=0
|
|
set GO111MODULE=on
|
|
go get -u -ldflags="-s -w" github.com/gokcehan/lf
|
|
```
|
|
|
|
On Windows `cmd` (Go version >= 1.17):
|
|
|
|
```cmd
|
|
set CGO_ENABLED=0
|
|
go install -ldflags="-s -w" github.com/gokcehan/lf@latest
|
|
```
|
|
|
|
On Windows `powershell` (Go version < 1.17):
|
|
|
|
```powershell
|
|
$env:CGO_ENABLED = '0'
|
|
$env:GO111MODULE = 'on'
|
|
go get -u -ldflags="-s -w" github.com/gokcehan/lf
|
|
```
|
|
|
|
On Windows `powershell` (Go version >= 1.17):
|
|
|
|
```powershell
|
|
$env:CGO_ENABLED = '0'
|
|
go install -ldflags="-s -w" github.com/gokcehan/lf@latest
|
|
```
|
|
|
|
## 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://pkg.go.dev/github.com/gokcehan/lf).
|
|
|
|
See [etc](etc) directory to integrate `lf` to your shell and/or editor.
|
|
Example configuration files along with example colors and icons files can also be found in this directory.
|
|
|
|
See [integrations](https://github.com/gokcehan/lf/wiki/Integrations) to integrate `lf` to other tools.
|
|
|
|
See [tips](https://github.com/gokcehan/lf/wiki/Tips) for more examples.
|
|
|
|
## Contributing
|
|
|
|
See [contributing](https://github.com/gokcehan/lf/wiki/Contributing) for guidelines.
|