# list

The vcluster list command is used to retrieve a list of all virtual clusters within a project. This command displays essential details such as cluster name, creation date, services, and public status.

## Usage

```
cldkctl vcluster list [flags]
```

## Aliases

```
list, ls
```

## Steps

1. Run the following command in the terminal to display all virtual clusters in the project:

```
cldkctl vcluster list
```

2. To limit the number of results per page, use the --limit flag followed by the desired number of entries.
3. To view results on a specific page, use the --page flag.
4. To filter clusters based on status, use the --status flag.
5. Once the command is executed, the terminal displays a list under the Virtual Cluster List section, showing the cluster name, creation time, and public status.

<figure><img src="/files/7sAVrk71pfFLNGrb7xA6" alt=""><figcaption></figcaption></figure>

| Column        | Description                                                                                                      |
| ------------- | ---------------------------------------------------------------------------------------------------------------- |
| Name          | Displays the name of the virtual cluster.                                                                        |
| Created At    | Shows the timestamp when the virtual cluster was created (in UTC format).                                        |
| Services      | Indicates the list or count of running services associated with the cluster. If none, the value is shown as “-”. |
| Public Status | Shows the current public status of the cluster.                                                                  |

## Flags

{% hint style="info" %}
This command supports [global flags](/guidance-for-individual/cloudeka-api-list/global-flags.md). Refer to the Global Flags section for details
{% endhint %}

| Flag                | Description                                      |
| ------------------- | ------------------------------------------------ |
| -h, --help          | Help for the vcluster list command.              |
| -l, --limit string  | Specify number of results per page (default 10). |
| -p, --page string   | Specify page number (default 1).                 |
| --search string     | Specify search keywords.                         |
| -s, --status string | Specify status.                                  |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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.cloudeka.ai/guidance-for-individual/cloudeka-api-list/command-reference/cldkctl-vcluster/list.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.