diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -8,7 +8,7 @@ Barb is a file-based API query tool that works nicely with version control and f ## Example usage ``` -barb <file 1> <file 2> ... <file n> +barb [options] <file 1> <file 2> ... <file n> ``` ### CLI options @@ -18,6 +18,7 @@ barb <file 1> <file 2> ... <file n> - `-h, --headers`: Only print the response headers - `-r, --raw`: Don't format the response body - `-V, --version`: Print the software version +- `-n, --no-color`: Don't use color output ## Barb format @@ -26,6 +27,7 @@ Barb uses a custom file format to perform requests. Each file contains _one_ req ``` #POST^http://my-blog.com/posts #Authorization: TOKEN {API_TOKEN} +#|jq.filter { "title": "A post", @@ -68,15 +70,13 @@ There can be none or many headers. ### Filter -!!! Not operational at this time - -Barb will support JQ filtering of the response body. This has the following format: +Barb supports JQ filtering of the response body. This has the following format: ``` #|<JQ FILTER> ``` -The `JQ FILTER` supports variable substitution. +The `JQ FILTER` supports variable substitution. Refer to the [JQ manual](https://stedolan.github.io/jq/manual/#Basicfilters) for more information on the filters and their syntax. ### Body |