Skip to main content

Crate maram

Crate maram 

Source
Expand description

maram - A modern, high-performance alternative to the Unix tree command

This crate provides a fast and feature-rich directory tree visualization tool with advanced features like per-nested-path limits, inline file sizes and line counts, filtering, sorting, search, and beautiful size distribution visualizations.

§Features

  • Fast filesystem traversal: Custom iterative walker with parallelism
  • Rich filtering: Regex patterns, size ranges, time-based filters
  • Beautiful output: ASCII/Unicode tree with colors and inline details
  • Size distribution: Visual charts showing disk usage by type/extension
  • Line counting: Fast parallel line counting for text files
  • Configuration: Support for .maram.toml config files
  • Cross-platform: Works on Linux, macOS, and Windows

Re-exports§

pub use cli::Args;
pub use config::Config;
pub use error::Error;
pub use error::Result;
pub use filters::FilterOptions;
pub use filters::SortBy;
pub use formatter::DistributionFormat;
pub use formatter::DistributionType;
pub use formatter::FormatOptions;
pub use formatter::OutputFormat;
pub use stats::FileStats;
pub use stats::TreeStats;
pub use walker::TreeEntry;
pub use walker::Walker;

Modules§

cli
Command-line interface argument parsing
config
Configuration file handling
error
Error types for maram
filters
Filtering, sorting, and search functionality
formatter
Output formatting and visualization
stats
File statistics and line counting
walker
Unified high-performance filesystem walker

Structs§

MaramOptions
High-level options for using maram as a library

Functions§

collect
Collect the structured entries without rendering
generate
Generate formatted output as a String for a given path and options
generate_to_writer
Generate formatted output to a writer for a given path and options
render
Render previously collected entries as a String using the given options
render_to_writer
Render previously collected entries to a writer using the given options
run_tree
Main entry point for the maram tree visualization
run_tree_output
Produce CLI output as a String (no stdout side-effects)