claude-plugins/plugins/json-pretty/commands/format.md
Cal Corum 9a227204fd fix: remove symlink reference, use CLAUDE_PLUGIN_ROOT paths directly
The symlink to ~/.local/bin is no longer needed since the command
can reference the script via ${CLAUDE_PLUGIN_ROOT}/scripts/.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-19 14:23:40 -05:00

66 lines
1.7 KiB
Markdown

---
description: "Format, validate, or minify JSON without external online services"
allowed-tools: Bash
---
## When to Use
Use when the user asks to:
- "prettify json"
- "format json"
- "pretty print json"
- "validate json"
- "clean up json"
- Or mentions wanting to format/prettify JSON data
## Tool Location
`${CLAUDE_PLUGIN_ROOT}/scripts/json-pretty.py`
## Usage
```bash
# From file
python3 ${CLAUDE_PLUGIN_ROOT}/scripts/json-pretty.py input.json
# From stdin/pipe
cat data.json | python3 ${CLAUDE_PLUGIN_ROOT}/scripts/json-pretty.py
echo '{"foo":"bar"}' | python3 ${CLAUDE_PLUGIN_ROOT}/scripts/json-pretty.py
# Save to file
python3 ${CLAUDE_PLUGIN_ROOT}/scripts/json-pretty.py input.json -o output.json
# Options
python3 ${CLAUDE_PLUGIN_ROOT}/scripts/json-pretty.py input.json --indent 4 # Custom indentation
python3 ${CLAUDE_PLUGIN_ROOT}/scripts/json-pretty.py input.json --sort-keys # Sort object keys
python3 ${CLAUDE_PLUGIN_ROOT}/scripts/json-pretty.py input.json --compact # Minify instead of prettify
```
## Options
- `-o, --output FILE`: Write to file instead of stdout
- `-i, --indent N`: Indentation spaces (default: 2)
- `-s, --sort-keys`: Sort object keys alphabetically
- `-c, --compact`: Compact output (minify)
## Examples
**Prettify inline JSON:**
```bash
echo '{"name":"cal","items":[1,2,3]}' | python3 ${CLAUDE_PLUGIN_ROOT}/scripts/json-pretty.py
```
**Format a file:**
```bash
python3 ${CLAUDE_PLUGIN_ROOT}/scripts/json-pretty.py messy.json -o clean.json
```
**Sort keys and use 4-space indent:**
```bash
python3 ${CLAUDE_PLUGIN_ROOT}/scripts/json-pretty.py data.json --indent 4 --sort-keys
```
## Privacy Note
Built specifically to avoid posting potentially sensitive JSON to online prettifier services.