> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# circleci/jq

An orb for working with jq, a command-line JSON parser useful for headless/automated API scripting.


## Commands

### install

Install jq in a CircleCI job. Supports jq versions 1.3 and newer. Requirements: bash, curl, gpg, grep, sed, sha256sum, tar


| Parameter | Type | Default | Description |
|---|---|---|---|
| `install_dir` | string | ~/bin | Directory in which to install jq
 |
| `override` | boolean | false | Whether or not to remove a pre-existing version of jq when this version
is installed.
 |
| `version` | string | latest | Version of jq to install, defaults to `latest`. If specifying a version other than latest, provide a full release tag, as listed at https://api.github.com/repos/jqlang/jq/releases, e.g., `jq-1.6`.
 |

## Examples

### install

Install jq in a CircleCI job


```yaml
version: '2.1'
orbs:
  jq: circleci/jq@3.0.0
jobs:
  build:
    docker:
      - image: cimg/base:current
    steps:
      - jq/install:
          version: jq-1.7
workflows:
  your-workflow:
    jobs:
      - build
```