bestls 0.1.1

A fast and colorful Rust-based ls replacement CLI tool with JSON output and sorting options.
bestls-0.1.1 is not a library.

bestls

Rust License: MIT

A fast, colorful, and Rust-powered replacement for the traditional ls command.

bestls provides human-readable file listings in both pretty tables and JSON formats, with sorting and other modern CLI conveniences built for speed and usability.

âœĻ Features

  • ðŸŽĻ Colorful output - Beautiful colored tables for easy reading
  • 📊 Multiple formats - Output as tables, compact JSON, or pretty JSON
  • ⚡ Blazing fast - Parallel metadata fetching with Rayon
  • 📏 Human-readable - File sizes in KB, MB, GB format
  • 🔧 Flexible sorting - Sort by name, size, or modification date
  • ðŸŠķ Lightweight - Single binary with no external dependencies

ðŸ“Ķ Installation

From crates.io

cargo install bestls

From source

git clone https://github.com/MurtadaNazar/bestls.git
cd bestls
cargo build --release

The binary will be available at target/release/bestls.

🚀 Usage

Basic Commands

List current directory:

bestls

List specific directory:

bestls -p /path/to/directory

Output Formats

Pretty table (default):

bestls

Compact JSON:

bestls --json

Pretty formatted JSON:

bestls --json-pretty

Sorting Options

Sort by file size:

bestls -s size

Sort by modification date:

bestls -s date

Sort by name (default):

bestls -s name

Examples

# List home directory with size sorting
bestls -p ~ -s size

# Output current directory as pretty JSON
bestls --json-pretty

# List /etc directory sorted by modification date
bestls -p /etc -s date

Help

View all available options:

bestls --help

🛠ïļ Command Line Options

Option Short Description
--path -p Directory path to list
--sort -s Sort by: name, size, date
--json Output compact JSON format
--json-pretty Output pretty formatted JSON
--help -h Show help information
--version -V Show version information

🏗ïļ Building from Source

Prerequisites

  • Rust 1.85.0 or later
  • Cargo package manager

Build Steps

  1. Clone the repository:

    git clone https://github.com/MurtadaNazar/bestls.git
cd bestls

  2. Build the project:

    cargo build --release

  3. (Optional) Install globally:

    cargo install --path .

ðŸĪ Contributing

Contributions are welcome! Please feel free to submit issues, feature requests, or pull requests.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

This project is licensed under:

  • MIT License - See LICENSE for details

ðŸ‘Ļ‍ðŸ’ŧ Author

Murtaza Nazar

🔗 Links