pdssupport/livegrep

livegrep Docker镜像

镜像概述

livegrep是受Google Code Search启发的开源工具，专注于大规模源代码仓库的交互式正则搜索。它通过高效索引机制实现快速查询，适用于GB级代码库，帮助开发者提升代码检索效率。

核心功能

• 交互式正则搜索：支持复杂正则表达式，实时返回匹配结果
• 大规模代码支持：轻松处理GB级源代码仓库
• 索引持久化：可将索引保存到磁盘重复使用，无需重新构建
• GitHub集成：提供工具自动更新并索引指定GitHub仓库
• 分布式架构：后端codesearch负责索引/搜索，前端livegrep提供Web界面

使用场景

• 开发者日常代码查询与调试
• 团队共享代码库的快速检索
• 开源项目源码的深度分析
• 大型代码仓库的批量搜索任务

配置说明

1. 索引构建与使用

• 生成索引文件：

  bash
  docker run --rm -v $(pwd)/data:/data pdssupport/livegrep codesearch -index_only -dump_index /data/livegrep.idx /data/index.json
  

• 加载索引并启动搜索服务：

  bash
  docker run -d -p 9999:9999 -v $(pwd)/data:/data pdssupport/livegrep codesearch -load_index /data/livegrep.idx -grpc 0.0.0.0:9999
  

2. 启动Web界面

bash
docker run -d -p 8910:8910 --link codesearch:codesearch pdssupport/livegrep livegrep --codesearch_addr codesearch:9999

3. Docker Compose示例

yaml
version: '3'
services:
  codesearch:
    image: pdssupport/livegrep
    command: codesearch -load_index /data/livegrep.idx -grpc 0.0.0.0:9999
    volumes: ["./data:/data"]
    ports: ["9999:9999"]
  
  livegrep:
    image: pdssupport/livegrep
    command: livegrep --codesearch_addr codesearch:9999
    ports: ["8910:8910"]
    depends_on: [codesearch]

资源说明

• 索引文件大小约等于原始源代码大小
• 建议将索引加载到内存以获得最佳性能，大索引可使用磁盘映射

许可证

livegrep遵循开源许可证，详情见镜像内COPYING文件。