murmur describe

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

murmur describe [kind]

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. Each line carries the field’s documentation as a trailing comment.
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

murmur describe

The real output lists every kind. This excerpt shows a few:

KIND                     FORMAT                 DESCRIPTION
agent-persona            INPUT_FORMAT_MARKDOWN  Agent persona: markdown file with YAML front-matter defining a reusable coding agent.
environment              INPUT_FORMAT_YAML      Pure compute shape for agent VMs: substrate, machine type, disk type, and disk size. Placement-agnostic.
flight                   INPUT_FORMAT_MARKDOWN  Flight: markdown DSL defining a multi-agent workflow with triggers and scheduling.
placement                INPUT_FORMAT_YAML      Cloud target for agent VMs: project, zone, network, and WIF credentials.
recipe                   INPUT_FORMAT_YAML      Provisioning recipe: base image(s) + script. Multi-substrate: references per-substrate base images.
secret                   INPUT_FORMAT_YAML      Tenant secret: KMS-encrypted env var delivered to agent VMs. Write-only — values are never readable.
workspace                INPUT_FORMAT_YAML      Launchable preset: composes an image, an environment, a placement, secrets, and repos.

Describe a specific kind

murmur describe environment

Kind:         environment
Input format: INPUT_FORMAT_YAML
Description:  Pure compute shape for agent VMs: substrate, machine type, disk type, and disk size. Placement-agnostic.

Template:
  name: <name>  # Unique name. DNS label format: [a-z][a-z0-9-]{0,62}.
  substrate: <SUBSTRATE_GCP | SUBSTRATE_AWS>  # Compute substrate. Values: SUBSTRATE_GCP, SUBSTRATE_AWS.
  machine_type_ref: <machine_type_ref>  # Machine type name. Must match this environment's substrate.
  # disk_size_gb: 0  # Boot disk size in GiB. 0 = image default.
  # description: <description>  # Human-readable description.
  # disk_type_ref: <disk_type_ref>  # Disk type name. Required for GCP and AWS substrates.
  # provisioning_models: []  # Provisioning models to allocate capacity from, in preference order. Empty means on-demand only. A VM falls back to the next listed model only when the cloud has no capacity left — a permission or quota error fails the creation. Spot eligibility comes from the machine type's per-region spot_cost_per_hour: a list naming both models allocates on-demand in a region that prices no Spot rate, while a Spot-only list is rejected on write when the machine type prices no Spot rate anywhere. Spot is supported on SUBSTRATE_GCP.


References:
  machine_type_ref → machine-type
  disk_type_ref → disk-type

Fields:
  NAME                 TYPE                     REQUIRED  DOC
  name                 string                   yes       Unique name. DNS label format: [a-z][a-z0-9-]{0,62}.
  substrate            enum(Substrate)          yes       Compute substrate. Values: SUBSTRATE_GCP, SUBSTRATE_AWS.
  machine_type_ref     string                   yes       Machine type name. Must match this environment's substrate.
  disk_size_gb         int32                              Boot disk size in GiB. 0 = image default.
  description          string                             Human-readable description.
  disk_type_ref        string                             Disk type name. Required for GCP and AWS substrates.
  provisioning_models  enum(ProvisioningModel)            Provisioning models to allocate capacity from, in preference order. Empty means on-demand only. A VM falls back to the next listed model only when the cloud has no capacity left — a permission or quota error fails the creation. Spot eligibility comes from the machine type's per-region spot_cost_per_hour: a list naming both models allocates on-demand in a region that prices no Spot rate, while a Spot-only list is rejected on write when the machine type prices no Spot rate anywhere. Spot is supported on SUBSTRATE_GCP.

Errors

Code	Meaning	What to do
`UNAUTHENTICATED`	Identity token is missing or expired.	Run `murmur login`, or check your `murmur.local.yaml` configuration.
`NOT_FOUND`	`unknown kind "<kind>"`: the specified kind does not exist.	Run `murmur describe` without arguments to list valid kinds.

Catalog — concept overview
murmur get — read a resource or list resources of a kind
murmur set — create or fully replace a resource
murmur patch — update individual fields on a resource
murmur rm — delete a resource

Getting Started

Core Concepts

Guides

murmur describe

Synopsis

Arguments

Output

List mode (no kind)

Detail mode (with kind)

Examples

List all kinds

Describe a specific kind

Errors

​Synopsis

​Arguments

​Output

​List mode (no kind)

​Detail mode (with kind)

​Examples

​List all kinds

​Describe a specific kind

​Errors

​Related

Synopsis

Arguments

Output

List mode (no kind)

Detail mode (with kind)

Examples

List all kinds

Describe a specific kind

Errors

Related