# kindgi guardrails

> Manage guardrail registrations

## `kindgi guardrails`

**Synopsis**

```sh signature
kindgi guardrails <command>
```

Manage guardrail registrations.

**Commands**

| Command                                                                                                                   | Description                 |
| ------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
| [`kindgi guardrails list`](https://docs.kindgi.com/v0.1.8/reference/cli/guardrails.md#kindgi-guardrails-list)             | List registered guardrails. |
| [`kindgi guardrails get`](https://docs.kindgi.com/v0.1.8/reference/cli/guardrails.md#kindgi-guardrails-get)               | Fetch a guardrail by id.    |
| [`kindgi guardrails register`](https://docs.kindgi.com/v0.1.8/reference/cli/guardrails.md#kindgi-guardrails-register)     | Register a guardrail.       |
| [`kindgi guardrails unregister`](https://docs.kindgi.com/v0.1.8/reference/cli/guardrails.md#kindgi-guardrails-unregister) | Unregister a guardrail.     |

**See also**

- [Configure a guardrail](https://docs.kindgi.com/v0.1.8/guides/guardrails/configure-a-guardrail.md)

### `kindgi guardrails list`

**Synopsis**

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

List registered guardrails.

**Options**

| Option             | Default              | Description                                                      |
| ------------------ | -------------------- | ---------------------------------------------------------------- |
| `--cursor <value>` | none                 | Resume after this cursor, from the previous page's `nextCursor`. |
| `--limit <value>`  | `25` (at most `100`) | The most guardrails to return (default 25, at most 100).         |
| `--name <value>`   | none                 | Only the guardrails whose id starts with this prefix.            |

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

**Examples**

List the guardrails whose id starts with a prefix.

```sh
kindgi guardrails list --name=acme.
```

**See also**

- [Configure a guardrail](https://docs.kindgi.com/v0.1.8/guides/guardrails/configure-a-guardrail.md)
- [`kindgi guardrails`](https://docs.kindgi.com/v0.1.8/reference/cli/guardrails.md#kindgi-guardrails)

### `kindgi guardrails get`

**Synopsis**

```sh signature
kindgi guardrails get <guardrail-id>
```

Fetch a guardrail by id.

**Options**

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

**Examples**

From [Configure a guardrail](https://docs.kindgi.com/v0.1.8/guides/guardrails/configure-a-guardrail.md):

```sh
pnpm exec kindgi guardrails get my-pack.answer-length
```

**See also**

- [Configure a guardrail](https://docs.kindgi.com/v0.1.8/guides/guardrails/configure-a-guardrail.md)
- [`kindgi guardrails`](https://docs.kindgi.com/v0.1.8/reference/cli/guardrails.md#kindgi-guardrails)

### `kindgi guardrails register`

**Synopsis**

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

Register a guardrail.

**Options**

| Option              | Default                      | Description                                                                              |
| ------------------- | ---------------------------- | ---------------------------------------------------------------------------------------- |
| `--project <value>` | the tenant's Default project | The project to register the guardrail in, by id (default: the tenant's Default project). |
| `--spec <value>`    | required                     | The guardrail 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.8/reference/cli.md#global-flags).

**Examples**

Register a guardrail from a file in a given project.

```sh
kindgi guardrails register --spec=@guardrails/acme.no-refunds.json --project=<project-id>
```

**See also**

- [Configure a guardrail](https://docs.kindgi.com/v0.1.8/guides/guardrails/configure-a-guardrail.md)
- [`kindgi guardrails`](https://docs.kindgi.com/v0.1.8/reference/cli/guardrails.md#kindgi-guardrails)

### `kindgi guardrails unregister`

**Synopsis**

```sh signature
kindgi guardrails unregister <guardrail-id>
```

Unregister a guardrail.

**Options**

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

**Examples**

Unregister a guardrail.

```sh
kindgi guardrails unregister acme.no-refunds
```

**See also**

- [Configure a guardrail](https://docs.kindgi.com/v0.1.8/guides/guardrails/configure-a-guardrail.md)
- [`kindgi guardrails`](https://docs.kindgi.com/v0.1.8/reference/cli/guardrails.md#kindgi-guardrails)