Skip to content
Switchyard — Local Development Command Center

Generated CLI envelope schemas

This page is generated by building cmd/switchyard and invoking the schema subcommand for every command registered by the binary. Do not edit it manually.

debug.logs

{
  "$id": "https://switchyard.dev/schema/cli/debug-logs.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "debug.logs"
    },
    "data": {
      "items": {
        "type": "object"
      },
      "type": "array"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

doctor

{
  "$id": "https://switchyard.dev/schema/cli/doctor.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "doctor"
    },
    "data": {
      "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/SystemInfo"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

doctor.bundle

{
  "$id": "https://switchyard.dev/schema/cli/doctor-bundle.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "doctor.bundle"
    },
    "data": {
      "type": "object"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

doctor.bundle.preview

{
  "$id": "https://switchyard.dev/schema/cli/doctor-bundle-preview.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "doctor.bundle.preview"
    },
    "data": {
      "type": "object"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

manifest.diff

{
  "$id": "https://switchyard.dev/schema/cli/manifest-diff.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "manifest.diff"
    },
    "data": {
      "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/ManifestDiff"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

manifest.explain

{
  "$id": "https://switchyard.dev/schema/cli/manifest-explain.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "manifest.explain"
    },
    "data": {
      "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/EffectiveManifest"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

manifest.validate

{
  "$id": "https://switchyard.dev/schema/cli/manifest-validate.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "manifest.validate"
    },
    "data": {
      "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/ManifestValidation"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

open

{
  "$id": "https://switchyard.dev/schema/cli/open.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "open"
    },
    "data": {
      "required": [
        "projectId",
        "target",
        "opened"
      ],
      "type": "object"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

operation.cancel

{
  "$id": "https://switchyard.dev/schema/cli/operation-cancel.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "operation.cancel"
    },
    "data": {
      "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/Operation"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

operation.get

{
  "$id": "https://switchyard.dev/schema/cli/operation-get.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "operation.get"
    },
    "data": {
      "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/Operation"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

operation.list

{
  "$id": "https://switchyard.dev/schema/cli/operation-list.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "operation.list"
    },
    "data": {
      "items": {
        "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/Operation"
      },
      "type": "array"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

project.add

{
  "$id": "https://switchyard.dev/schema/cli/project-add.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "project.add"
    },
    "data": {
      "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/ManifestProposal"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

project.get

{
  "$id": "https://switchyard.dev/schema/cli/project-get.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "project.get"
    },
    "data": {
      "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/Project"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

project.list

{
  "$id": "https://switchyard.dev/schema/cli/project-list.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "project.list"
    },
    "data": {
      "items": {
        "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/Project"
      },
      "type": "array"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

project.remove

{
  "$id": "https://switchyard.dev/schema/cli/project-remove.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "project.remove"
    },
    "data": {
      "required": [
        "id",
        "slug",
        "removed",
        "repositoryFilesChanged"
      ],
      "type": "object"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

project.trust

{
  "$id": "https://switchyard.dev/schema/cli/project-trust.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "project.trust"
    },
    "data": {
      "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/AcceptedManifestProposal"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

runtime.logs

{
  "$id": "https://switchyard.dev/schema/cli/runtime-logs.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "runtime.logs"
    },
    "data": {
      "items": {
        "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/RuntimeLogEntry"
      },
      "type": "array"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

runtime.metrics

{
  "$id": "https://switchyard.dev/schema/cli/runtime-metrics.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "runtime.metrics"
    },
    "data": {
      "items": {
        "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/RuntimeMetricSample"
      },
      "type": "array"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

runtime.plan

{
  "$id": "https://switchyard.dev/schema/cli/runtime-plan.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "runtime.plan"
    },
    "data": {
      "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/RuntimePlan"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

runtime.status

{
  "$id": "https://switchyard.dev/schema/cli/runtime-status.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "runtime.status"
    },
    "data": {
      "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/RuntimeObservation"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

runtime.operation

{
  "$id": "https://switchyard.dev/schema/cli/runtime-operation.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "runtime.operation"
    },
    "data": {
      "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/Operation"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

settings.apply

{
  "$id": "https://switchyard.dev/schema/cli/settings-apply.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "settings.apply"
    },
    "data": {
      "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/DaemonSettingsStatus"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

settings.export

{
  "$id": "https://switchyard.dev/schema/cli/settings-export.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "settings.export"
    },
    "data": {
      "required": [
        "path",
        "revision"
      ],
      "type": "object"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

settings.show

{
  "$id": "https://switchyard.dev/schema/cli/settings-show.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "settings.show"
    },
    "data": {
      "$ref": "https://switchyard.dev/schema/openapi.v1.json#/components/schemas/DaemonSettingsStatus"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

ui

{
  "$id": "https://switchyard.dev/schema/cli/ui.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "ui"
    },
    "data": {
      "required": [
        "url",
        "expiresAt"
      ],
      "type": "object"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}

version

{
  "$id": "https://switchyard.dev/schema/cli/version.v1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "command": {
      "const": "version"
    },
    "data": {
      "type": "object"
    },
    "schemaVersion": {
      "const": "switchyard.cli/v1"
    }
  },
  "required": [
    "schemaVersion",
    "command",
    "data"
  ],
  "type": "object"
}
Use this pageLast verified Jul 17, 2026
Copy-ready MarkdownOpen sourceReport a docs issue