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

> Read admitted input and recorded outcomes

Read durable Invocation state through the development population API.
Process and save references appear only when the service reports them. Reading
an Invocation never retries delivery or starts another execution.

## Usage

```bash theme={null}
idyl invocation
```

## Aliases

* `invocations`

## Commands

| Command | Description |
| - | - |
| `idyl invocation get` | Read an Invocation and its reported outcome |
| `idyl invocation wait` | Wait for an Invocation's outcome |

## 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 address, overriding the entered context. |
| `--network <string>` | Override the Network for this command. |
| `-p <string>, --profile <string>` | Override the access profile for this command. |
| `-s <string>, --subnet <string>` | Subnet to use for this command, overriding the current context. |

## Subcommand reference

### `idyl invocation get`

Read an Invocation and its reported outcome

#### Usage

```bash theme={null}
idyl invocation get <invocation-id> [flags]
```

#### Flags

| Flag | Description |
| - | - |
| `-o <string>, --output <string>` | Output format: table, json, yaml. Default: `table`. |

### `idyl invocation wait`

Wait for an Invocation to reach a terminal outcome by re-reading it.

The wait is a client convenience: it holds no connection open between reads,
and cancelling it never cancels, retries or replays the admitted work. Progress
reports pending, delivered, saving and the terminal outcome on standard error;
the final Invocation is printed on standard output.

Conditions:
succeeded  the Invocation succeeded
terminal   the Invocation succeeded, failed, was lost or was interrupted

Exit status follows 'idyl wait': 0 when the condition is reached, 124 when the
deadline passes first, 125 when a terminal outcome other than succeeded means
\--for=succeeded will not be reached, and 1 when the command could not run.

#### Usage

```bash theme={null}
idyl invocation wait <invocation-id> [flags]
```

#### Flags

| Flag | Description |
| - | - |
| `--for <string>` | Required. Condition to wait for: succeeded or terminal. |
| `-o <string>, --output <string>` | Output format: table, json, yaml. Default: `table`. |
| `--timeout <duration>` | Maximum time to wait; 0s checks the current state only. Default: `5m0s`. |

#### Examples

```bash theme={null}
idyl invocation wait 01890a5d-ac96-774b-bcce-b302099a8061 --for succeeded
idyl invocation wait 01890a5d-ac96-774b-bcce-b302099a8061 --for terminal --timeout 30m -o json
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.