Dirt(r)ee

一个命令行工具，用于以树形结构打印指定目录的结构。

概述

Dirt(r)ee 是一个用 Rust 编写的命令行界面 (CLI) 工具，它生成目录结构的树形表示。它旨在提供文件和目录排列的清晰视图，支持包括隐藏文件、尊重 .gitignore 规则、可定制的间距和输出自定义等各种功能。

特性

• 树形生成：以树形格式可视表示目录结构。
• 隐藏文件：选项包括隐藏文件在树中。
• Git 忽略支持：尊重 .gitignore 文件以排除某些文件和目录。
• 自定义间距：允许自定义树结构中的间距以提高可读性。
• 剪贴板支持：提供将生成的树复制到剪贴板的选择。
• 输出自定义：为每行添加前缀并将树输出到指定的文件。
• 文件输出：提供将树结构写入文件的能力。
• 前缀自定义：允许为输出中的每行添加自定义前缀。
• 并行处理：利用 Rust 的 rayon crate 进行高效的目录遍历。

安装

您可以使用 cargo install 在自己的架构上编译 dirt(r)ee，或者在 M1 Macbook 上使用 Homebrew（基于 Intel 的 Mac 可能也能工作 - 我还没有尝试过。如果你尝试过，请告诉我！）

即将推出更多安装选项！

Homebrew (MacOS - M1)

brew tap calthejuggler/dirtee
brew install dirtee

Cargo 安装

要安装 Dirt-r-ee，您需要在您的系统上安装 Rust 和 Cargo。如果您尚未安装，可以按照 这里 的说明进行安装。

安装 Rust 和 Cargo 后，您可以使用 Cargo 安装 Dirt-r-ee

cargo install dirt-r-ee

用法

从命令行运行 Dirt-r-ee。基本命令结构如下

dirtee [OPTIONS] [PATH] # PATH defaults to the current directory

选项

• -d，--dir <DIRECTORY>：指定要打印的目录。默认为当前目录。
• -s，--spacer <SPACER>：自定义缩进空格。默认为四个空格。
• -，--include-hidden：在输出中包含隐藏文件和目录。
• -，--git-ignored：包含在.gitignore中指定的文件和目录。
• -，--copy：将输出复制到剪贴板而不是打印出来。
• -，--prefix <PREFIX>：向每行输出添加前缀。默认为 "- "。
• -，--out-file <FILE>：将输出写入指定的文件。
• -V，--version：显示版本信息。
• -，--help：显示帮助信息。