# kindgi flows

> Manage flow registrations: publish, list, versions, unregister, reinstate

## `kindgi flows`

**Synopsis**

```sh signature
kindgi flows <command>
```

Manage flow registrations: publish, list, versions, unregister, reinstate.

**Commands**

| Command                                                                                                    | Description                                                                                              |
| ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| [`kindgi flows list`](https://docs.kindgi.com/v0.1.9/reference/cli/flows.md#kindgi-flows-list)             | List registered flows (the latest version of each).                                                      |
| [`kindgi flows get`](https://docs.kindgi.com/v0.1.9/reference/cli/flows.md#kindgi-flows-get)               | Fetch a registered flow: its latest version, or the version given.                                       |
| [`kindgi flows publish`](https://docs.kindgi.com/v0.1.9/reference/cli/flows.md#kindgi-flows-publish)       | Register a flow definition at its version.                                                               |
| [`kindgi flows unregister`](https://docs.kindgi.com/v0.1.9/reference/cli/flows.md#kindgi-flows-unregister) | Unregister a specific flow version: new runs of it are refused; `kindgi flows reinstate` brings it back. |
| [`kindgi flows versions`](https://docs.kindgi.com/v0.1.9/reference/cli/flows.md#kindgi-flows-versions)     | List the registered versions of a flow.                                                                  |
| [`kindgi flows reinstate`](https://docs.kindgi.com/v0.1.9/reference/cli/flows.md#kindgi-flows-reinstate)   | Bring back an unregistered flow version.                                                                 |

**See also**

- [Write a flow](https://docs.kindgi.com/v0.1.9/guides/flows/write-a-flow.md)
- [Flows](https://docs.kindgi.com/v0.1.9/guides/flows.md)

### `kindgi flows list`

**Synopsis**

```sh signature
kindgi flows list [--name=<prefix>] [--include-retired] [--limit=<n>] [--cursor=<c>]
```

List registered flows (the latest version of each).

**Options**

| Option              | Default              | Description                                                                                            |
| ------------------- | -------------------- | ------------------------------------------------------------------------------------------------------ |
| `--cursor <value>`  | none                 | Resume after this cursor, from the previous page's `nextCursor`.                                       |
| `--include-retired` | off                  | Include retired flows (every version unregistered), each as its highest version with `unregisteredAt`. |
| `--limit <value>`   | `25` (at most `100`) | The most to return (default 25, at most 100).                                                          |
| `--name <value>`    | none                 | Only flows whose id starts with this.                                                                  |

Every command also takes the [global flags](https://docs.kindgi.com/v0.1.9/reference/cli.md#global-flags).

**Examples**

List registered flows, retired ones too.

```sh
kindgi flows list --include-retired
```

**See also**

- [Write a flow](https://docs.kindgi.com/v0.1.9/guides/flows/write-a-flow.md)
- [Flows](https://docs.kindgi.com/v0.1.9/guides/flows.md)
- [`kindgi flows`](https://docs.kindgi.com/v0.1.9/reference/cli/flows.md#kindgi-flows)

### `kindgi flows get`

**Synopsis**

```sh signature
kindgi flows get <flow-id> [<version>]
```

Fetch a registered flow: its latest version, or the version given.

**Options**

Every command also takes the [global flags](https://docs.kindgi.com/v0.1.9/reference/cli.md#global-flags).

**Examples**

Fetch a flow's latest version.

```sh
kindgi flows get acme.nightly-digest
```

Fetch one version of a flow.

```sh
kindgi flows get acme.nightly-digest 0.1.0
```

**See also**

- [Write a flow](https://docs.kindgi.com/v0.1.9/guides/flows/write-a-flow.md)
- [Flows](https://docs.kindgi.com/v0.1.9/guides/flows.md)
- [`kindgi flows`](https://docs.kindgi.com/v0.1.9/reference/cli/flows.md#kindgi-flows)

### `kindgi flows publish`

**Synopsis**

```sh signature
kindgi flows publish --spec=<json-or-@file> [--project=<project-id>]
```

Register a flow definition at its version. The server checks it: no cycles, every node and edge resolves.

**Options**

| Option              | Default                      | Description                                                                         |
| ------------------- | ---------------------------- | ----------------------------------------------------------------------------------- |
| `--project <value>` | the tenant's Default project | The project to register the flow in, by id (default: the tenant's Default project). |
| `--spec <value>`    | required                     | The flow definition as JSON, or `@<file>` to read it from a file. Required.         |

Every command also takes the [global flags](https://docs.kindgi.com/v0.1.9/reference/cli.md#global-flags).

**Examples**

Register a flow definition from a file.

```sh
kindgi flows publish --spec=@flows/acme.nightly-digest.json
```

**See also**

- [Write a flow](https://docs.kindgi.com/v0.1.9/guides/flows/write-a-flow.md)
- [Flows](https://docs.kindgi.com/v0.1.9/guides/flows.md)
- [`kindgi flows`](https://docs.kindgi.com/v0.1.9/reference/cli/flows.md#kindgi-flows)

### `kindgi flows unregister`

**Synopsis**

```sh signature
kindgi flows unregister <flow-id> <version>
```

Unregister a specific flow version: new runs of it are refused; `kindgi flows reinstate` brings it back.

**Options**

Every command also takes the [global flags](https://docs.kindgi.com/v0.1.9/reference/cli.md#global-flags).

**Examples**

Unregister a flow version: new runs of it are refused.

```sh
kindgi flows unregister acme.nightly-digest 0.1.0
```

**See also**

- [Write a flow](https://docs.kindgi.com/v0.1.9/guides/flows/write-a-flow.md)
- [Flows](https://docs.kindgi.com/v0.1.9/guides/flows.md)
- [`kindgi flows`](https://docs.kindgi.com/v0.1.9/reference/cli/flows.md#kindgi-flows)

### `kindgi flows versions`

**Synopsis**

```sh signature
kindgi flows versions <flow-id> [--include-unregistered] [--limit=<n>] [--cursor=<c>]
```

List the registered versions of a flow.

**Options**

| Option                   | Default              | Description                                                                       |
| ------------------------ | -------------------- | --------------------------------------------------------------------------------- |
| `--cursor <value>`       | none                 | Resume after this cursor, from the previous page's `nextCursor`.                  |
| `--include-unregistered` | off                  | Include unregistered versions (each with `unregisteredAt`), a retired flow's too. |
| `--limit <value>`        | `25` (at most `100`) | The most to return (default 25, at most 100).                                     |

Every command also takes the [global flags](https://docs.kindgi.com/v0.1.9/reference/cli.md#global-flags).

**Examples**

List a flow's versions, unregistered ones too.

```sh
kindgi flows versions acme.nightly-digest --include-unregistered
```

**See also**

- [Write a flow](https://docs.kindgi.com/v0.1.9/guides/flows/write-a-flow.md)
- [Flows](https://docs.kindgi.com/v0.1.9/guides/flows.md)
- [`kindgi flows`](https://docs.kindgi.com/v0.1.9/reference/cli/flows.md#kindgi-flows)

### `kindgi flows reinstate`

**Synopsis**

```sh signature
kindgi flows reinstate <flow-id> <version>
```

Bring back an unregistered flow version.

**Options**

Every command also takes the [global flags](https://docs.kindgi.com/v0.1.9/reference/cli.md#global-flags).

**Examples**

Bring back an unregistered flow version.

```sh
kindgi flows reinstate acme.nightly-digest 0.1.0
```

**See also**

- [Write a flow](https://docs.kindgi.com/v0.1.9/guides/flows/write-a-flow.md)
- [Flows](https://docs.kindgi.com/v0.1.9/guides/flows.md)
- [`kindgi flows`](https://docs.kindgi.com/v0.1.9/reference/cli/flows.md#kindgi-flows)