> ## 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 wait

> Wait for a workload resource condition

Wait for a workload resource to reach a condition.

The --for condition is required. The --timeout flag defaults to 5m. Set
\--timeout=0s to evaluate the current resource snapshot only and exit without
watching for changes.

Supported resources and conditions:

* pod: started, ready, complete, deleted
* sandbox: started, ready, deleted
* job: started, complete, deleted
* deployment: started, ready, deleted
* replicaset: started, ready, deleted

Resource aliases match the rest of the CLI:

* deployment, deployments, deploy
* replicaset, replicasets, rs
* pod, pods
* job, jobs
* sandbox, sandboxes

## Usage

```bash theme={null}
idyl wait <resource> <name>|<resource>/<name>
```

## Commands

| Command                | Description                     |
| ---------------------- | ------------------------------- |
| `idyl wait deployment` | Wait for a deployment condition |
| `idyl wait job`        | Wait for a job condition        |
| `idyl wait pod`        | Wait for a pod condition        |
| `idyl wait replicaset` | Wait for a replicaset condition |
| `idyl wait sandbox`    | Wait for a sandbox condition    |

## Flags

| Flag                   | Description                                                                                 |
| ---------------------- | ------------------------------------------------------------------------------------------- |
| `--for <string>`       | Required. Condition to wait for (started, ready, complete, or deleted; varies by resource). |
| `--timeout <duration>` | Maximum time to wait; 0s checks the current resource snapshot only. Default: `5m0s`.        |

## 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}
idyl wait pod web-abc --for=ready
idyl wait sandbox/dev --for=ready --timeout=2m
idyl wait job migrate --for=complete --timeout=10m
idyl wait deployment api --for=ready
idyl wait replicaset api-rs --for=ready
idyl wait sandbox dev --for=deleted --timeout=0s
```

## Subcommand reference

### `idyl wait deployment`

Wait for a deployment condition

#### Usage

```bash theme={null}
idyl wait deployment <name>
```

#### Aliases

* `deployments`
* `deploy`

### `idyl wait job`

Wait for a job condition

#### Usage

```bash theme={null}
idyl wait job <name>
```

#### Aliases

* `jobs`

### `idyl wait pod`

Wait for a pod condition

#### Usage

```bash theme={null}
idyl wait pod <name>
```

#### Aliases

* `pods`

### `idyl wait replicaset`

Wait for a replicaset condition

#### Usage

```bash theme={null}
idyl wait replicaset <name>
```

#### Aliases

* `replicasets`
* `rs`

### `idyl wait sandbox`

Wait for a sandbox condition

#### Usage

```bash theme={null}
idyl wait sandbox <name>
```

#### Aliases

* `sandboxes`