docker/jcat

镜像概述

该Docker镜像提供一个轻量级命令行工具，功能类似传统cat命令，核心差异在于其输出为结构化JSON格式。通过将文本内容转换为JSON对象，简化了数据解析、日志处理及跨工具集成流程。

核心功能与特性

• 多输入支持：可读取指定文件内容或接收标准输入（管道数据）
• JSON结构化输出：默认包含content（内容）、filename（文件名，文件输入时）、status（处理状态）等字段
• 轻量级设计：基于精简基础镜像构建，镜像体积小，资源占用低
• 即插即用：无需预配置，直接通过命令行参数指定输入源即可使用

使用场景与适用范围

• 日志结构化：将非结构化文本日志转换为JSON格式，适配日志分析系统（如ELK、Splunk）
• 数据管道处理：与jq、grep等工具配合，实现JSON数据筛选、转换与聚合
• 脚本自动化：在Shell/Python脚本中生成结构化输出，简化结果判断与下游处理
• API测试辅助：快速将文本响应转换为JSON，便于与API返回格式比对

使用方法与配置说明

基础语法

bash
docker run --rm [选项] <镜像名> [输入源]

• --rm：容器退出后自动删除
• 输入源：可为文件路径（容器内路径）或-（表示标准输入）

关键选项

• -v <宿主机路径>:<容器路径>：挂载宿主机目录，用于读取本地文件
• -i：保持标准输入打开，用于接收管道数据

示例演示

1. 读取本地文件并输出JSON

bash
# 将当前目录下的test.txt文件挂载到容器内/data目录，读取并转换
docker run --rm -v $(pwd):/data <镜像名> /data/test.txt

输出示例：

json
{
  "filename": "/data/test.txt",
  "content": "这是test.txt的内容",
  "status": "success",
  "timestamp": "2024-06-01T12:34:56Z"
}

2. 读取标准输入（管道数据）

bash
# 将echo输出通过管道传入工具
echo "标准输入内容" | docker run --rm -i <镜像名> -

输出示例：

json
{
  "filename": null,
  "content": "标准输入内容",
  "status": "success",
  "timestamp": "2024-06-01T12:35:10Z"
}

3. 与jq工具配合使用

bash
# 读取文件并通过jq提取content字段
docker run --rm -v $(pwd):/data <镜像名> /data/log.txt | jq -r .content

注意事项

• 容器内文件路径需与挂载路径对应，避免因路径错误导致读取失败
• 处理大文件时建议通过管道输入（避免容器内存储压力）
• 如需自定义JSON字段（如添加额外元数据），可通过--meta参数实现（具体以镜像文档为准）