Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions enterprise/cli/command-reference/porter-cluster.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,19 @@ description: "List available clusters, view cluster configuration details, and m

### `porter cluster list`[](#porter-cluster-list "Direct link to heading")

This lists all clusters under a certain project.
This lists all clusters under a certain project. The default output renders a formatted table with each cluster's name, provider, region, status, and creation date, with the name hyperlinked to its dashboard page in supported terminals.

**Flags:**

| Flag | Description |
|------|-------------|
| `--json` | Print clusters as JSON instead of a table. Useful for piping into tools like `jq` in scripts. |

**Example:**
```bash
porter cluster list --json | jq '.[].name'
```

### `porter cluster namespace list`[](#porter-cluster-namespace-list "Direct link to heading")

This lists all namespace in a cluster. This is a good mechanism to check that you are properly authenticated to a cluster.
This lists all namespace in a cluster. This is a good mechanism to check that you are properly authenticated to a cluster.
13 changes: 12 additions & 1 deletion standard/cli/command-reference/porter-cluster.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,24 @@ description: "List clusters and view cluster details including node groups, Kube

## `porter cluster list`

List all clusters in the current project.
List all clusters in the current project. The default output renders a formatted table with the cluster name, provider, region, status, and creation date. Cluster names are hyperlinked to their dashboard page in supported terminals.

**Usage:**
```bash
porter cluster list
```

**Flags:**

| Flag | Description |
|------|-------------|
| `--json` | Print clusters as JSON instead of a table. Useful for piping into tools like `jq` in scripts. |

**Example:**
```bash
porter cluster list --json | jq '.[].name'
```

<Tip>
Use `porter config set-cluster` to switch between clusters after listing them.
</Tip>
Expand Down