snap2txt

snap2txt

SNAP2TXT是一个Python实用程序，可捕获项目目录的结构和内容，并将其保存到文本文件中。它设计用于快速记录您项目的文件系统。

特征

• 完整捕获：记录整个文件结构和项目内容。
• 可自定义的过滤器：提供针对性扫描的忽略和白名单选项。
• 命令行接口：简单易用的命令行工具。

安装

使用PIP安装SNAP2TXT：

pip install snap2txt

注意：现在的安装将自动提供.il和.wl文件以及软件包。

用法

导航到您的项目目录并运行：

snap2txt

默认情况下，SNAP2TXT将扫描当前文件夹中的所有文件和目录，并生成一个称为project_contents.txt的输出文件。

找到.il和.wl文件

如果您需要查看SNAP2TXT的.il和.wl文件在系统上安装的位置（例如，自定义），请运行：

snap2txt --show-locations

这将打印到每个文件的完整路径，因此您可以根据需要打开或编辑它们。

可选标志

• --il ：使用.il中定义的忽略列表。
• --wl ：使用.wl中定义的白名单。

例子：

snap2txt --il

snap2txt --wl

配置

snap2txt尊重两个用于过滤的文件：

1. 忽略列表（ .il ） ：排除某些文件/目录。
2. 白名单（ .wl ） ：仅包括某些文件/目录。

默认情况下，snap2txt在包装目录中安装了基本.il和.wl 。为了量身定制项目的行为，您可以编辑这些文件或用自己的自定义规则替换它们。

提示：要快速找到安装这些文件的位置，请使用snap2txt --show-locations 。

示例.il文件

 node_modules/
*.log

示例.wl文件

 *.py
*.md

贡献

欢迎对Snap2TXT的贡献！请随意分叉存储库，进行更改并提交拉动请求。

执照

SNAP2TXT是根据MIT许可证许可的开源软件。

支持

有关支持，问题或反馈，请在GitHub存储库中打开问题。