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

# idyl get

> List and inspect resources

List and inspect resources in the current context.

Resource types:

* deployments (deploy)
* replicasets (rs)
* pods (pod)
* jobs (job)
* sandboxes (sandbox)
* vms (vm)
* cronjobs (cj)
* services (service)
* webapps (webapp)
* gateways (gw)
* httproutes (httproute)
* tlsroutes (tlsroute)
* referencegrants (referencegrant)
* secrets (secret)

## Usage

```bash theme={null}
idyl get [resource]
```

## Aliases

* `list`
* `ls`

## Commands

| Command                   | Description                                                                       |
| ------------------------- | --------------------------------------------------------------------------------- |
| `idyl get all`            | Get all workloads (deployments, replicasets, jobs, cronjobs, and optionally pods) |
| `idyl get cronjob`        | Get cronjob details                                                               |
| `idyl get deployment`     | Get deployment details                                                            |
| `idyl get gateway`        | List or inspect Gateways                                                          |
| `idyl get httproute`      | List or inspect HTTPRoutes                                                        |
| `idyl get job`            | Get job details                                                                   |
| `idyl get pod`            | Get pod details                                                                   |
| `idyl get referencegrant` | List or inspect ReferenceGrants                                                   |
| `idyl get replicaset`     | Get replicaset details                                                            |
| `idyl get sandbox`        | List or inspect Sandboxes                                                         |
| `idyl get secret`         | List or inspect secrets                                                           |
| `idyl get service`        | List or inspect Services                                                          |
| `idyl get tlsroute`       | List or inspect TLSRoutes                                                         |
| `idyl get vm`             | List or inspect VirtualMachines                                                   |
| `idyl get webapp`         | List or inspect WebApps                                                           |

## Inherited flags

| Flag                                 | Description                                                        |
| ------------------------------------ | ------------------------------------------------------------------ |
| `-a <string>, --account-id <string>` | Account ID to use, overriding the current context.                 |
| `-c <string>, --context <string>`    | Use the named context for this command.                            |
| `--homedir <string>`                 | Override the configuration directory. Defaults to \~/.config/idyl. |
| `-n <string>, --namespace <string>`  | Namespace to use for this command.                                 |
| `-o <string>, --output <string>`     | Output format (json\|yaml).                                        |
| `-p <string>, --profile <string>`    | Override the access profile for this command.                      |
| `--realm <string>`                   | Override the realm for this command.                               |
| `--subnet <string>`                  | Override the context subnet for this command.                      |

## Examples

```bash theme={null}
# List all deployments in current namespace
idyl get deployments

# Get a specific pod
idyl get pod frontend-abc123

# List sandboxes
idyl get sandboxes

# Get a WebApp URL and status
idyl get webapp chat-api

# List secrets in the current namespace
idyl get secret

# Get a specific sandbox
idyl get sandbox dev

# List virtual machines
idyl get vms

# List all workloads
idyl get all

# List deployments in JSON format
idyl get deploy -o json
```

## Subcommand reference

### `idyl get all`

Get all workloads in the current namespace.

Shows deployments, replicasets, jobs, and cronjobs by default.
Use --pods flag to also include active and failed pods (limited to 100 max).

#### Usage

```bash theme={null}
idyl get all [flags]
```

#### Flags

| Flag                                | Description                                                       |
| ----------------------------------- | ----------------------------------------------------------------- |
| `--limit <int>`                     | Maximum number of items to list per resource type. Default: `20`. |
| `-n <string>, --namespace <string>` | Namespace name, overriding the current context.                   |
| `--offset <int>`                    | Number of items to skip. Default: `0`.                            |
| `-o <string>, --output <string>`    | Output format (json).                                             |
| `--pods`                            | Include active and failed pods, up to 100.                        |

#### Examples

```bash theme={null}
# Get all workloads (no pods)
idyl get all

# Get all workloads including pods
idyl get all --pods

# Get all with custom pod limit
idyl get all --pods --limit 50

# Get all in specific namespace
idyl get all -n production
```

### `idyl get cronjob`

Get cronjob details

#### Usage

```bash theme={null}
idyl get cronjob <name> [flags]
```

#### Aliases

* `cronjobs`
* `cj`

#### Flags

| Flag                                | Description                                        |
| ----------------------------------- | -------------------------------------------------- |
| `--limit <int>`                     | Maximum number of cronjobs to list. Default: `20`. |
| `-n <string>, --namespace <string>` | Namespace name, overriding the current context.    |
| `--offset <int>`                    | Number of cronjobs to skip. Default: `0`.          |
| `-o <string>, --output <string>`    | Output format (json\|yaml\|name).                  |

### `idyl get deployment`

Get deployment details

#### Usage

```bash theme={null}
idyl get deployment <name> [flags]
```

#### Aliases

* `deployments`
* `deploy`

#### Flags

| Flag                                | Description                                           |
| ----------------------------------- | ----------------------------------------------------- |
| `--limit <int>`                     | Maximum number of deployments to list. Default: `20`. |
| `-n <string>, --namespace <string>` | Namespace name, overriding the current context.       |
| `--offset <int>`                    | Number of deployments to skip. Default: `0`.          |
| `-o <string>, --output <string>`    | Output format (json\|yaml\|name).                     |
| `-w, --watch`                       | Watch for changes to deployments.                     |

### `idyl get gateway`

List Gateways in a namespace or inspect one Gateway by name.

#### Usage

```bash theme={null}
idyl get gateway [name] [flags]
```

#### Aliases

* `gateways`
* `gw`

#### Flags

| Flag                                | Description                                        |
| ----------------------------------- | -------------------------------------------------- |
| `--limit <int>`                     | Maximum number of gateways to list. Default: `20`. |
| `-n <string>, --namespace <string>` | Namespace name, overriding the current context.    |
| `--offset <int>`                    | Number of gateways to skip. Default: `0`.          |
| `-o <string>, --output <string>`    | Output format (json\|yaml\|name).                  |

#### Examples

```bash theme={null}
idyl get gateways
idyl get gateway web
idyl get gateway web -o yaml
```

### `idyl get httproute`

List HTTPRoutes in a namespace or inspect one HTTPRoute by name.

#### Usage

```bash theme={null}
idyl get httproute [name] [flags]
```

#### Aliases

* `httproutes`

#### Flags

| Flag                                | Description                                          |
| ----------------------------------- | ---------------------------------------------------- |
| `--limit <int>`                     | Maximum number of httproutes to list. Default: `20`. |
| `-n <string>, --namespace <string>` | Namespace name, overriding the current context.      |
| `--offset <int>`                    | Number of httproutes to skip. Default: `0`.          |
| `-o <string>, --output <string>`    | Output format (json\|yaml\|name).                    |

#### Examples

```bash theme={null}
idyl get httproutes
idyl get httproute web
idyl get httproute web -o yaml
```

### `idyl get job`

Get job details

#### Usage

```bash theme={null}
idyl get job <name> [flags]
```

#### Aliases

* `jobs`

#### Flags

| Flag                                | Description                                     |
| ----------------------------------- | ----------------------------------------------- |
| `--limit <int>`                     | Maximum number of jobs to list. Default: `20`.  |
| `-n <string>, --namespace <string>` | Namespace name, overriding the current context. |
| `--offset <int>`                    | Number of jobs to skip. Default: `0`.           |
| `-o <string>, --output <string>`    | Output format (json\|yaml\|name).               |
| `-w, --watch`                       | Watch for changes to jobs.                      |

### `idyl get pod`

Get pod details

#### Usage

```bash theme={null}
idyl get pod <name> [flags]
```

#### Aliases

* `pods`

#### Flags

| Flag                                | Description                                     |
| ----------------------------------- | ----------------------------------------------- |
| `--all`                             | Include completed pods.                         |
| `--limit <int>`                     | Maximum number of pods to list. Default: `20`.  |
| `-n <string>, --namespace <string>` | Namespace name, overriding the current context. |
| `--offset <int>`                    | Number of pods to skip. Default: `0`.           |
| `-o <string>, --output <string>`    | Output format (json\|yaml\|wide\|name).         |
| `-w, --watch`                       | Watch for changes to pods.                      |

### `idyl get referencegrant`

List ReferenceGrants in a namespace or inspect one ReferenceGrant by
name.

#### Usage

```bash theme={null}
idyl get referencegrant [name] [flags]
```

#### Aliases

* `referencegrants`

#### Flags

| Flag                                | Description                                               |
| ----------------------------------- | --------------------------------------------------------- |
| `--limit <int>`                     | Maximum number of referencegrants to list. Default: `20`. |
| `-n <string>, --namespace <string>` | Namespace name, overriding the current context.           |
| `--offset <int>`                    | Number of referencegrants to skip. Default: `0`.          |
| `-o <string>, --output <string>`    | Output format (json\|yaml\|name).                         |

#### Examples

```bash theme={null}
idyl get referencegrants
idyl get referencegrant from-web
idyl get referencegrant from-web -o yaml
```

### `idyl get replicaset`

Get replicaset details

#### Usage

```bash theme={null}
idyl get replicaset <name> [flags]
```

#### Aliases

* `replicasets`
* `rs`

#### Flags

| Flag                                | Description                                           |
| ----------------------------------- | ----------------------------------------------------- |
| `--limit <int>`                     | Maximum number of replicasets to list. Default: `20`. |
| `-n <string>, --namespace <string>` | Namespace name, overriding the current context.       |
| `--offset <int>`                    | Number of replicasets to skip. Default: `0`.          |
| `-o <string>, --output <string>`    | Output format (json\|yaml\|name).                     |
| `-w, --watch`                       | Watch for changes to replicasets.                     |

### `idyl get sandbox`

List Sandboxes in a namespace or inspect one Sandbox by name.

Use idyl get sandboxes to list Sandboxes. Use idyl get sandbox \<name> to show
details for one Sandbox, including TTL, expiry time, and the associated pod when
available. Expired Sandboxes are hidden from lists by default; use --all to
include them.

#### Usage

```bash theme={null}
idyl get sandbox [name] [flags]
```

#### Aliases

* `sandboxes`

#### Flags

| Flag                                | Description                                         |
| ----------------------------------- | --------------------------------------------------- |
| `--all`                             | Include expired Sandboxes.                          |
| `--limit <int>`                     | Maximum number of sandboxes to list. Default: `20`. |
| `-n <string>, --namespace <string>` | Namespace name, overriding the current context.     |
| `--offset <int>`                    | Number of sandboxes to skip. Default: `0`.          |
| `-o <string>, --output <string>`    | Output format (json\|yaml\|name).                   |

#### Examples

```bash theme={null}
# List Sandboxes
idyl get sandboxes

# Include expired Sandboxes
idyl get sandboxes --all

# Inspect one Sandbox
idyl get sandbox dev

# Return one Sandbox as YAML
idyl get sandbox dev -o yaml
```

### `idyl get secret`

List redacted secret metadata in the selected namespace or inspect one
secret by name.

#### Usage

```bash theme={null}
idyl get secret [name] [flags]
```

#### Aliases

* `secrets`

#### Flags

| Flag                                | Description                                            |
| ----------------------------------- | ------------------------------------------------------ |
| `--limit <int>`                     | Maximum number of secrets to list. Default: `20`.      |
| `-n <string>, --namespace <string>` | Namespace name, overriding the current context.        |
| `--offset <int>`                    | Number of secrets to skip. Default: `0`.               |
| `-o <string>, --output <string>`    | Output format: table, json, or yaml. Default: `table`. |
| `--subnet <string>`                 | Subnet whose API host should serve the request.        |

#### Examples

```bash theme={null}
# List secrets in the current namespace
idyl get secret --subnet <subnet>

# Get one secret
idyl get secret ghcr-prod --subnet <subnet>

# List secrets as JSON
idyl get secret --subnet <subnet> -o json
```

### `idyl get service`

List Services in a namespace or inspect one Service by name.

#### Usage

```bash theme={null}
idyl get service [name] [flags]
```

#### Aliases

* `services`

#### Flags

| Flag                                | Description                                        |
| ----------------------------------- | -------------------------------------------------- |
| `--limit <int>`                     | Maximum number of services to list. Default: `20`. |
| `-n <string>, --namespace <string>` | Namespace name, overriding the current context.    |
| `--offset <int>`                    | Number of services to skip. Default: `0`.          |
| `-o <string>, --output <string>`    | Output format (json\|yaml\|name).                  |

#### Examples

```bash theme={null}
idyl get services
idyl get service chat-api
idyl get service chat-api -o yaml
```

### `idyl get tlsroute`

List TLSRoutes in a namespace or inspect one TLSRoute by name.

#### Usage

```bash theme={null}
idyl get tlsroute [name] [flags]
```

#### Aliases

* `tlsroutes`

#### Flags

| Flag                                | Description                                         |
| ----------------------------------- | --------------------------------------------------- |
| `--limit <int>`                     | Maximum number of tlsroutes to list. Default: `20`. |
| `-n <string>, --namespace <string>` | Namespace name, overriding the current context.     |
| `--offset <int>`                    | Number of tlsroutes to skip. Default: `0`.          |
| `-o <string>, --output <string>`    | Output format (json\|yaml\|name).                   |

#### Examples

```bash theme={null}
idyl get tlsroutes
idyl get tlsroute db
idyl get tlsroute db -o yaml
```

### `idyl get vm`

List VirtualMachines in a namespace or inspect one VirtualMachine by name.

#### Usage

```bash theme={null}
idyl get vm [name] [flags]
```

#### Aliases

* `vms`
* `virtualmachine`
* `virtualmachines`

#### Flags

| Flag                                | Description                                                |
| ----------------------------------- | ---------------------------------------------------------- |
| `--limit <int>`                     | Maximum number of virtual machines to list. Default: `20`. |
| `-n <string>, --namespace <string>` | Namespace name, overriding the current context.            |
| `--offset <int>`                    | Number of virtual machines to skip. Default: `0`.          |
| `-o <string>, --output <string>`    | Output format (json\|yaml\|name).                          |

#### Examples

```bash theme={null}
# List VirtualMachines
idyl get vms

# Inspect one VirtualMachine
idyl get vm dev-vm

# Return one VirtualMachine as YAML
idyl get vm dev-vm -o yaml
```

### `idyl get webapp`

List WebApps in a namespace or inspect one WebApp by name.

#### Usage

```bash theme={null}
idyl get webapp [name] [flags]
```

#### Aliases

* `webapps`

#### Flags

| Flag                                | Description                                       |
| ----------------------------------- | ------------------------------------------------- |
| `--limit <int>`                     | Maximum number of webapps to list. Default: `20`. |
| `-n <string>, --namespace <string>` | Namespace name, overriding the current context.   |
| `--offset <int>`                    | Number of webapps to skip. Default: `0`.          |
| `-o <string>, --output <string>`    | Output format (json\|yaml\|name).                 |

#### Examples

```bash theme={null}
idyl get webapps
idyl get webapp chat-api
idyl get webapp chat-api -o json
```