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存儲庫中打開問題。