Skip to content

The-Noah/lsfp

Repository files navigation

lsfp

GitHub license PRs Welcome GitHub release (latest SemVer) CI Built with love by devs for devs

Cross-platform alternative to ls, specifically designed for programmers

My blog post about lsfp: blog.noahdunbar.com/how-lsfp-was-created

Features

  • Basic features (same as ls)
  • License type detection
  • Colored files by extension
  • Collapsed build directories
  • Git integration
  • Extension-based customizable icons
  • Custom colors and icons with themes
  • No external dependencies

What is it?

Replacement for the ls command with a bunch of helpful tools for developers

What is it not?

  • A complete replacement for ls (maybe one day)
  • Complete (still WIP)

What will it be?

Hopefully so much more.

Installation

GitHub releases

Head directly to the releases page in this repository to install a fixed version of lsfp. You can find builds for MacOS, Linux and Windows, including a build with minimum features for Windows. Keep in mind, you will have to manually download again every update if you use GitHub releases.

Cargo

You can install directly using Cargo with:

cargo install lsfp

Git

To keep up-to-date with any changes, first clone this repo and cd into it:

git clone https://github.com/The-Noah/lsfp.git
cd lsfp

To build and install it on your system, run:

cargo install --path .

Now you can use lsfp from anywhere!

Usage

You can see an up-to-date usage by running the help command!

lsfp --help

Contributing

Contributions are welcome and much appreciated! For more details you can view the CONTRIBUTING.md file.

Contributors

License

Licensed under the MIT license.