> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/resilience-testing/3.0/troubleshooting-and-resources/api-reference/hce-onboarding-api.md).

# HCE Onboard CLI

This section describes the Harness Chaos Engineering (HCE) onboard CLI and its usage.

### What is the HCE onboard CLI? <a href="#what-is-the-hce-onboard-cli" id="what-is-the-hce-onboard-cli"></a>

The `onboard_hce_aws` CLI streamlines and simplifies the HCE onboarding process. This tool also seamlessly integrates with your AWS account and executes HCE experiments. This CLI performs other tasks that streamline the onboarding process, such as:

* **ChaosInfra Setup:** The CLI installs the chaos infrastructure in the given namespace of your cluster using Harness APIs and Kubernetes permissions. After installation, it tests the activation of the infrastructure for a given timeout (default is 180 s).
* **Add OIDC Provider:** The CLI can be used to add the OIDC provider in the target account using the AWS credentials. If the given provider already exists, the CLI issues a warning and skips this step.
* **AWS Roles:** Simplifies configuring HCE with AWS. If you wish to create a dedicated role for HCE, the CLI defines the required policies and permissions directly as CLI flags. Alternatively, if you already have a role, you can provide it as an input, and that role gets attached to the provider that you added previously. In addition, this CLI doesn't depend on other CLIs such as `aws` or `kubectl`.
* **Annotate Service Account:** The CLI will annotate the experiment service account on the cluster with AWS roleARN after all the configuration is done.
* **Compatibility:** It provides compatibility across various Windows and Linux versions.
* **Flag support:** It supports a variety of flags thereby facilitating customization options for every step.

### Install the onboard HCE AWS <a href="#install-the-onboard-hce-aws" id="install-the-onboard-hce-aws"></a>

Onboard HCE AWS offers pre-compiled binaries that are available for download based on the operating system and its variants.

To install, follow these steps.

1. Download the appropriate binary for your platform from the **Assets** section.
2. Rename the downloaded file to `onboard_hce_aws` (or `onboard_hce_aws.exe` for Windows).
3. Move this file to your `$PATH` at your preferred binary installation directory.

{% tabs %}
{% tab title="Linux" %}
You can download for `AMD64` (or x86\_64) and `Arm64` variants in Linux OS.

{% tabs %}
{% tab title="AMD64 / x86\_64" %}

```bash
[ $(uname -m) = x86_64 ] && curl -Lo ./onboard_hce_aws https://app.harness.io/public/shared/tools/chaos/onboard_hce_aws/0.2.0/onboard_hce_cli-0.2.0-linux-amd64
```

{% endtab %}

{% tab title="Arm64" %}

```bash
[ $(uname -m) = aarch64 ] && curl -Lo ./onboard_hce_aws https://app.harness.io/public/shared/tools/chaos/onboard_hce_aws/0.3.0/onboard_hce_cli-0.3.0-linux-arm64
```

* After downloading, add the execution permissions and move it to your binary installation directory using the following commands:

```bash
chmod +x ./onboard_hce_aws
sudo mv ./onboard_hce_aws /usr/local/bin/onboard_hce_aws
```

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="MacOS" %}
You can download for `M1/ARM Macs` and `Intel Macs` variants in MacOS.

{% tabs %}
{% tab title="Intel Macs" %}

```bash
[ $(uname -m) = x86_64 ] && curl -Lo ./onboard_hce_aws https://app.harness.io/public/shared/tools/chaos/onboard_hce_aws/0.3.0/onboard_hce_cli-0.3.0-darwin-amd64
```

{% endtab %}

{% tab title="M1 / ARM Macs" %}

```bash
[ $(uname -m) = arm64 ] && curl -Lo ./onboard_hce_aws https://app.harness.io/public/shared/tools/chaos/onboard_hce_aws/0.3.0/onboard_hce_cli-0.3.0-darwin-arm64
```

* After downloading, add the execution permissions and move it to your binary installation directory using the following commands:

```bash
chmod +x ./onboard_hce_aws
mv ./onboard_hce_aws /some-dir-in-your-PATH/onboard_hce_aws
```

{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}