linux/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-12 21:39:48 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(jsontools): document requirements

Browse source 
Fixes #10834
This commit is contained in:
Marc Cornellà 2024-10-27 15:13:05 +01:00
parent eeb01c18c1
commit 45516ca1d8
No known key found for this signature in database
GPG key ID: 0314585E776A9C1B
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
plugins/jsontools/README.md
View file

@ -8,6 +8,17 @@ To use it, add `jsontools` to the plugins array in your zshrc file:
plugins=(... jsontools) plugins=(... jsontools)
``` ```
## Requirements
The plugin uses one of these tools to process JSON data, in the following order:
- `node`
- `python3`
- `ruby`
Any of these must be in `$PATH` before the plugin is loaded, otherwise the plugin exits
prematurely and the functions will not be available.
## Usage ## Usage
Usage is simple... just take your json data and pipe it into the appropriate jsontool: Usage is simple... just take your json data and pipe it into the appropriate jsontool: