Skip to content

stu2116Edward/ripgrep-webui

Repository files navigation

ripgrep-webui

Visual Text Content Retrieval Tool

本项目是基于 https://github.com/BurntSushi/ripgrep 实现的webui可视化操作工具
注意:在检索excel格式文件如xls,xlsx格式建议先转为csv格式(对于较大的excel格式文件会检索失败)

Docker

安装Docker环境

使用脚本自行安装

curl -sS -O https://gitee.com/stu2116Edward/docker-tools/raw/master/docker_tools.sh && chmod +x docker_tools.sh && ./docker_tools.sh

使用命令一键部署

  • 创建文件存储目录:
mkdir -p /data/kuzi
  • 使用Docker命令部署
docker run -d \
  --name ripgrep-webui \
  -p 5757:5000 \
  -v /data/kuzi:/data:ro \
  -v $(pwd)/exports:/app/exports \
  --restart always \
  stu2116edwardhu/ripgrep-webui
  • 使用docker-compose部署 编辑docker-compose.yml配置文件
services:
  ripgrep-webui:
    image: stu2116edwardhu/ripgrep-webui
    container_name: ripgrep-webui
    ports:
      - "5757:5000"
    volumes:
      - /data/kuzi:/data:ro
      - ./exports:/app/exports
    restart: always

/data/kuzi替换为你存放文件的路径
./exports是存放历史查询的目录

运行项目

docker-compose up -d

Windows

本项目可以在windows中安装python环境并配置对应库直接运行
还需要在 https://github.com/BurntSushi/ripgrep/releases 下载所需的环境ripgrep-15.1.0-x86_64-pc-windows-gnu.zip
执行主函数:

python main.py

在浏览器中输入127.0.0.1:5000
数据目录即当前项目所在目录,把需要检索的文件直接放到该项目所在文件夹内即可
注意:检索数据的回退目录会在项目所在盘符下的如E:\app\exports目录中写入数据(自行清理和备份)

界面展示

屏幕截图 2025-10-19 211813

自行编译

可以自行替换ripgrep的版本去ripgrep-release下载你系统版本的二进制,比如你是x86_64_linux
就下ripgrep-14.1.0-x86_64-unknown-linux-musl.tar.gz,把rg文件解压出来替换到当前目录下
使用Docker进行编译

docker build -t ripgrep-webui .

About

Visual Text Content Retrieval Tool

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published