lla - Advanced File Listing Utility

lla is a high-performance, extensible alternative to the traditional ls command, written in Rust. It offers enhanced functionality, customizable output, and a plugin system for extended capabilities.

Features

• Efficient file listing: Optimized for speed, even in large directories
• Multiple view modes:
  • Default view
  • Long format (-l)
  • Tree view (-t)
  • Recursive listing (-R)
• Advanced sorting:
  • Alphabetical (default)
  • File size (-s size)
  • Modification date (-s date)
• Flexible filtering: Filter by filename or extension (-f, --filter)
• Customizable recursion: Set maximum depth for subdirectory traversal (-d, --depth)
• Extensible plugin system: Develop and integrate custom functionality

Installation

From crates.io

cargo install lla

For NetBSD users

pkgin install lla

(we see you, netbsd. we appreciate you.)

how to play

lla [OPTIONS] [DIRECTORY]

Core Options

• -l, --long: Use long listing format
• -R, --recursive: List subdirectories recursively
• -t, --tree: Display files in a tree structure
• -s, --sort <CRITERIA>: Sort by "name", "size", or "date"
• -f, --filter <PATTERN>: Filter files by name or extension
• -d, --depth <DEPTH>: Set maximum recursion depth

Plugin Management

• --enable-plugin <NAME>: Enable a specific plugin
• --disable-plugin <NAME>: Disable a specific plugin
• --plugins-dir <PATH>: Specify custom plugins directory

Utility Commands

• lla install: Install plugins
  • --github <URL>: Install from a GitHub repository
  • --dir <PATH>: Install from a local directory
• lla list-plugins: Display all available plugins
• lla init: Initialize configuration file

Configuration

lla uses a TOML configuration file located at ~/.config/lla/config.toml. Initialize with default settings:

lla init

Example configuration:

default_sort = "name"
default_format = "default"
enabled_plugins = ["git_status", "file_hash"]
plugins_dir = "/home/user/.config/lla/plugins"
default_depth = 3

Install Plugins

You can instll plugins from a local directory or from a GitHub repository.

From GitHub

lla install --github <github_url>

From Local Directory

lla install --dir <path>

You can install official plugins by running the following command:

lla install --github https://github.com/triyanox/lla/tree/main

Plugin Development

Develop custom plugins to extend lla's functionality. Plugins are dynamic libraries that implement the Plugin trait from the lla_plugin_interface crate.

Plugin Structure

1. Create a new Rust library:

   cargo new --lib my_lla_plugin
   

2. Add dependencies to Cargo.toml:

   [dependencies]
   lla_plugin_interface = { path = "/path/to/lla_plugin_interface" }
   
   [lib]
   crate-type = ["cdylib"]
   

3. Implement the Plugin trait:

use lla_plugin_interface::{Plugin, DecoratedEntry, EntryDecorator};

pub struct MyPlugin;

impl Plugin for MyPlugin {
    fn name(&self) -> &'static str {
        "my_plugin"
    }

    fn version(&self) -> &'static str {
        env!("CARGO_PKG_VERSION")
    }

    fn description(&self) -> &'static str {
        "My custom lla plugin"
    }
}

impl EntryDecorator for MyPlugin {
    fn decorate(&self, entry: &mut DecoratedEntry) {
        // Add custom fields or modify entry
    }

    fn format_field(&self, entry: &DecoratedEntry, format: &str) -> Option<String> {
        // Return formatted string for display
    }

    fn supported_formats(&self) -> Vec<&'static str> {
        vec!["default", "long", "tree"]
    }
}

lla_plugin_interface::declare_plugin!(MyPlugin);

4. Build your plugin:

   cargo build --release
   

5. Install the plugin:

   lla install --dir /path/to/my_lla_plugin
   

Plugin Interface

The lla_plugin_interface crate provides the following key components:

• Plugin trait: Core interface for plugin functionality
• EntryDecorator trait: Methods for decorating and formatting file entries
• DecoratedEntry struct: Represents a file entry with metadata and custom fields

Refer to the lla_plugin_interface documentation for detailed API information.

Examples

# Long format, sorted by size, showing only .rs files, max depth 3
lla -ls size -f .rs -d 3

# enable git status plugin
lla --enable-plugin git_status

# disanble git status plugin
lla --disable-plugin git_status

Contributing

Contributions are welcome! Please feel free to submit pull requests, report bugs, and suggest features.

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

License

This project is licensed under the MIT License - see the LICENSE file for details.