当前位置：首页 > news >正文

files-to-prompt 简介

news 2025/11/10 9:54:17

files-to-prompt 简介

文章目录

- files-to-prompt 简介
- - 🔍 什么是files-to-prompt？
  - 🎯 主要用途是什么？
  - 🛠️ 如何使用它？
  - - 安装与基本使用
    - 常用选项和技巧
  - 💎 总结

cover

“files-to-prompt”是一个非常实用的命令行工具，专门用于将多个文件的内容合并输出，尤其适合作为大型语言模型（LLM）的提示词输入。
这个工具是由Simon Willison开发的。他是一位知名的软件开发者和作家，尤其在使用AI模型辅助开发方面有很多实践和分享。这个工具正是他为高效使用大模型而创建的。

下面是这个工具的详细介绍。

🔍 什么是files-to-prompt？

files-to-prompt是一个Python编写的命令行工具。它的核心功能非常简单：读取你指定的一个或多个文件或目录，将它们的内容（和名称）拼接起来，输出到一个单一的文本流中。

这在需要将大量代码或文档上下文传递给AI模型时特别有用，因为AI模型通常只有一个文本输入框。手动复制粘贴每个文件的内容非常繁琐，而这个工具能让你通过一行命令就完成这个任务。

🎯 主要用途是什么？

简单来说，files-to-prompt是一个连接你的本地文件系统与AI模型的“桥梁”。它的主要用途体现在：

为AI模型准备上下文：当你希望AI帮你分析项目代码、重构某个功能、或者解释一段错误日志时，你需要把相关的文件内容给它看。这个工具能快速帮你把所有相关内容打包。
简化工作流：无需在IDE和浏览器之间来回切换、手动复制粘贴代码，直接在命令行中操作，高效且不易出错。
支持复杂项目结构：它可以处理整个目录，让你能轻松地将一个完整的、由多个文件组成的项目送入AI模型。
无缝集成：作为命令行工具，它可以和其他的Unix工具（如find, grep）完美配合，构建出非常强大的文件处理流水线。

🛠️ 如何使用它？

安装与基本使用

首先，你需要通过Python的包管理器pip来安装它：

pip install files-to-prompt

安装完成后，你就可以使用 files-to-prompt 命令了。

基本语法如下：

files-to-prompt [选项] <文件或目录路径1> <文件或目录路径2> ...

举个例子：
假设你的项目里有 app.py 和 utils.py 两个文件，你想把它们的内容一起发给AI。

files-to-prompt app.py utils.py

执行这个命令，终端就会打印出两个文件的路径和它们全部内容的组合。

常用选项和技巧

基本的文件列表输出可能还不够高效，files-to-prompt 提供了一些非常实用的选项：

处理整个目录：使用.代表当前目录，或者指定一个目录路径。

# 处理当前目录下的所有文件（不包括隐藏文件）
files-to-prompt .# 处理一个特定的目录
files-to-prompt path/to/your/project

包含隐藏文件：使用 --include-hidden 选项。在Unix系统中，以点开头的文件（如 .gitignore）默认是隐藏的，这个选项会把它们也包含进来。
以Markdown格式输出：使用 -m 或 --markdown 选项。这个功能非常推荐！它会把每个文件的内容放在Markdown的代码块中，并注明文件名。这样当你把内容粘贴到支持Markdown的AI聊天界面（如ChatGPT）时，代码会拥有更好的语法高亮，且AI模型也更容易区分不同文件。
```
files-to-prompt -m app.py utils.py
```
输出效果类似于：
```
# app.py
```python
[app.py的内容]
```# utils.py
```python
[utils.py的内容]
```
```
与其他命令配合（管道）：这是最强大的功能之一。我们可以使用其他命令（如 find）来筛选文件，然后通过管道 | 把文件列表传给 files-to-prompt。
```
# 查找所有扩展名为.py的文件，并交给files-to-prompt处理
find . -name "*.py" | files-to-prompt# 结合Markdown输出
find . -name "*.py" | files-to-prompt -m
```