mcms-cli
Learn how to use mcms-cli to read and update microCMS content, inspect API schemas, generate types, and automate safe workflows from AI agents and CI.
mcms-cli is an unofficial community-built command-line interface for the microCMS Content API and Management API. This guide currently refers to v0.7.4.
mcms-cli is not an official microCMS product. Check its permissions and behavior in the target service before using it in production.
What it helps with
It lets you inspect and update content, validate payloads, save and compare API schemas, and generate types without opening the administration screen. Typical uses include:
- checking content and schema changes in CI
- giving AI agents machine-readable commands and results
- switching between services with named profiles
- validating a payload and previewing a write before execution
- searching command specifications and microCMS documentation from the terminal
Names you will see
| Name | Meaning |
|---|---|
mcms-cli |
GitHub repository and local project name |
@mrmtsu/mcms-cli |
npm package name |
microcms |
command you run after installation |
Machine-readable results
With --json, a successful command returns an envelope containing ok, data, and meta. AI agents and CI jobs can check the exit code and .ok == true instead of parsing prose.
{
"ok": true,
"data": {},
"meta": {
"requestId": null,
"version": "0.x"
}
}