Skip to content

选取你的项目文件,整理为一个适合大语言模型(LLM)提示的文本摘要文档(markdown)

Notifications You must be signed in to change notification settings

zhicbr/file-extractor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

文件提取器

这是一个简单的桌面应用程序,用于提取文件内容到Markdown文件中。它允许你先选择一个基础文件夹,然后在该文件夹内选择特定的文件和子文件夹进行提取。

功能特点

  • 浏览文件系统并选择基础文件夹
  • 在基础文件夹内自由选择特定的文件和子文件夹
  • 以二级标题形式显示相对路径
  • 以代码块形式显示文件内容
  • 自动识别文件类型并设置对应的代码块语言
  • 直观的文件浏览界面,支持面包屑导航
  • 可以查看和管理已选择的项目

安装步骤

  1. 确保你的电脑已安装 Node.js
  2. 克隆或下载此仓库
  3. 在项目文件夹中打开命令行终端
  4. 运行以下命令安装依赖:
npm install

使用方法

  1. 在项目文件夹中运行以下命令启动应用程序:
npm start

或者直接双击 启动文件提取器.bat 文件(Windows系统)

  1. 应用程序启动后,使用流程如下:

    • 点击 "选择基础文件夹" 按钮选择要处理的根目录
    • 使用文件浏览器浏览文件夹内容:
      • 单击文件夹进入该文件夹
      • 单击文件或右键点击文件夹来选择/取消选择它们
      • 使用面包屑导航或"返回上级"按钮在目录之间导航
    • 选定的文件和文件夹会显示在右侧列表中
    • 可以点击右侧列表中的"删除"按钮移除已选择的项目
    • 选择完成后,点击 "生成MD文件" 按钮
    • 选择保存MD文件的位置和文件名
    • 等待生成完成,会显示成功或失败的消息
  2. 如果选择了文件夹,则该文件夹内的所有文件都会被递归提取

生成的Markdown格式

生成的Markdown文件将包含以下结构:

# 文件提取报告

## 文件/文件夹相对路径

```文件扩展名
文件内容

另一个文件/文件夹相对路径


## 开发说明

此应用程序使用以下技术:

- Electron: 用于创建跨平台桌面应用
- Node.js: 用于文件系统操作和后端功能
- HTML/CSS/JavaScript: 用于用户界面

## 注意事项

- 对于大文件或大量文件,生成过程可能需要一些时间
- 应用程序会尝试以UTF-8编码读取所有文件,不支持二进制文件
- 路径显示为相对于基础文件夹的相对路径

ac.js

逆向将md文件中的代码提取出来,根据changes.md在该目录下创建和修改文件

About

选取你的项目文件,整理为一个适合大语言模型(LLM)提示的文本摘要文档(markdown)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors