Command reference

Find the main mcms-cli commands for content, media, schemas, types, authentication, and documentation, plus common automation options.

This page groups the main commands by task. Add --json when another program needs to consume the result.

APIs and content

microcms api list --json
microcms api info <endpoint> --json
microcms api schema inspect <endpoint> --json

microcms content list <endpoint> --all --json
microcms content get <endpoint> <id> --json
microcms content create <endpoint> --file payload.json --dry-run --json
microcms content update <endpoint> <id> --file payload.json --dry-run --json
microcms content delete <endpoint> <id> --dry-run --json
microcms validate <endpoint> --file payload.json --json

Export and import

microcms content export <endpoint> --out backup/contents.json --json
microcms content export --all --out backup/ --json
microcms content import <endpoint> \
  --file backup/contents.json \
  --dry-run \
  --strict-warnings \
  --json

File-based workflows

microcms content pull <endpoint> \
  --all \
  --out managed-content \
  --format managed-json \
  --json

microcms content verify <endpoint> \
  --dir managed-content \
  --only-changed \
  --json

microcms content push <endpoint> \
  --dir managed-content \
  --json

content push verifies by default. Writing to the remote service requires --execute.

Media, schemas, and types

microcms media list --limit 20 --image-only --json
microcms media upload ./image.png --dry-run --json
microcms media delete --url <media-url> --dry-run --json

microcms schema pull --out schema.json --json
microcms schema diff --baseline schema.json --json
microcms types sync --out microcms-types.d.ts --json

Authentication and configuration

microcms auth status --json
microcms auth profile list --json
microcms config doctor --json
microcms completion install zsh --json

Common options include --profile, --service-domain, --api-key-stdin, --timeout, --retry, --verbose, and --no-color.