jsonpretty 技术文档

本文档旨在帮助用户安装、使用并深入了解 jsonpretty 项目，以下为详细的技术说明。

一、安装指南

1. Ruby 版本安装

使用 RubyGems 安装

gem install jsonpretty

使用 Homebrew 和 brew-gem 全局安装

brew install brew-gem
brew gem install jsonpretty

2. Go 版本安装

使用 go install 安装（需要 Go 1.17）

go install github.com/nicksieger/jsonpretty

从发布版本使用 curl+tar 安装

VERSION=1.2.0
OS=$(uname -s)
ARCH=$(uname -m)
curl -L https://github.com/nicksieger/jsonpretty/releases/download/v${VERSION}/jsonpretty_${VERSION}_${OS}_${ARCH}.tar.gz | sudo tar -C /usr/local/bin -zxf - jsonpretty

二、项目使用说明

jsonpretty 是一个命令行工具，用于将 JSON 输出格式化为更易读的形式。以下为使用示例：

curl -i http://api.com/json | jsonpretty

此命令将从 HTTP API 获取 JSON 数据，并通过 jsonpretty 工具将其格式化输出。

三、项目API使用文档

jsonpretty 工具支持的命令行参数如下：

• 从标准输入(stdin)读取数据：使用 - 或 @- 作为参数，或省略参数。
• 从文件读取数据：使用 @filename 作为参数，其中 filename 为包含 JSON 数据的文件名。
• 检测 HTTP 响应/头部，并原样输出，跳转到主体内容（适用于 curl -i 的使用场景）。

四、项目安装方式

项目的安装方式已在“一、安装指南”中详细说明，支持 Ruby 和 Go 两种语言版本。用户可根据自己的需求和环境选择合适的安装方式。

---

以上为 jsonpretty 项目的技术文档，希望能对用户的使用和了解提供帮助。