# Installation

## Install Node.js

The CLI is available as [a JavaScript package](https://www.npmjs.com/package/@extrahorizon/exh-cli) and requires [Node.js](https://nodejs.org/) to run. If you have Node.js installed you can install the CLI using a JavaScript package manager. For instance, you can use [npm](https://docs.npmjs.com/about-npm), which comes with Node.js, or alternative package managers like [Yarn](https://yarnpkg.com/).

[Installation instructions for Node.js and npm can be found here.](https://nodejs.org/en/download)

## Install the CLI

We recommend installing the CLI globally. Installing the CLI globally makes sure it can be used in all your projects. For that reason all examples in this documentation will assume a global installation.

{% tabs %}
{% tab title="npm" %}

```
npm install --global @extrahorizon/exh-cli
```

{% endtab %}

{% tab title="yarn" %}

```
yarn global add @extrahorizon/exh-cli
```

{% endtab %}
{% endtabs %}

For more advanced uses, the CLI can be installed in your project as a development dependency.

{% tabs %}
{% tab title="npm" %}

```
npm install --save-dev @extrahorizon/exh-cli
```

{% endtab %}

{% tab title="yarn" %}

```
yarn add --dev @extrahorizon/exh-cli
```

{% endtab %}
{% endtabs %}

#### Check if the installation worked

When installed globally, trying running the following command in your Terminal to verify whether it's installed correctly.

```
exh --help 
```

this should give you the following response:

```
exh <command>

Commands:
  exh completion               Install shell completion for bash & zsh
  exh data <command>           Manage data
  exh dispatchers <command>    Manage Dispatchers within Extra Horizon
  exh localizations <command>  Manage localizations
  exh login                    Retrieve credentials from ExH
  exh settings <command>       Manage Service Settings within Extra Horizon
  exh sync                     Sync your ExH configuration to the cloud
                               environment
  exh tasks <command>          Manage tasks
  exh templates <command>      Manage templates
  exh whoami                   Shows the currently logged in user

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]
```

{% hint style="info" %}
If the command isn't recognized, it might be because the yarn global bin folder isn't in your PATH.
{% endhint %}

In case your are using bash, you can add `export PATH="$PATH:$(yarn global bin)"` to your `~/.bash_profile` and reload it with `source ~/.bash_profile`

When installed as a development dependency, run the following command to verify the CLI is working correctly:

{% tabs %}
{% tab title="npx" %}

```
npx exh --help
```

{% endtab %}

{% tab title="yarn" %}

```
yarn exh --help
```

{% endtab %}
{% endtabs %}

## Completion

Enable auto-complete for shell commands with:

```bash
exh completion
```

This command updates either your `~/.zshrc` or `~/.bashrc` file, depending on your shell. Reload your shell using:

```bash
source ~/.zshrc   # For Zsh
```

or

```bash
source ~/.bashrc  # For Bash
```

Now, you can use the tab key to complete commands and view command arguments by typing and pressing tab.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.extrahorizon.com/cli/readme/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.