Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/the-noah/lsfp

Cross-platform alternative to ls, specifically designed for programmers
https://github.com/the-noah/lsfp

cargo cli cli-app cli-tool contributions-welcome crate cross-platform rust rust-lang tool unix unix-command

Last synced: 4 months ago
JSON representation

Cross-platform alternative to ls, specifically designed for programmers

Host: GitHub
URL: https://github.com/the-noah/lsfp
Owner: The-Noah
License: mit
Created: 2020-12-21T21:10:16.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-07-16T04:57:22.000Z (7 months ago)
Last Synced: 2024-10-01T17:08:49.651Z (4 months ago)
Topics: cargo, cli, cli-app, cli-tool, contributions-welcome, crate, cross-platform, rust, rust-lang, tool, unix, unix-command
Language: Rust
Homepage: https://crates.io/crates/lsfp
Size: 185 KB
Stars: 5
Watchers: 3
Forks: 3
Open Issues: 5
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # lsfp

[![GitHub license](https://img.shields.io/github/license/The-Noah/lsfp.svg)](LICENSE)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/The-Noah/lsfp?sort=semver)](https://github.com/The-Noah/lsfp/releases)

[![CI](https://github.com/The-Noah/lsfp/workflows/CI/badge.svg)](https://github.com/The-Noah/lsfp/actions?query=workflow%3ACI)

[![Built with love by devs for devs](https://img.shields.io/badge/Built%20with%20%F0%9F%92%96%20by%20developers-for%20developers-blue)](https://github.com/The-Noah/lsfp/graphs/contributors)

Cross-platform alternative to **ls**, specifically designed **f**or **p**rogrammers

> My blog post about lsfp: [blog.noahdunbar.com/how-lsfp-was-created](https://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](https://github.com/The-Noah/lsfp/blob/master/src/themes/README.md)

- 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](https://github.com/The-Noah/lsfp/releases) 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:

```sh

cargo install lsfp

```

### Git

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

```sh

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

cd lsfp

```

To build and install it on your system, run:

```sh

cargo install --path .

```

Now you can use `lsfp` from anywhere!

## Usage

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

```sh

lsfp --help

```

## Contributing

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

## Contributors

[](https://github.com/The-Noah)

[](https://github.com/MattPlays)

[](https://github.com/HipyCas)

## License

Licensed under the [MIT license](LICENSE).