> For the complete documentation index, see [llms.txt](https://docs.apolo.us/index/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apolo.us/index/apolo-cli/commands/config.md).

# config

Client configuration

## Usage

```bash
apolo config [OPTIONS] COMMAND [ARGS]...
```

Client configuration.

**Commands:**

| Usage                                   | Description                                |
| --------------------------------------- | ------------------------------------------ |
| [*aliases*](#aliases)                   | List available command aliases             |
| [*docker*](#docker)                     | Configure local docker client              |
| [*get-clusters*](#get-clusters)         | List available clusters/org pairs          |
| [*login*](#login)                       | Log into Apolo Platform                    |
| [*login-headless*](#login-headless)     | Log into Apolo Platform in non-GUI environ |
| [*login-with-token*](#login-with-token) | Log into Apolo Platform with token         |
| [*logout*](#logout)                     | Log out                                    |
| [*show*](#show)                         | Print current settings                     |
| [*show-token*](#show-token)             | Print current authorization token          |
| [*switch-cluster*](#switch-cluster)     | Switch the active cluster                  |
| [*switch-org*](#switch-org)             | Switch the active organization             |
| [*switch-project*](#switch-project)     | Switch the active project                  |

### aliases

List available command aliases

#### Usage

```bash
apolo config aliases [OPTIONS]
```

List available command aliases.

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### docker

Configure local docker client

#### Usage

```bash
apolo config docker [OPTIONS]
```

Configure local docker client

This command configures local docker client to use Apolo Platform's docker registry.

#### Options

| Name                   | Description                                                     |
| ---------------------- | --------------------------------------------------------------- |
| *--help*               | Show this message and exit.                                     |
| *--docker-config PATH* | Specifies the location of the Docker client configuration files |

### get-clusters

List available clusters/org pairs

#### Usage

```bash
apolo config get-clusters [OPTIONS]
```

List available clusters/org pairs.

This command re-fetches cluster list and then displays each cluster with available orgs.

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### login

Log into Apolo Platform

#### Usage

```bash
apolo config login [OPTIONS] [URL]
```

Log into Apolo Platform.

`URL` is a platform entrypoint `URL`.

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### login-headless

Log into Apolo Platform in non-GUI environ

#### Usage

```bash
apolo config login-headless [OPTIONS] [URL]
```

Log into Apolo Platform in non`-GUI` environ

`URL` is a platform entrypoint `URL`.

The command works similar to "apolo login" but instead of opening a browser for performing OAuth registration prints an `URL` that should be open on guest host.

Then user inputs a code displayed in a browser after successful login back in apolo command to finish the login process.

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### login-with-token

Log into Apolo Platform with token

#### Usage

```bash
apolo config login-with-token [OPTIONS] TOKEN [URL]
```

Log into Apolo Platform with token.

`TOKEN` is authentication token provided by administration team. `URL` is a platform entrypoint `URL`.

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### logout

Log out

#### Usage

```bash
apolo config logout [OPTIONS]
```

Log out.

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### show

Print current settings

#### Usage

```bash
apolo config show [OPTIONS]
```

Print current settings.

#### Options

| Name       | Description                                                        |
| ---------- | ------------------------------------------------------------------ |
| *--help*   | Show this message and exit.                                        |
| *--energy* | Including cluster energy consumption and CO2 emissions information |

### show-token

Print current authorization token

#### Usage

```bash
apolo config show-token [OPTIONS]
```

Print current authorization token.

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### switch-cluster

Switch the active cluster

#### Usage

```bash
apolo config switch-cluster [OPTIONS] [CLUSTER_NAME]
```

Switch the active cluster.

`CLUSTER`\_`NAME` is the cluster name to select. The interactive prompt is used if the name is omitted (default).

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### switch-org

Switch the active organization

#### Usage

```bash
apolo config switch-org [OPTIONS] ORG_NAME
```

Switch the active organization.

`ORG`\_`NAME` is the organization name to select.

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### switch-project

Switch the active project

#### Usage

```bash
apolo config switch-project [OPTIONS] [PROJECT_NAME]
```

Switch the active project.

`PROJECT`\_`NAME` is the project name to select. The interactive prompt is used if the name is omitted (default).

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |