跳转到主要内容

clip-files复件。

项目描述

Clip Files 📋📁

Build Coverage GitHub PyPI License Downloads Open Issues

介绍 clip-files - 一个简单而实用的命令行工具,用于收集具有特定扩展名的文件,使用它们的完整路径格式化它们,并将它们的内容复制到您的剪贴板,并带有用于GPT-4使用的标记计数!现在有了大量标记限制,这使得将整个项目粘贴到例如ChatGPT或Claude.ai变得非常简单。

[目录] 📚

:star2: 特性

  • 📋 收集具有特定扩展名的文件,并将它们的格式化内容复制到您的剪贴板。
  • 📁 为每个文件添加 # 文件: full_path_here 以提高清晰度。
  • 🧮 计算并显示使用的总标记数,与GPT-4标记化兼容。
  • 🔄 简单地处理和多个目录中的多个文件。

:books: 使用方法

要使用 clip-files,只需提供要搜索的目录和要收集的文件扩展名

clip-files --help

显示帮助信息

usage: clip-files [-h] [--initial-file INITIAL_FILE]
                  [--files FILES [FILES ...]]
                  [folder] [extension]

Collect files with a specific extension or specific files, format them for
clipboard, and count tokens.

positional arguments:
  folder                The folder to search for files.
  extension             The file extension to look for (e.g., .py, .txt).

options:
  -h, --help            show this help message and exit
  --initial-file INITIAL_FILE
                        A file containing initial instructions to prepend to
                        the clipboard content. Default is an empty string.
  --files FILES [FILES ...]
                        Specific file paths to include (e.g., --files
                        path/to/file1.py path/to/file2.md). If not provided,
                        all files with the specified extension are included.

clip-files 将遍历指定的文件夹,收集所需扩展名的文件,用它们的路径格式化,并将结果连同标记计数一起复制到您的剪贴板。

:hammer_and_wrench: 安装

要安装 clip-files,请使用pip

pip install clip-files

或者克隆仓库

git clone https://github.com/basnijholt/clip-files.git
cd clip-files
pip install .

或者直接下载脚本

wget https://raw.githubusercontent.com/basnijholt/clip-files/main/clip_files.py

并使用以下命令运行

python clip_files.py --help

:bulb: 示例

  • 收集 src 目录下的所有 .py 文件
clip-files src .py
  • 收集 documents 目录下的 .txt 文件并统计令牌数
clip-files documents .txt

有关更多示例和详细使用说明,请参阅文档。

:file_folder: 支持的文件类型

clip-files 支持任何文件类型,只要您提供正确的文件扩展名。常见示例包括

  • .py 用于 Python 文件
  • .txt 用于文本文件
  • .md 用于 Markdown 文件

:1234: 标记计数

clip-files 集成了 tiktoken 库,以计算类似于 GPT-4 的令牌数。这有助于了解使用 GPT-4 模型处理收集到的文本的成本和可行性。

脚本将在将格式化内容复制到剪贴板后显示总令牌数。

:heart: 支持和贡献

我们欢迎反馈和建议!如果您遇到任何问题或对改进有建议,请在我们的 GitHub 仓库中提交问题。我们也欢迎通过拉取请求的贡献。

祝您收集和剪辑愉快! 📋📁🎉

项目详情


下载文件

下载适合您平台的应用程序。如果您不确定选择哪一个,请了解有关 安装包 的更多信息。

源分布

clip_files-0.1.0.tar.gz (11.6 kB 查看哈希值)

上传日期

构建分布

clip_files-0.1.0-py3-none-any.whl (10.0 kB 查看哈希值)

上传日期 Python 3

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面