mic CLI reference

# mic orgs list

List organisations (API: GET /api/v2/organisations)

$ mic orgs list

# mic spaces list

List spaces in an organisation (API: GET /api/v2/organisations/{id}/spaces)

$ mic spaces list [options]

# mic apps catalogue

Print known Monterosa apps (local catalogue)

$ mic apps catalogue

# mic apps create

Register an app/version (e.g. FanKit v25.1.0) in a space so projects in that space can use it. Admin only. Endpoint is POST /api/v2/apps (NOT space-scoped) — space is passed as a relationship in the body. Attributes need only spec_url; app_id, version, and embed_url are derived server-side from the fetched spec. Returns the new app resource id. NOTE: this does NOT migrate any project onto the new app — it only makes the version available in the space. To move a project onto it, call `projects reload --app <id>` with the id returned here. Use `apps list --space <id>` to see what is already registered before creating.

$ mic apps create [options]

# mic apps list

List apps available in a space (API: GET /api/v2/spaces/{id}/apps)

$ mic apps list [options]

# mic apps validate-spec-url

Pre-flight check: does the Studio server-side fetcher reach this spec URL? Useful for catching CloudFront WAF / bucket-policy surprises on `assets.monterosa.co` before calling `apps create`.

$ mic apps validate-spec-url <url> [options]

# mic projects create

Create project (API: POST /api/v2/projects, relationships.space + app)

$ mic projects create [options]

# mic projects diff

Compare two projects: app/version, enabled element types, and settings entries. Useful for debugging why Project A behaves differently to Project B on the same platform.

$ mic projects diff <id-a> <id-b> [options]

# mic projects inspect

Show project + app + enabled element types

$ mic projects inspect <id>

# mic projects list

List projects in a space (API: GET /api/v2/spaces/{id}/projects)

$ mic projects list [options]

# mic projects reload

Migrate a project onto a different app/version (e.g. FanKit v24 -> v25)

$ mic projects reload <id> [options]

# mic projects settings diff

Show per-key diff between local file and remote settings

$ mic projects settings diff <id> [options]

# mic projects settings pull

Download attributes.settings as JSON. Default --out is ~/.monterosa/backups/{project-id}-{digest}.json so repeated pulls across projects do not clobber a single settings.json in the cwd.

$ mic projects settings pull <id> [options]

# mic projects settings push

Upload settings JSON (PATCH attributes.settings, wholesale replace)

$ mic projects settings push <id> [options]

# mic events clone

Client-side clone: copies event + all elements to a new event

$ mic events clone <source-id> [options]

# mic events create

Create event (API: POST /api/v2/events, relationships.project)

$ mic events create [options]

# mic events from-template

Create event from template (data.type: event_from_template)

$ mic events from-template <template-id> [options]

# mic events list

List events (API: GET /api/v2/projects/{id}/events)

$ mic events list [options]

# mic events prune

Delete events that have no elements (or only drafts) on a project. Use --dry-run to preview before deleting. Asks for confirmation unless --yes.

$ mic events prune [options]

# mic events schedule

Stagger element start_offset values on a draft event (start_mode=timecode). Helpful when you want elements to appear at even intervals without hand-writing offsets.

$ mic events schedule [options]

# mic events start

Start an event (PATCH action)

$ mic events start <id>

# mic events stop

Stop an event (PATCH action)

$ mic events stop <id>

# mic events templates

List event templates (API: GET /api/v2/projects/{id}/event_templates)

$ mic events templates [options]

# mic elements apply

Batch create elements from YAML (resolves {{name}} cross-refs)

$ mic elements apply [options]

# mic elements clone-from

Copy elements from one event to another. Attributes are whitelisted to safe create-ready fields.

$ mic elements clone-from [options]

# mic elements clone-group

Copy a wrapper element plus its children between events, preserving wrapper↔child linkage via the registered link field (see `src/wrappers.ts`).

$ mic elements clone-group [options]

# mic elements create

Create element (via --template or --file)

$ mic elements create [options]

# mic elements export

Export elements on an event as create-ready YAML (strips server-computed fields so the output can be fed to `elements apply`).

$ mic elements export [options]

# mic elements list

List elements on an event

$ mic elements list [options]

# mic elements publish

Publish element by id, or all drafts on --event (children before wrappers).

$ mic elements publish [id] [options]

# mic elements schema

Show introspected field list for a content type

$ mic elements schema <project-id> <content-type>

# mic elements template

Show a specific template

$ mic elements template <content-type>

# mic elements templates

List template registry (remote + cache)

$ mic elements templates [options]

# mic url consumer

Consumer URL from project.embed (+ event id, #/)

$ mic url consumer [options]

# mic url feeds

Feed URLs for a project (graphics feed covers all events)

$ mic url feeds [options]

# mic url livestats

Livestats URL (fetches live_stats_uuid from event attributes)

$ mic url livestats [options]

# mic url studio

Studio UI URL for a project (and optional event). Emits the canonical /dashboard/{org}/spaces/{space}/projects/{project} form by fetching the project with ?include=space to resolve the parent ids.

$ mic url studio [options]

# mic smoke clean

Stop + delete all events tagged [mic-smoke-*] in a project

$ mic smoke clean [options]

# mic smoke run

Create an event, attempt one element of each enabled type, publish, emit URL

$ mic smoke run [options]

# mic plan alpha

Compare a manifest YAML to the live project and print the add/update/noop plan. Does not mutate.

Alpha: this command is experimental and has not yet been tested in production. Interface may change.

$ mic plan [options]

# mic apply alpha

Apply a manifest YAML: create missing events/elements and update changed ones. Wrapper->child linkage is preserved via the registry. Does not delete remote entities missing from the manifest (flagged in plan).

Alpha: this command is experimental and has not yet been tested in production. Interface may change.

$ mic apply [options]

# mic export alpha

Dump a live project to manifest YAML. Round-trips with `mic apply --file`.

Alpha: this command is experimental and has not yet been tested in production. Interface may change.

$ mic export [options]

# mic annotations delete

Remove a single annotation key (smart merge; other keys untouched)

$ mic annotations delete <kind> <id> <key>

# mic annotations get

Read annotations on a resource (organisations, spaces, projects, event-templates, events, elements)

$ mic annotations get <kind> <id> [options]

# mic annotations set

Set one or more annotations (key=value, value=@file.md to load from disk)

$ mic annotations set <kind> <id> [pairs...]

# mic context

Fetch x-monterosa-context from a resource and all its ancestors (element -> event -> project -> space -> org)

$ mic context <kind> <id> [options]

# mic assets delete

Delete an asset. Asks for confirmation unless --yes.

$ mic assets delete <asset-id> [options]

# mic assets list

List assets in a space (paginated, 100/page)

$ mic assets list [options]

# mic assets media-types

List mime types in use across a space (useful as --mime filter values)

$ mic assets media-types [options]

# mic assets tag

Attach one or more tag ids to an asset

$ mic assets tag <asset-id> <tag-ids...>

# mic assets untag

Remove one or more tag ids from an asset

$ mic assets untag <asset-id> <tag-ids...>

# mic assets update

Update an asset's name or alt text

$ mic assets update <asset-id> [options]

# mic assets upload

Upload one or more files to a space. Use --url to upload remote URLs instead.

$ mic assets upload <files...> [options]

# mic assets uploaders

List users who have uploaded assets into a space

$ mic assets uploaders [options]

# mic scope check

Dry-run: would a mutation on this target be allowed? (kind: org|space|project|event|element)

$ mic scope check <kind> <id> [options]

# mic scope show

Show the current allow-list for the active profile (or --profile)

$ mic scope show [options]

# mic forms demo

Print the demo form id for the active profile's Studio instance, with caveats

$ mic forms demo