Skip to content
AssureSwarm Docs

Agent Operating Guide

/coach-schema-export

Pull the current tenant's full schema to a versioned JSON file in bulk-import format, for backup, diffing changes over time, or migrating a schema between tenants.

Round-trip your schema out of Canvas. The skill reads the current tenant’s full schema with get_schema and writes it to a versioned, timestamped JSON file in the same bulk-import format /coach-schema-design produces. It’s read-only: nothing is written back to the source tenant. Because the output round-trips, you can paste it into another tenant’s Bulk Import page (/en/admin/bulk-import) to migrate a schema, so this never goes through suggest_change.

When to use

Section titled “When to use”

When you want a snapshot of the schema: a backup before a major edit, a baseline to diff changes against over time, or the source half of a tenant-to-tenant migration. Pair it with /coach-schema-validate to confirm the dump is legal input before you paste it anywhere.

Inputs

Section titled “Inputs”
Flag Required Notes
--out <path> No Output path. Defaults to .coworkcanvas/schemas/<subdomain>-<date>.json.
--include-options No Include SELECT and MULTISELECT options in the dump. On by default.
--include-system No Include system item types. On by default.

Example

Section titled “Example”

/coach-schema-export reads the active tenant from .coworkcanvas/config.json, calls get_schema, and transforms the response into the bulk-import shape: field arrays under FieldDefinition, relations as relatedItemTypeSlug, custom lists as a flat array of tuples. It pretty-prints with sorted keys for diff-friendliness, writes .coworkcanvas/schemas/<subdomain>-<date>.json, and prints the path, file size, and a count of item types and total fields.

Good to know

Section titled “Good to know”
  • Read-only: export never writes to the source tenant. The destination receives changes through its own Bulk Import page, not through suggest_change.
  • For migration, export from the source tenant, optionally hand-edit, then paste at the target’s /en/admin/bulk-import.
  • If your tenant has field types added after this skill’s version that don’t round-trip cleanly, running /coach-schema-validate on the export surfaces them.
Section titled “Related”