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

# aquaproj/aqua

Install aqua and run `aqua install`.


## Commands

### aqua

Install aqua and run aqua install.
1. Install aqua 2. Add AQUA_ROOT_DIR/bin to PATH via $BASH_ENV 3. On Windows, add AQUA_ROOT_DIR/bat to PATH via $BASH_ENV 4. (Optional) Run "aqua policy allow" 5. (Optional) Run "aqua install"


| Parameter | Type | Default | Description |
|---|---|---|---|
| `aqua_all` | boolean | false | aqua i's "--all" option
 |
| `aqua_config` | string |  | aqua's "--config" option
 |
| `aqua_exclude_tags` | string |  | aqua i's "--exclude-tags" option
 |
| `aqua_log_level` | string |  | aqua's "--log-level" option
 |
| `aqua_only_link` | boolean | true | aqua i's "--only-link" option
 |
| `aqua_tags` | string |  | aqua i's "--tags" option
 |
| `aqua_version` | string |  | aqua version.
 |
| `enable_aqua_install` | boolean | true | if this is "false", the command "aqua install" is skipped
 |
| `policy_allow` | string |  | If this is "true", "aqua policy allow" is run without any argument. If this is empty (default), "aqua policy allow" isn't run. If this isn't "true", "aqua policy allow << parameters.policy_allow >>" is run
 |
| `working_directory` | string |  | working directory where "aqua install" is run
 |

### update-checksum

Run the command `aqua update-checksum` and push a commit to a remote branch.
Requirements:
- aqua >= v2.10.0
If skip_push is false (default), the following things are also required.
- int128/ghcp: https://github.com/int128/ghcp - Environment variable `GITHUB_TOKEN`: GitHub Access Token
  - `contents: write`


| Parameter | Type | Default | Description |
|---|---|---|---|
| `all` | boolean | false | aqua update-checksum's "-all" option
 |
| `aqua_config` | string |  | aqua's "--config" option
 |
| `aqua_log_level` | string |  | aqua's "--log-level" option
 |
| `git_root_directory` | string | . | Git root directory. Either an absolute path or a relative path from the current directory.
 |
| `prune` | boolean | false | aqua update-checksum's "-prune" option
 |
| `skip_push` | boolean | false |  |
| `working_directory` | string | . | working directory where "aqua update-checksum" is run
 |

## Examples

### example

Install tools with aqua.


```yaml
version: '2.1'
orbs:
  aqua: aquaproj/aqua@1.0.2
jobs:
  aqua:
    docker:
      - image: debian:12.0
    steps:
      - run:
          command: |
            apt update -y
            apt install -y git curl
          name: Install requirements
      - checkout
      - aqua/aqua:
          aqua_version: v2.53.3
      - run:
          command: |
            command -v circleci
            circleci version
  update-checksum:
    docker:
      - image: debian:12.0
    steps:
      - run:
          command: |
            apt update -y
            apt install -y git curl
          name: Install requirements
      - checkout
      - aqua/aqua:
          aqua_version: v2.53.3
      - aqua/update-checksum
  update-checksum-foo:
    docker:
      - image: debian:12.0
    steps:
      - run:
          command: |
            apt update -y
            apt install -y git curl
          name: Install requirements
      - checkout:
          path: yoo
      - aqua/aqua:
          aqua_version: v2.53.3
      - aqua/update-checksum:
          git_root_directory: yoo
          working_directory: yoo/foo
workflows:
  build:
    jobs:
      - aqua
```