stagex/grep

grep 文本搜索工具镜像文档

镜像概述

本镜像基于经典文本搜索工具 grep 构建，提供轻量级文本模式匹配功能，用于在输入文件中快速查找包含指定正则表达式模式的行。镜像封装了 grep 核心功能，无需在宿主环境单独安装，可通过 Docker 容器化方式便捷使用，适用于各类文本内容检索场景。

核心功能与特性

• 正则表达式支持：兼容 POSIX 基本正则表达式（BRE）和扩展正则表达式（ERE，通过 -E 选项启用），可匹配复杂文本模式。
• 多文件搜索：支持同时对多个文件或目录进行搜索，通过命令行参数指定目标文件路径。
• 匹配控制选项：提供丰富的匹配行为控制，包括：
  • 大小写敏感切换（-i 选项忽略大小写，默认大小写敏感）
  • 精确匹配整行（-x 选项）
  • 显示匹配行号（-n 选项）
  • 仅显示匹配的文本片段（-o 选项）
• 递归搜索能力：通过 -r 或 -R 选项可递归搜索指定目录下的所有文件。
• 轻量级设计：基于 Alpine 基础镜像构建，镜像体积小，启动速度快，资源占用低。

使用场景

• 日志分析：在应用日志文件中快速定位包含 "error"、"warning" 等关键字的行，辅助问题排查。
• 代码检索：在源代码目录中搜索特定函数名、变量名或注释模式，辅助代码阅读与维护。
• 配置文件检查：验证配置文件中是否存在指定参数或格式错误的配置项。
• 批量文本处理：结合管道（|）与其他命令（如 find、cat）联动，实现复杂文本筛选逻辑。

使用方法与配置说明

基础使用示例

1. 搜索单个文件中的文本模式

在当前工作目录的 app.log 文件中搜索包含 "error" 的行：

bash
docker run --rm -v $(pwd):/data docker.xuanyuan.run/grep-image grep "error" /data/app.log

说明：-v $(pwd):/data 将宿主机当前目录挂载到容器内 /data 目录，/data/app.log 为容器内文件路径。

2. 递归搜索目录中的文本模式

在 /project 目录下递归搜索所有文件中包含 "TODO" 的行（忽略大小写）：

bash
docker run --rm -v /path/to/project:/data docker.xuanyuan.run/grep-image grep -i -r "TODO" /data

选项说明：-i 忽略大小写，-r 递归搜索子目录。

3. 使用正则表达式匹配

搜索 /config 目录下 .ini 文件中以 "server=" 开头的行，并显示行号：

bash
docker run --rm -v /path/to/config:/data docker.xuanyuan.run/grep-image grep -n "^server=" /data/*.ini

正则说明：^server= 匹配以 "server=" 开头的行，-n 显示匹配行的行号。

常用参数说明

高级使用：与其他命令联动

通过管道（|）结合 find 命令筛选特定类型文件后搜索：

bash
docker run --rm -v $(pwd):/data docker.xuanyuan.run/grep-image sh -c "find /data -name '*.log' | xargs grep 'Exception'"

功能：在当前目录下所有 .log 文件中搜索包含 "Exception" 的行。

注意事项

• 文件挂载：容器内无法直接访问宿主机文件系统，需通过 -v 参数挂载目标文件或目录至容器内路径（如 /data）。
• 权限问题：若宿主机文件权限限制，可通过 --user $(id -u):$(id -g) 参数指定容器运行用户，避免权限错误。
• 镜像更新：本镜像基于 grep 最新稳定版本构建，如需特定版本，可通过指定标签（如 grep-image:1.2.3）拉取对应版本镜像。