Create local Xmind mind maps with AI agents.
xmind-cli gives agents a reliable local-file workflow for .xmind maps:
generate structured maps, inspect and validate files, apply edits, attach
images, and report Xmind credits used by premium features.
npm install -g @xmindltd/xmind-cli
npx skills add xmindltd/xmind-cli -yThe skill install command adds the xmind-file skill to supported agent skill
directories. Verify the CLI and available guidance:
xmind skill list
xmind auth statusIf needed, sign in once:
xmind auth loginAsk your agent:
Create a local Xmind mind map about Apollo 11.
The agent uses the xmind-file skill to choose a recipe, draft the map, build a
generate spec, run xmind generate, validate the .xmind, and summarize the
result.
- Generate rich local
.xmindfiles from semantic specs. - Create quick maps from Markdown.
- Read, describe, and validate existing
.xmindfiles. - Edit maps with add/update/delete/theme/layout/marker/label/batch commands.
- Attach local images, stable public raster image URLs, or Wikipedia images.
- Report actual billing as Xmind credits when premium features are used.
Core commands:
xmind generate --spec generate.json -o output.xmind
xmind generate check --spec generate.json
xmind create --from-markdown draft.md -o output.xmind
xmind read output.xmind
xmind describe output.xmind
xmind validate output.xmind --quiet
xmind batch output.xmind
xmind image output.xmind --topic "Topic" --wiki "Apollo 11"The agent supplies semantic judgment. The CLI handles mechanical execution.
- The agent chooses a recipe for the user goal.
- The agent drafts Markdown with titles, hierarchy, and notes.
- The agent writes a generate spec with route intent, visual anchors, and image targets.
xmind generateselects the final structure/color, applies anchors and images, validates the file, and returns JSON.- The agent reports the output path, validation result, key design choices, and any Xmind credits consumed.
The JSON output includes execution facts such as route.skeletonReason,
route.colorReason, anchors.applied, billing.consumed, billing.balance,
billing.unit, and downgraded.
Some premium structures, themes, or recipe skills may consume Xmind credits.
The CLI reports billing in JSON. Treat billing.unit as authoritative; these
are Xmind credits, not OpenAI, Codex, model, or token credits.
If credits are unavailable, the CLI may downgrade to a free fallback unless the
agent uses --no-downgrade.
This repository distributes the public agent skill entry point:
The CLI binary ships separately on npm as
@xmindltd/xmind-cli.
- Xmind — apps that read
.xmindfiles @xmindltd/xmind-cli- Agent Skills spec
MIT