📂 ls-f

ls-f is a modern, blazing-fast ls replacement. Originally a bash wrapper, it has been completely rewritten in Rust (v5.0.0) to provide superior performance, a native tree view, and zero runtime dependencies.

✨ Key Features

• 🚀 Performance: Native Rust implementation, matching GNU ls speed even with icons and colors.
• 🎨 Nerd Font Icons: Rich set of icons for hundreds of file types and extensions.
• 🌳 Tree View: Recursive tree visualization built-in via --tree.
• 🌿 Git Integration: View file git status (staged, modified, etc.) with --git.
• 🌈 ANSI Colors: Intelligent colorization for file types, permissions, and metadata.
• ⚙️ GNU Compatibility: Supports standard flags: -l, -a, -R, -h, -t, -S, -v, and more.
• 📦 Zero Dependencies: Single static binary—no Bash or Python required for the Rust version.

📊 Benchmarks (v5.0.0)

lsf is optimized for speed. Benchmarked against GNU ls (coreutils 9.1) with --color=always.

Icons add ~0% measurable overhead to lsf. See BENCHMARKS.md for details.

🚀 Installation

Prerequisites

• A Nerd Font must be set in your terminal for icons to render.

1. Build from Source (Rust - Recommended)

The Rust version (v5.0.0) provides the best performance and features.

git clone https://github.com/swadhinbiswas/ls-f.git
cd ls-f
make install  # Installs to /usr/local/bin

Or via cargo: cargo install --path .

📖 Usage

Simply use lsf where you would use ls.

lsf              # Grid view with icons
lsf -la          # Long format, hidden files
lsf --tree       # Recursive tree view
lsf --git        # Show git status indicators
lsf --depth 2    # Limit tree/recursive depth

Setting up the Alias

Add this to your shell profile (.bashrc, .zshrc, or .config/fish/config.fish):

alias ls='lsf'

🔧 Troubleshooting

• Icons look like boxes? You need a Nerd Font. Check terminal font settings.
• Command not found? Ensure /usr/local/bin or ~/.local/bin is in your $PATH.
• Colors missing? Ensure your terminal supports ANSI colors. Try lsf --color=always.

Detailed guides:

• Installation Guide
• Troubleshooting Guide
• Configuration (Legacy)

🤝 Contributing

Contributions are welcome!

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

💖 Support the Project

If you find ls-f helpful, consider supporting its development:

• GitHub Sponsors: swadhinbiswas
• Binance Pay / Crypto: [email protected]

Recent Sponsors

• Catgle

📄 License

Distributed under the MIT License. See LICENSE for details.

Created by swadhinbiswas