util json query
Query JSON data
Please refer to jq Manual for the syntax (some features are not supported).
Installation
Please download the pre-compiled binary from Latest Release. If you are using Windows, please download the zip file like tbx-xx.x.xxx-win.zip. Then, extract the archive and place tbx.exe on the Desktop folder.
The watermint toolbox can run from any path in the system if allowed by the system. But the instruction samples are using the Desktop folder. Please replace the path if you placed the binary other than the Desktop folder.
Usage
This document uses the Desktop folder for command example.
Run
Windows:
cd $HOME\Desktop
.\tbx.exe util json query -path /LOCAL/PATH/TO/DATA.json -query QUERY
macOS, Linux:
$HOME/Desktop/tbx util json query -path /LOCAL/PATH/TO/DATA.json -query QUERY
Note for macOS Catalina 10.15 or above: macOS verifies Developer identity. Currently, tbx is not ready for it. Please select “Cancel” on the first dialogue. Then please proceed “System Preference”, then open “Security & Privacy”, select “General” tab.
You may find the message like:
“tbx” was blocked from use because it is not from an identified developer.
And you may find the button “Allow Anyway”. Please hit the button with your risk. At second run, please hit button “Open” on the dialogue.
Options:
- -compact
- Compact output. Default: false
- -path
- File path
- -query
- Query string
Common options:
- -auth-database
- Custom path to auth database (default: $HOME/.toolbox/secrets/secrets.db)
- -auto-open
- Auto open URL or artifact folder. Default: false
- -bandwidth-kb
- Bandwidth limit in K bytes per sec for upload/download content. 0 for unlimited. Default: 0
- -budget-memory
- Memory budget (limits some feature to reduce memory footprint). Options: low, normal. Default: normal
- -budget-storage
- Storage budget (limits logs or some feature to reduce storage usage). Options: low, normal, unlimited. Default: normal
- -concurrency
- Maximum concurrency for running operation. Default: Number of processors
- -debug
- Enable debug mode. Default: false
- -experiment
- Enable experimental feature(s).
- -extra
- Extra parameter file path
- -lang
- Display language. Options: auto, en, ja. Default: auto
- -output
- Output format (none/text/markdown/json). Options: text, markdown, json, none. Default: text
- -output-filter
- Output filter query (jq syntax). The output of the report is filtered using jq syntax. This option is only applied when the report is output as JSON.
- -proxy
- HTTP/HTTPS proxy (hostname:port). Please specify
DIRECT if you want to skip setting proxy.
- -quiet
- Suppress non-error messages, and make output readable by a machine (JSON format). Default: false
- -retain-job-data
- Job data retain policy. Options: default, on_error, none. Default: default
- -secure
- Do not store tokens into a file. Default: false
- -skip-logging
- Skip logging in the local storage. Default: false
- -verbose
- Show current operations for more detail.. Default: false
- -workspace
- Workspace path
Text inputs
Text input: Path
The path to the JSON file