1 个不稳定版本
0.1.0 | 2024年8月5日 |
---|
#184 在 文件系统
141 每月下载量
8KB
80 行
DTC dir-tree-cli
dir-tree-cli
是一个用Rust编写的命令行工具,以树形格式显示指定目录的文件夹结构。它帮助用户可视化文件和子目录的组织结构,使导航和了解项目结构变得更加容易。
功能
- 递归列出所有文件和子目录。
- 忽略指定的文件夹(例如,
node_modules
,.git
等),以保持输出整洁。 - 以视觉上吸引人的树状格式显示文件夹结构。
安装
要安装 dir-tree-cli
,您的机器上需要安装Rust和Cargo。如果您还没有安装Rust,可以按照官方Rust网站上的说明进行操作。
安装Rust后,您可以克隆存储库并构建项目
git clone https://github.com/yourusername/dir-tree-cli.git
cd dir-tree-cli
cargo build --release
编译的执行文件将位于 target/release
目录中。
用法
要在终端中使用 dir-tree-cli
,请运行以下命令
./target/release/dtc <path>
将 <path>
替换为您想可视化的目录路径。例如
./target/release/dtc /path/to/your/directory
示例
./target/release/dtc /home/user/projects
输出
projects
├── dir-tree-cli
│ ├── src
│ ├── Cargo.toml
│ └── README.md
├── another-project
│ ├── src
│ └── Cargo.toml
└── .git
忽略的文件夹
以下文件夹在显示文件夹结构时默认被忽略
node_modules
target
.next
.ssh
coverage
.git
如果您想更改被忽略的文件夹,可以修改源代码中的 IGNORED_FOLDERS
常量。
贡献
欢迎贡献!如果您有改进建议或新功能建议,请随时提交问题或提交拉取请求。
- 复制存储库。
- 创建一个新分支(
git checkout -b feature-branch
)。 - 进行更改并提交它们(
git commit -m '添加新功能'
)。 - 推送到分支(
git push origin feature-branch
)。 - 打开拉取请求。
许可证
本项目采用MIT许可证。有关详细信息,请参阅LICENSE文件。
作者
Aurimar Lopes - [email protected]
此README是用AI编写的...它提供了您项目的清晰概述,使用户易于理解其功能和用法。
依赖项
~1.7–2.7MB
~52K SLoC