FAQ and troubleshooting
Resolve common mcms-cli questions about its unofficial status, command name, profiles, credentials, dry-runs, payload validation, retries, and types.
Is mcms-cli an official microCMS product?
No. It is an unofficial community project and is not affiliated with the official microCMS product. Review its behavior and permissions before production use.
Why is the mcms-cli command missing after installation?
The executable is named microcms.
microcms --help
microcms --versionHow do I confirm the active service?
microcms auth status --json
microcms config doctor --jsonThese commands report the selected profile, service domain, and API key source without showing the secret.
Does profile add complete authentication?
No. It saves the service domain. Save an API key separately with auth login, or provide one through an environment variable.
What should I check before a write?
- Run
auth statusandconfig doctor. - Pull the current schema.
- Validate the payload.
- Run the write command with
--dry-run. - Check the exit code and
.ok == true. - Execute the write.
- Read the remote content back.
Does content bulk --dry-run validate payloads?
A plain bulk dry-run checks the operation file structure. Add --validate-payload to validate against endpoint schemas, or --strict-warnings to treat validation warnings as failures.
Should I pass an API key with --api-key?
Command arguments may appear in shell history or process listings. Prefer an operating system keychain locally, environment variables in CI, or --api-key-stdin for a pipeline.
Can network failures be retried?
--retry applies to retry-safe requests such as GET by default. Do not blindly retry writes; check the command result and remote state first.