Fastruct - 快速项目结构查看工具

🌐 Language | 中文 | English

中文

Fastruct - 快速项目结构查看工具

Fastruct 是一个轻量级的命令行工具，用于以清晰的树状结构展示目录内容。它会根据文件类型使用不同颜色进行标记，并显示每个文件的完整路径。

识别的源代码文件类型

支持多种编程语言的源代码文件：

• C/C++ 家族 (.cpp, .c, .h, .hpp, .cc, .cxx)
• Python (.py)
• Java (.java)
• JavaScript (.js)
• Rust (.rs)
• Go (.go)
• Ruby (.rb)
• PHP (.php)
• Perl (.pl)
• Shell 脚本 (.sh, .bash, .zsh)

可执行文件识别

• Windows: 根据扩展名识别 (.exe, .bat, .cmd, .com)
• Unix-like: 根据文件权限识别（具有执行权限的文件）

安装方法

Arch Linux (AUR)

通过AUR来安装：

git clone https://aur.archlinux.org/fastruct.git
cd fastruct
makepkg -si

Windows

1. 从 Releases 页面下载最新版本的 fastruct-1.1.0-windows-x86_64.exe
2. 运行安装包，安装完成后，您需要设置PATH环境变量

从源码编译

依赖项

• C++17 兼容的编译器
• GCC/G++ （若可能，建议）

编译步骤

git clone https://github.com/GuitaristRin/fastruct.git
cd fastruct

# Linux
g++ -std=c++17 -o fastruct fastruct.cpp

# Windows (MinGW)
g++ -std=c++17 -o fastruct.exe fastruct.cpp

使用方法

基本语法

fastruct [选项]

选项说明

选项	描述
-d <路径>	指定起始目录（默认为当前目录）
--depth <数值>	设置最大递归深度（默认为无限）
--nopath	不在文件名后显示完整路径
--saveto [路径]	将输出保存到指定文件或目录（若不指定路径，则默认保存到当前目录下的 fastruct_output.txt）

使用示例

1. 查看当前目录结构

fastruct

输出示例：

project/
-subdir1
-file.txt /home/user/project/file.txt
-script.sh /home/user/project/script.sh
-main.cpp /home/user/project/main.cpp

2. 查看指定目录

fastruct -d /path/to/directory

3. 限制遍历深度

# 只显示当前目录内容（不进入子目录）
fastruct --depth 0

# 显示两层结构
fastruct --depth 2

4. 不显示完整路径

fastruct --nopath

输出示例（与之前相比，文件名后不再显示完整路径）：

project/
-subdir1
-file.txt
-script.sh
-main.cpp

5. 保存输出到文件

# 保存到当前目录下的默认文件 fastruct_output.txt
fastruct --saveto

# 保存到指定文件
fastruct --saveto /home/user/output.txt

# 保存到指定目录（会在该目录下生成 fastruct_output.txt）
fastruct --saveto /home/user/output_dir/

6. 组合使用

fastruct -d /home/user/projects --depth 3 --nopath --saveto ./struct.txt

输出格式说明

每一行代表一个文件或目录：

• 目录以 - 开头，后跟黄色的目录名
• 文件以 - 开头，后跟彩色文件名，最后（默认）是灰色的完整路径
• 当使用 --nopath 时，文件名后不再显示路径

深度预警与前缀显示

• 当目录层级深度超过 5 时，程序会发出警告并请求确认，防止因意外操作导致输出刷屏。
• 输出时，前缀的减号数量默认等于当前深度，但当实际深度超过警告阈值（5）时，超出的层级依然只显示 5 个减号，使结构更加清晰易读。

注意事项

• 在 Windows 上使用时，确保终端支持 ANSI 颜色代码（Windows 10 及以上版本默认支持）
• 如果遇到权限不足的目录，程序会显示错误信息并继续处理其他目录
• 符号链接会被跳过，以避免循环引用

许可证

本项目采用 MIT 许可证。详见 LICENSE 文件。

🔝 返回顶部

---

English

Fastruct - Fast Project Structure Viewer

Fastruct is a lightweight command-line tool for displaying directory contents in a clear tree structure. It uses different colors to mark files based on their type and displays the full path of each file.

Recognized Source Code File Types

Supports source code files for multiple programming languages:

• C/C++ Family (.cpp, .c, .h, .hpp, .cc, .cxx)
• Python (.py)
• Java (.java)
• JavaScript (.js)
• Rust (.rs)
• Go (.go)
• Ruby (.rb)
• PHP (.php)
• Perl (.pl)
• Shell Scripts (.sh, .bash, .zsh)

Executable File Detection

• Windows: Recognized by file extension (.exe, .bat, .cmd, .com)
• Unix-like: Recognized by file permissions (files with execute permission)

Installation

Arch Linux (AUR)

Install via AUR:

git clone https://aur.archlinux.org/fastruct.git
cd fastruct
makepkg -si

Windows

1. Download the latest fastruct-1.1.0-windows-x86_64.exe from the Releases page
2. Run setup, after the installation, you may need to add the PATH

Build from Source

Dependencies

• C++17 compatible compiler
• GCC/G++ (recommended if possible)

Build Steps

git clone https://github.com/GuitaristRin/fastruct.git
cd fastruct

# Linux
g++ -std=c++17 -o fastruct fastruct.cpp

# Windows (MinGW)
g++ -std=c++17 -o fastruct.exe fastruct.cpp

Usage

Basic Syntax

fastruct [options]

Options

Option	Description
-d <path>	Specify the starting directory (defaults to current directory)
--depth <value>	Set the maximum recursion depth (defaults to unlimited)
--nopath	Do not display the full path after the file name
--saveto [path]	Save output to a specified file or directory (if no path is given, defaults to fastruct_output.txt in the current directory)

Usage Examples

1. View Current Directory Structure

fastruct

Sample Output:

project/
-subdir1
-file.txt /home/user/project/file.txt
-script.sh /home/user/project/script.sh
-main.cpp /home/user/project/main.cpp

2. View a Specified Directory

fastruct -d /path/to/directory

3. Limit Traversal Depth

# Show only the current directory contents (do not enter subdirectories)
fastruct --depth 0

# Show two levels of structure
fastruct --depth 2

4. Hide Full Paths

fastruct --nopath

Sample Output (paths are no longer displayed after file names):

project/
-subdir1
-file.txt
-script.sh
-main.cpp

5. Save Output to a File

# Save to default file fastruct_output.txt in the current directory
fastruct --saveto

# Save to a specific file
fastruct --saveto /home/user/output.txt

# Save to a specific directory (fastruct_output.txt will be created there)
fastruct --saveto /home/user/output_dir/

6. Combined Usage

fastruct -d /home/user/projects --depth 3 --nopath --saveto ./struct.txt

Output Format Description

Each line represents a file or directory:

• Directory starts with - followed by the directory name in yellow
• File starts with - followed by the colored filename, ending (by default) with the full path in gray
• When --nopath is used, the path is omitted after the filename

Depth Warning and Prefix Display

• If the directory depth exceeds 5, the program issues a warning and asks for confirmation to prevent unintentional flooding of the output.
• The number of dashes in the prefix is normally equal to the current depth. However, once the actual depth exceeds the warning threshold (5), the prefix remains at 5 dashes for deeper levels, keeping the output clean and readable.

Notes

• When using on Windows, ensure your terminal supports ANSI color codes (Windows 10 and above support this by default)
• If a directory with insufficient permissions is encountered, the program will display an error message and continue processing other directories
• Symbolic links are skipped to avoid circular references

License

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

🔝 Back to top