> ## Documentation Index
> Fetch the complete documentation index at: https://docs.murmur.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# murmur defaults

> Print the platform's initial values for a new catalog resource as editable YAML, without creating anything.

Prints the platform's creation template for a catalog kind: the initial field values for a new resource. Nothing is created. Edit the template, complete it, and submit it with [`murmur set`](/cli/set).

The template is partial. Fill in the required fields before you submit it. Check the required input format with [`murmur describe <kind>`](/cli/describe): markdown kinds take a markdown document rather than this YAML field listing.

## Synopsis

```bash theme={null}
murmur defaults [--json] <kind>
```

## Arguments

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | string | yes | The catalog kind, for example `workspace`. Run [`murmur describe`](/cli/describe) to list kinds. |
| `--json` | bool | no | Print a JSON object with `kind`, `configured`, and `payload` instead of YAML. The payload is decoded, not base64. Default: `false`. |

Reading defaults requires read permission on the kind.

## Output

By default the template prints as YAML. A kind with no configured template prints `{}`.

With `--json`, the command prints one object:

| Field | Meaning |
| - | - |
| `kind` | The requested kind. |
| `configured` | `true` when the platform has a template for the kind, including an empty one. |
| `payload` | The template as a JSON object. |

## Examples

### Create a workspace from its template

```bash theme={null}
murmur defaults workspace > workspace.yaml
# Edit workspace.yaml, then:
murmur set workspace my-project --if-generation 0 < workspace.yaml
```

`--if-generation 0` makes the write a create: it fails if a workspace with that name already exists.

### Check whether a template is configured

```bash theme={null}
murmur defaults --json recipe
```

## Errors

| Code | Meaning | What to do |
| - | - | - |
| `FAILED_PRECONDITION` | `creation defaults are not supported for <kind>` | The kind has no creation template, such as a kind whose values are write-only. Write the resource from scratch using [`murmur describe <kind>`](/cli/describe). |
| `INVALID_ARGUMENT` | `unknown resource kind "<kind>"` | Run [`murmur describe`](/cli/describe) to list kinds. |
| `PERMISSION_DENIED` | You cannot read resources of this kind. | Ask for a role that grants read access to the kind. See [authorization](/security/authorization). |
| `UNAVAILABLE` | `catalog creation defaults are not loaded` | Retry later. |

## Related

* [`murmur set`](/cli/set): create or replace a catalog resource
* [`murmur describe`](/cli/describe): list kinds and their fields
* [`murmur get`](/cli/get): read an existing resource
* [Catalog resources](/catalog/overview): every catalog kind