mcms-cli

分类: 工具与效率 | 上传者: mrmtsu | 下载: 0 | 版本: v1.0（最新）
在 AI/CI 工作流程中安全地自动化 microCMS（日本无头 CMS）操作。当您需要模式优先的内容 CRUD、带有空运行验证的批量/导入、状态/创建者更改以及通过“microcms ... --json”进行机器可读分支时使用。
更新日志: Source: GitHub https://github.com/mrmtsu/mcms-cli
目录结构

当前层级: tree/main/skills/mcms-cli/
📁 references/
- 📄 bulk-and-import.md 1.4 KB
- 📄 docs-and-search.md 1.6 KB
- 📄 safe-workflows.md 1.4 KB
- 📄 setup-and-auth.md 1.1 KB
📄 SKILL.md 9.8 KB
SKILL.md

---
name: mcms-cli
description: Safely automate microCMS (Japanese headless CMS) operations in AI/CI workflows. Use when you need schema-first content CRUD, bulk/import with dry-run validation, status/created-by changes, and machine-readable branching via `microcms ... --json`.
metadata:
  generatedBy: scripts/generate-skill.ts
  sources:
    - README.md
    - docs/CLI_SPECIFICATION.md
    - src/core/task-workflow.ts
    - skills/mcms-cli/references/setup-and-auth.md
    - skills/mcms-cli/references/safe-workflows.md
    - skills/mcms-cli/references/bulk-and-import.md
    - skills/mcms-cli/references/docs-and-search.md
---

<!-- Generated file. Edit the referenced sources and re-run `npm run skill:generate`. -->

# mcms-cli Skill

Always run microCMS write operations with `--json` and `--dry-run` first.

## Quick start

```bash
microcms search "api schema" --scope all --json                          # discover commands/docs first
microcms docs get --category management-api --file "APIスキーマ取得API（フィールド定義やカスタムフィールド）.md" --json
microcms auth status --json
microcms config doctor --json
microcms schema pull --out microcms-schema.json --json                    # microCMS proprietary format
microcms schema pull --format api-export --endpoints blogs --out blogs-api-schema.json --json
microcms schema pull --format json-schema --out schema.json --json        # JSON Schema (draft-07)
microcms schema pull --format json-schema --include-extensions --out schema.json --json
microcms api schema export blogs --out blogs-api-schema.json --json       # discoverable alias for single-endpoint export
microcms validate blogs --file payload.json --json
microcms content create blogs --file payload.json --dry-run --json
microcms content create blogs --file payload.json --json
```

## Non-negotiable rules

1. Always add `--json` for machine decisions.
2. Always run write commands with `--dry-run` before real execution.
3. Always run `validate` or `--validate-payload` before create/update/import/bulk.
4. Prefer `--strict-warnings` for `content import` and `content bulk`.
5. Decide success by both `.ok` and process exit code.
6. Keep `meta.requestId` in logs for incident analysis.

## Exit code policy

| Code | Meaning | Agent action |
|------|---------|--------------|
| `0` | Success | Proceed to the next step |
| `2` | Invalid input | Fix payload/options and retry |
| `3` | Auth error | Re-check auth resolution |
| `4` | Permission error | Verify API key scope and endpoint permissions |
| `5` | Network/timeout | Retry with adjusted timeout/retry options |
| `6` | Conflict | Re-read content state, then retry |
| `1` | Unknown error | Re-run with --verbose and inspect details |

## JSON gate template

```bash
run_mcms() {
  local out
  out=$(microcms "$@" --json 2>&1) || {
    printf '%s\n' "$out" >&2
    return 1
  }
  printf '%s\n' "$out" | jq -e '.ok == true' >/dev/null || {
    printf '%s\n' "$out" | jq .
    return 1
  }
  printf '%s\n' "$out"
}
```

## Read references on demand

- Setup and auth: [references/setup-and-auth.md](references/setup-and-auth.md)
- Safe CRUD workflow and anti-patterns: [references/safe-workflows.md](references/safe-workflows.md)
- Bulk/import contracts and recovery: [references/bulk-and-import.md](references/bulk-and-import.md)
- Docs/search/spec and agent-browser loop: [references/docs-and-search.md](references/docs-and-search.md)

Always prefer the CLI docs/search/task/spec surface before reaching for any external tool.

## Built-in safe task workflows

These sections are derived from the built-in `microcms task guide` data.

### `docs-read-spec` - Read Official Docs via CLI

Use CLI-first docs/search commands to inspect official microCMS documentation without leaving mcms-cli.

Risk: `low`
Requires confirmation: `no`

1. `microcms search "<query>" --scope all --json`
   Risk: `low`, confirmation: `no`
2. `microcms docs get --category <category> --file "<filename>" --json`
   Risk: `low`, confirmation: `no`
   Note: CLI remains the official entrypoint even when the underlying source resolves to the bundled docs runtime.
3. `microcms spec --json`
   Risk: `low`, confirmation: `no`

### `api-schema-inspect` - Inspect API Schema Safely

Read official docs and inspect a single endpoint schema without exporting files yet.

Risk: `low`
Requires confirmation: `no`

1. `microcms search "api schema" --scope all --json`
   Risk: `low`, confirmation: `no`
2. `microcms docs get --category management-api --file "APIスキーマ取得API（フィールド定義やカスタムフィールド）.md" --json`
   Risk: `low`, confirmation: `no`
3. `microcms api schema inspect <endpoint> --json`
   Risk: `low`, confirmation: `no`

### `api-schema-export` - Export Reusable API Schema

Export a single endpoint schema in API import-compatible shape while keeping schema pull canonical.

Risk: `low`
Requires confirmation: `no`

1. `microcms docs get --category manual --file " APIスキーマのエクスポート／インポート.md" --json`
   Risk: `low`, confirmation: `no`
2. `microcms api schema inspect <endpoint> --json`
   Risk: `low`, confirmation: `no`
3. `microcms api schema export <endpoint> --out <endpoint>-api-schema.json --json`
   Risk: `low`, confirmation: `no`
   Note: Canonical equivalent: `microcms schema pull --format api-export --endpoints <endpoint> --out <endpoint>-api-schema.json --json`.

### `api-schema-import-compat` - Prepare API Import-Compatible Schema JSON

Produce the JSON shape accepted by the UI import flow, while documenting import limitations.

Risk: `low`
Requires confirmation: `no`

1. `microcms docs get --category manual --file " APIスキーマのエクスポート／インポート.md" --json`
   Risk: `low`, confirmation: `no`
   Note: Relation targets are not fully restored by import and still require follow-up in the UI.
2. `microcms schema pull --format api-export --endpoints <endpoint> --out <endpoint>-api-schema.json --json`
   Risk: `low`, confirmation: `no`
3. `microcms api schema inspect <endpoint> --json`
   Risk: `low`, confirmation: `no`

### `content-create` - Create Content Safely

Validate payload and create a new content item with dry-run first.

Risk: `low`
Requires confirmation: `no`

1. `microcms validate <endpoint> --file <payload.json> --json`
   Risk: `low`, confirmation: `no`
2. `microcms content create <endpoint> --file <payload.json> --dry-run --json`
   Risk: `low`, confirmation: `no`
3. `microcms content create <endpoint> --file <payload.json> --json`
   Risk: `low`, confirmation: `no`

### `content-update` - Update Content Safely

Validate and update an existing item while preserving dry-run safety checks.

Risk: `medium`
Requires confirmation: `no`

1. `microcms validate <endpoint> --file <payload.json> --json`
   Risk: `low`, confirmation: `no`
2. `microcms content update <endpoint> <id> --file <payload.json> --dry-run --json`
   Risk: `medium`, confirmation: `no`
3. `microcms content update <endpoint> <id> --file <payload.json> --json`
   Risk: `medium`, confirmation: `no`

### `content-delete` - Delete Content with Guardrails

Precheck target content, then dry-run and confirm before delete.

Risk: `high`
Requires confirmation: `yes`

1. `microcms content get <endpoint> <id> --json`
   Risk: `low`, confirmation: `no`
2. `microcms content delete <endpoint> <id> --dry-run --json`
   Risk: `high`, confirmation: `yes`
   Reason: Deletes content and recovery depends on backups or export data.
3. `microcms content delete <endpoint> <id> --json`
   Risk: `high`, confirmation: `yes`
   Reason: Deletes content and recovery depends on backups or export data.

### `content-import` - Bulk Import Content

Run strict dry-run validation before importing multiple records.

Risk: `high`
Requires confirmation: `yes`

1. `microcms content export <endpoint> --out backup/<endpoint>.json --json`
   Risk: `low`, confirmation: `no`
2. `microcms content import <endpoint> --file <contents.json> --dry-run --strict-warnings --json`
   Risk: `high`, confirmation: `yes`
   Reason: Writes many records and may overwrite existing content when --upsert is used.
3. `microcms content import <endpoint> --file <contents.json> --json`
   Risk: `high`, confirmation: `yes`
   Reason: Writes many records and may overwrite existing content when --upsert is used.
   Note: Add --upsert only when update-by-id behavior is required.

### `content-bulk` - Execute Bulk Operations

Validate operation file and execute create/update/delete/status actions safely.

Risk: `high`
Requires confirmation: `yes`

1. `microcms content bulk --file <operations.json> --dry-run --validate-payload --strict-warnings --json`
   Risk: `high`, confirmation: `yes`
   Reason: Runs multiple write operations and may leave partial state when failures occur.
2. `microcms content bulk --file <operations.json> --stop-on-error --json`
   Risk: `high`, confirmation: `yes`
   Reason: Runs multiple write operations and may leave partial state when failures occur.

### `content-status-set` - Change Content Status

Review metadata and change published/draft status with confirmation.

Risk: `medium`
Requires confirmation: `yes`

1. `microcms content meta get <endpoint> <id> --json`
   Risk: `low`, confirmation: `no`
2. `microcms content status set <endpoint> <id> --status <PUBLISH|DRAFT> --dry-run --json`
   Risk: `medium`, confirmation: `yes`
   Reason: Changes published/draft state and can affect public visibility immediately.
3. `microcms content status set <endpoint> <id> --status <PUBLISH|DRAFT> --json`
   Risk: `medium`, confirmation: `yes`
   Reason: Changes published/draft state and can affect public visibility immediately.

## Notes for this repository

- Use `docs/CLI_SPECIFICATION.md` as the primary source of truth for command behavior.
- Assume the JSON envelope contract: `ok/data/meta` for success, `ok/error/meta` for failure.
- The packaged skill is derived from repository sources and should be regenerated, not hand-edited.
登录后下载/点赞/收藏 ❤ 5 | ★ 0
mcms-cli

目录结构

SKILL.md

举报内容

提示
