> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hotglue.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Env

> List environments, create available connectors, and manage environment settings with the hotglue CLI

Use the `env` commands to list accessible environments and manage environment settings. Environment settings include `requirements.txt`, `availableSources.json`, `availableTargets.json`, `availableConnectors.json`, and `customTaps.json`.

Use `env connector` to create [available connectors](https://docs.hotglue.com/key-concepts/connectors/connectors.md#what-is-an-available-connector) for an environment. After a connector is available, add it to a flow with [`supported-entities create`](https://docs.hotglue.com/cli/supported-entities#supported-entities-create).

# Env List

## Description

Lists the environments available to your Personal API Key. Configure the key with `hotglue config set apikey <api-key>` or pass it with `--apikey`.

Unlike other environment commands, `env list` does not require `--env`.

## Sample

```shell theme={null}
hotglue env list
hotglue env list --json
```

Environment API keys are omitted by default. Use `--include-secrets` to include them in the output.

```shell theme={null}
hotglue env list --include-secrets
```

Secret-enabled output uses these field names:

* `publicApiKey`: the environment's public API key
* `personalApiKey`: your Personal API Key
* `environmentApiKey`: the environment API key, when authorized

`--include-secrets` may print your Personal API Key. Do not expose its output in logs, CI output, or shared terminals.

## Parameters

| Option | Default | Description |
| - | - | - |
| `--apikey`, `-k` | Profile config | Personal API Key used to authenticate the request. |
| `--json` | `false` | Return machine-readable JSON output. |
| `--include-secrets` | `false` | Include sensitive API key fields in the output. |

# Available environment settings

| File | Description |
| - | - |
| `requirements.txt` | Default Python dependencies to be used in ETL Scripts |
| `availableSources.json` | List of customized sources available in V1 Flows |
| `availableTargets.json` | List of customized targets available in V1 Flows |
| `availableConnectors.json` | List of customized connectors available in V2 Flows |
| `customTaps.json` | List of custom taps built with Hotglue's Connector Builder |

# Env Connector Create

## Description

Creates a new available connector for the environment and appends it to `availableConnectors.json`. The connector id must not already exist in the environment.

`--read-install-uri` is mapped onto `read_connector.install_uri`. If you pass `--write-install-uri`, it is mapped onto `write_connector.install_uri`. Passing `--auth-url` or `--token-url` sets the connector `type` to `oauth`.

## Samples

Create an API-key connector with flags:

```shell theme={null}
hotglue env connector create \
  --env prod.acme.com \
  --id my-connector \
  --label "My Connector" \
  --read-install-uri "git+https://github.com/org/tap-example.git" \
  --connect-ui-params '{"api_key":{"label":"API Key","type":"password"}}'
```

Include a write connector install URI:

```shell theme={null}
hotglue env connector create \
  --env prod.acme.com \
  --id my-connector \
  --label "My Connector" \
  --read-install-uri "git+https://github.com/org/tap-example.git" \
  --write-install-uri "git+https://github.com/org/target-example.git"
```

Create an OAuth connector:

```shell theme={null}
hotglue env connector create \
  --env prod.acme.com \
  --id my-connector \
  --label "My Connector" \
  --read-install-uri "git+https://github.com/org/tap-example.git" \
  --auth-url "https://example.com/oauth/authorize" \
  --token-url "https://example.com/oauth/token"
```

Return machine-readable output:

```shell theme={null}
hotglue env connector create \
  --env prod.acme.com \
  --id my-connector \
  --label "My Connector" \
  --read-install-uri "git+https://github.com/org/tap-example.git" \
  --json
```

## Parameters

| Option | Default | Description |
| - | - | - |
| `--apikey`, `-k` | Profile config | Personal API Key used to authenticate the request. |
| `--env`, `-e` | | **Required.** Environment to create the available connector in. |
| `--id` | | **Required.** Unique connector id. |
| `--label` | | **Required.** Display name for the connector. |
| `--read-install-uri` | | **Required.** Install URI for the read connector. |
| `--write-install-uri` | | Install URI for the write connector. |
| `--connect-ui-params` | | Shell-quoted JSON object defining Connect UI params for API credentials. |
| `--auth-url` | | OAuth authorize URL. |
| `--token-url` | | OAuth token URL. |
| `--json` | `false` | Return machine-readable output. |

# Env Download

## Description

Clones the remote env settings saved in Hotglue to your local machine.

## Sample

```shell theme={null}
$ hotglue env download [--downloadTo]
✔ Finished: Verifying user and authorizing.
✔ Finished: Scanning environment dev.hotglue.acme.com.
ℹ Info: Downloading to ./projects/cin7.
✔ Finished: Downloading file: requirements.txt.
┌──────────────────┬────────────┐
│ File             │ Status     │
├──────────────────┼────────────┤
│ requirements.txt │ Downloaded │
└──────────────────┴────────────┘
```

## Parameters

| Option | Default | Description |
| - | - | - |
| `--downloadTo` | | |
| `-d` | `.` | The directory to download the files to. Defaults to the local directory. |

# Env Deploy

## Description

Deploys your environment settings

## Sample

```shell theme={null}
$ hotglue env deploy [--sourceFolder]
✔ Finished: Scanning ./projects/cin7 for deployable files.
✔ Finished: Verifying user and authorizing.
ℹ Info: Deploying environment files.
✔ Finished: Pushing file: requirements.txt.
┌──────────────────┬──────────┐
│ File             │ Status   │
├──────────────────┼──────────┤
│ requirements.txt │ Deployed │
└──────────────────┴──────────┘

```

## Parameters

| Option | Default | Description |
| - | - | - |
| `--sourceFolder` | | |
| `-s` | `.` | The directory to upload the files from. Defaults to the local directory. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.