data/jq.py
Slice, transform, filter, and extract JSON data using jq query expressions on JSON text or JSON files.
Use when the user wants to filter, reshape, or pull fields out of JSON, or an API payload needs trimming before it enters context.
- the file
- data/jq.py
- its skill
- data/SKILL.md (the whole data pack)
- as knowledge
- okf/data/jq.md
- on GitHub
- data/jq.py ↗
Run it
1. Once per machine: install fragletc (Docker must already be running).
curl -fsSL https://raw.githubusercontent.com/ofthemachine/fraglet/main/install.sh | sh
2. Fetch the tool and print its contract.
curl -fsSLO https://tools.ofthemachine.com/data/jq.py && chmod +x jq.py && ./jq.py --fraglet-help
3. Run it.
./jq.py -p filter="<filter>" [-p json_source="<json_source>"] [-p json_text="<json_text>"]
Parameters
| name | type | requirement | description |
|---|---|---|---|
| filter | string | required | jq filter expression, e.g. .items[].name |
| json_source | file | optional | Host JSON file mounted at /input/json_source |
| json_text | string | optional | Inline JSON text (or pipe stdin) |
| stdin | pipe | optional | read in full and hashed into the receipt |
Outputs
stdout
Provenance
- image
- ofthemachine/python3@sha256:a015b4f9f0e7c1648f8fcd4164f6a296dd3c9189404f88f333a9764d08d13522
- reach
network=none— a run is a pure function of its inputs; results are safe to memoize.- procedure_hash
- sha256:fae52da25dfdf89ac4d3a99c48cb7c7aef03a674c3f2dac5eef5d5b4e5190820
- receipt
- add
--receipt run.jsonto any run;receipt/attest.pyverifies it against this hash without re-running.
Source
jq.py · 32 lines · sha256 fae52da25dfd…
#!/usr/bin/env -S fragletc --image ofthemachine/python3@sha256:a015b4f9f0e7c1648f8fcd4164f6a296dd3c9189404f88f333a9764d08d13522
#: d=Slice, transform, filter, and extract JSON data using jq query expressions on JSON text or JSON files.
#: when=Use when the user wants to filter, reshape, or pull fields out of JSON, or an API payload needs trimming before it enters context.
#: network=none
#: stdin=buffer
#: param=filter:required:d=jq filter expression, e.g. .items[].name
#: param=json_source:file:d=Host JSON file mounted at /input/json_source
#: param=json_text:d=Inline JSON text (or pipe stdin)
import os
import subprocess
import sys
filter_expr = os.environ.get("FILTER", "")
json_source = os.environ.get("JSON_SOURCE", "")
json_text = os.environ.get("JSON_TEXT", "")
cmd = ["jq", "-r", filter_expr]
if json_source and os.path.exists(json_source):
cmd.append(json_source)
res = subprocess.run(cmd)
sys.exit(res.returncode)
if not json_text and not sys.stdin.isatty():
json_text = sys.stdin.read()
if not json_text:
print("Error: No JSON provided via json_source, json_text, or stdin", file=sys.stderr)
sys.exit(1)
res = subprocess.run(cmd, input=json_text, text=True)
sys.exit(res.returncode)