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.
Describes the available catalog resource kinds. Without a kind argument, lists all kinds with their input format and description. With a kind argument, shows the full schema — fields, types, references, and a template document.
Synopsis
Arguments
| Name | Type | Required | Description |
|---|
kind | string | no | A specific catalog resource kind to describe. When omitted, lists all available kinds. |
Output
List mode (no kind)
Prints a table of all available kinds.
| Column | Description |
|---|
KIND | The resource kind name (used with murmur get, murmur set, murmur patch, murmur rm). |
FORMAT | Input format: INPUT_FORMAT_YAML or INPUT_FORMAT_MARKDOWN. |
DESCRIPTION | One-line description of the kind. |
Detail mode (with kind)
Prints the full schema for a single kind.
| Section | Description |
|---|
| Kind | The resource kind name. |
| Input format | Whether murmur set expects YAML or markdown input. |
| Description | One-line description. |
| Template | A pre-rendered example document with placeholder values for required fields and commented-out optional fields. |
| References | Cross-kind references — fields on this kind that point to other catalog resources by name. |
| Fields | A table of every field: name, type, whether it is required, and documentation. |
Examples
List all kinds
KIND FORMAT DESCRIPTION
workspace INPUT_FORMAT_YAML Workspace configuration
environment INPUT_FORMAT_YAML VM compute shape
placement INPUT_FORMAT_YAML Infrastructure target
pool-config INPUT_FORMAT_YAML Tenant-wide VM pool limits
agent-persona INPUT_FORMAT_MARKDOWN Agent persona definition
flight INPUT_FORMAT_MARKDOWN Multi-agent flight document
secret INPUT_FORMAT_YAML Tenant-scoped secret
recipe INPUT_FORMAT_YAML Image build definition
Describe a specific kind
murmur describe environment
Kind: environment
Input format: INPUT_FORMAT_YAML
Description: VM compute shape
Template:
name: <name>
substrate: SUBSTRATE_GCP
machine_type_ref: <machine-type-name>
# disk_size_gb: 0
# disk_type_ref: <disk-type-name>
# description: ""
References:
machine_type_ref → machine-type
disk_type_ref → disk-type
Fields:
NAME TYPE REQUIRED DOC
name string yes Unique name. DNS label format.
substrate enum(Substrate) yes Compute substrate.
machine_type_ref string yes Machine type name.
disk_size_gb int32 Boot disk size in GiB. 0 = image default.
disk_type_ref string Disk type name.
description string Human-readable description.
Errors
| Code | Meaning | What to do |
|---|
UNAUTHENTICATED | Identity token is missing or expired. | Run murmur auth or check your murmur.local.yaml configuration. |
NOT_FOUND | The specified kind does not exist. | Run murmur describe without arguments to list valid kinds. |
