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

> Read population invocation rounds and download their files

An invocation round is one input admitted for a fixed index range of a Run, with
one Invocation per member. Reading a round wakes no Actor. Its saved files are
downloaded from each member's saved version without waking anything.

## Usage

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

## Aliases

* `rounds`

## Commands

| Command | Description |
| - | - |
| `idyl round download` | Download each member's saved files into a directory |
| `idyl round get` | Read invocation round progress |
| `idyl round members` | Read one indexed page of round members |
| `idyl round wait` | Wait for every member of a round to settle |

## 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 round download`

Admit a saved-file download over an invocation round and write each member's
saved files into \<dir>/\<actor-id>/ as soon as its saved version is selected.

A member's version is selected once its round Invocation is terminal, from its
saved versions only: no Actor is woken and no save is requested. Different
members can be selected at different times; there is no population-wide
snapshot. Every name is confined to its member's directory, file content is
verified against its listed SHA-256 and symlinks are written as links. Retry
with the same idempotency key to resume the same selection.

Exit status follows 'idyl wait': 0 when every member was downloaded, 124 when
the deadline passes first, 125 when members failed (their reasons are named),
and 1 when the command could not run.

#### Usage

```bash theme={null}
idyl round download <round-id> [flags]
```

#### Flags

| Flag | Description |
| - | - |
| `--dir <string>` | Required. Local directory that receives one \<actor-id> directory per member. |
| `--end <string>` | End index of the download, exclusive; requires --start. |
| `--idempotency-key <string>` | Required. Stable admission key; reuse it to resume the same selection. |
| `-o <string>, --output <string>` | Output format: table, json, yaml. Default: `table`. |
| `--start <string>` | First index of the download, inclusive; requires --end. |
| `--timeout <duration>` | Maximum time to wait for every member; 0s downloads what is selected now. Default: `5m0s`. |

### `idyl round get`

Read invocation round progress

#### Usage

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

#### Flags

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

### `idyl round members`

List one cursor page of the round's fixed indices, including members whose
Actor is not yet created, with each member's Invocation identity. Use the opaque
continuation unchanged to request the next page.

#### Usage

```bash theme={null}
idyl round members <round-id> [flags]
```

#### Flags

| Flag | Description |
| - | - |
| `--continue <string>` | Opaque cursor from the previous page. |
| `--limit <uint>` | Maximum items in one page; zero uses the service default. Default: `0`. |
| `-o <string>, --output <string>` | Output format: table, json, yaml. Default: `table`. |

### `idyl round wait`

Wait for an invocation round's members to reach terminal outcomes 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 admitted work. Progress
goes to standard error; the final round is printed on standard output.

Conditions:
succeeded  every member's Invocation succeeded
settled    every member has a terminal outcome, whichever it is

Exit status follows 'idyl wait': 0 when the condition is reached, 124 when the
deadline passes first, 125 when the round settled with failed, lost or
interrupted members so --for=succeeded will not be reached, and 1 when the
command could not run.

#### Usage

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

#### Flags

| Flag | Description |
| - | - |
| `--for <string>` | Required. Condition to wait for: succeeded or settled. |
| `-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 round wait 01890a5d-ac96-774b-bcce-b302099a8061 --for succeeded
idyl round wait 01890a5d-ac96-774b-bcce-b302099a8061 --for settled --timeout 2h -o json
```


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