🐿️ lis -- Modern ls alternative on lis

About

Tue, 09 Jun 2026 00:00:00 +0000

ℹ️ About lis
#

lis was created as an educational project to explore Rust and the open-source software development lifecycle.

👨‍💼 Developers
#

Haruaki Tamada (tamada)

🎃 Logo
#

The lis icon was created by yukyik and is distributed on Flaticon.

CLI Usage

Tue, 09 Jun 2026 00:00:00 +0000

💻 lis CLI Tool
#

The lis command-line interface provides a powerful way to list directory entries.

🚀 Usage
#

lis [OPTIONS] [PATH]

⚙️ Options
#

Option	Description
`-l`, `--long`	Display in long format with details (permissions, owner, size, etc.).
`--sort <SORT>`	Sort entries by `name` (default), `time`, `size`, or `extension`.
`--reverse`	Reverse the sort order.
`-a`, `--all`	List all entries, including hidden files, while respecting `.gitignore`.
`-A`, `--whole-all`	List all entries, including hidden files, ignoring `.gitignore`.
`--icon`	Display icons for each entry (requires Nerd Font).
`--format <FORMAT>`	Specify output format: `plain` (default), `csv`, `json`, or `yaml`.
`-R`, `--recursive`	List entries recursively.

🌟 Examples
#

Long format with icons
#

Show detailed information along with file icons.

Features

Tue, 09 Jun 2026 00:00:00 +0000

🚀 Features
#

lis comes with a variety of features designed to improve your directory listing experience.

Git Integration: Automatically shows Git status for files and directories (A, M, D, R, T).
Icons: Beautiful icons for different file types (requires a Nerd Font).
Multiple Formats: Support for Plain text, CSV, JSON, and YAML output.
Sorting: Sort by Name, Time, Size, or Extension.
Filtering: Respects .gitignore by default when listing hidden files.
Recursive: Supports deep recursive directory listing.
Colorized Output: High-quality colorized output based on the LS_COLORS environment variable.

🛡️ Unique to `lis`
#

The following features are unique to lis and are not typically found in the traditional ls command:

Library Usage

Tue, 09 Jun 2026 00:00:00 +0000

📖 Library Usage
#

lis can be integrated as a library into your own Rust projects.

🛠️ Basic Usage
#

To list entries in the current directory:

use lis::Lis;
use std::path::PathBuf;

fn main() {
    let entries = Lis::new(PathBuf::from(".")).list();

    for entry in entries {
        println!("{:<10} {}", entry.mode, entry.name);
    }
}

🏗️ Using LisBuilder
#

For more control over the listing behavior, use LisBuilder.

🐿️ lis -- Modern ls alternative on lis

About

ℹ️ About lis #

👨‍💼​ Developers #

🎃 Logo #

CLI Usage

💻 lis CLI Tool #

🚀 Usage #

⚙️ Options #

🌟 Examples #

Long format with icons #

Features

🚀 Features #

🛡️ Unique to lis #

Library Usage

📖 Library Usage #

🛠️ Basic Usage #

🏗️ Using LisBuilder #

ℹ️ About lis
#

👨‍💼 Developers
#

🎃 Logo
#

💻 lis CLI Tool
#

🚀 Usage
#

⚙️ Options
#

🌟 Examples
#

Long format with icons
#

🚀 Features
#

🛡️ Unique to `lis`
#

📖 Library Usage
#

🛠️ Basic Usage
#

🏗️ Using LisBuilder
#