# Secrets CLI reference

Source: `@socra/secret-cli@0.0.1`.

This reference includes every command, argument, and option declared by this released package. Defaults and accepted values are included where the package declares them. Command-specific validation and permissions also apply; see the [API reference](/docs/secret/reference/api) for resource contracts.

Use `socra secret --help`, or append `--help` to any command, to inspect the locally installed version.

## socra secret

Manage project-scoped write-only runtime secrets

| Command | Purpose |
| --- | --- |
| `socra secret create` | Create a secret; optionally add its first version from a safe input source |
| `socra secret get` | Show secret metadata (never its value) |
| `socra secret list` | List secrets for a project |
| `socra secret update` | Update secret metadata |
| `socra secret delete` | Delete a secret and all material versions |
| `socra secret version` | Manage immutable secret material versions |

## socra secret create

Create a secret; optionally add its first version from a safe input source

```text
socra secret create <name> [options]
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `name` | Yes | Lowercase secret name |

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--project` | Value | Socra project id |
| `--description` | Value | Human-readable description |
| `--from-file` | Value | Read secret material from a file |
| `--from-env` | Value | Read secret material from an environment variable |
| `--stdin` | Presence flag | Read secret material from standard input |

## socra secret get

Show secret metadata (never its value)

```text
socra secret get <id>
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Secret id |

## socra secret list

List secrets for a project

```text
socra secret list [options]
```

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--project` | Value | Socra project id |
| `--status` | Value | active or disabled |
| `--limit` | Value | Page size |
| `--after` | Value | Page cursor |

## socra secret update

Update secret metadata

```text
socra secret update <id> [options]
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Secret id |

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--description` | Value | New description |
| `--clear-description` | Presence flag | Remove the description |
| `--status` | Value | active or disabled |

## socra secret delete

Delete a secret and all material versions

```text
socra secret delete <id>
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Secret id |

## socra secret version

Manage immutable secret material versions

| Command | Purpose |
| --- | --- |
| `socra secret version add` | Add a write-only version |
| `socra secret version get` | Show version metadata |
| `socra secret version list` | List a secret’s versions |
| `socra secret version enable` | Allow a version to be bound |
| `socra secret version disable` | Prevent new bindings to a version |

## socra secret version add

Add a write-only version

```text
socra secret version add <secret> [options]
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `secret` | Yes | Secret id |

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--from-file` | Value | Read secret material from a file |
| `--from-env` | Value | Read secret material from an environment variable |
| `--stdin` | Presence flag | Read secret material from standard input |

## socra secret version get

Show version metadata

```text
socra secret version get <id>
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Secret version id |

## socra secret version list

List a secret’s versions

```text
socra secret version list <secret> [options]
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `secret` | Yes | Secret id |

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--limit` | Value | Page size |
| `--after` | Value | Page cursor |

## socra secret version enable

Allow a version to be bound

```text
socra secret version enable <id>
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Secret version id |

## socra secret version disable

Prevent new bindings to a version

```text
socra secret version disable <id>
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Secret version id |

## Next step

Return to the [Secrets overview](/docs/secret).

---

Company: Socra — Multiply Your Judgment
Canonical URL: https://cloud.socra.com/docs/secret/reference/cli