Help & Support — MooMermaid

🚀 The Four Ways to Use

Web Dashboard

Visual editing, folder organization, and direct UI management of your diagrams.

mmk CLI

Terminal-first experience. Validate, push, and sync diagrams from your local shell.

AI Agent Skills

Direct integration for Cursor, Windsurf, and VS Code to auto-fix and save diagrams.

REST API

Programmatic access for building custom integrations and third-party tools.

🛠️ Detailed Setup Guide

First, visit your API Settings Dashboard to obtain your unique credentials.

🤖 AI Agent Activation

Paste this prompt into your Cursor, Windsurf, or VS Code chat:

Please activate the MooMermaid Developer Skill in this project:

1. Run the installer from https://moomermaid.com/api-settings
2. Verify with 'mmk list'
3. You MUST validate every Mermaid diagram using 'mmk validate' before showing me.

🌐 ChatGPT Web Actions

Paste the OpenAPI schema into your Custom GPT > Actions:

Retrieve your unique schema at: https://moomermaid.com/api-settings

💻 CLI Installation

python -c "import urllib.request as r;exec(r.urlopen('https://moomermaid.com/user_download/skill-install.py').read().decode('utf-8'))" --key YOUR_API_KEY

Supports Windows, macOS, Linux

* Requires Python 3.6+

⚡ Quick Start Commands

Command	Description
`mmk -l`	Quick List: View all diagrams and quota.
`mmk -h`	Advanced Guide: Show terminal tips & examples.
`mmk list`	List all cloud diagrams in JSON format.
`mmk validate --file diag.mmd`	Check syntax of a local file instantly.
`mmk save "Title" --file file.mmd`	Upload and save to your account.

🔐 Authentication & Security

All requests require a Bearer Token in the header:

Authorization: Bearer <YOUR_API_KEY>

💡 Privacy First: All diagrams are private by default. Use the --public flag in the CLI to generate shareable links.

🗑️ Trash & Data Recovery

MooMermaid implements a 30-day safety net. Deleting a diagram moves it to Trash instead of purging it.

Restore any deleted flow via the Dashboard Trash tab within the 30-day window.

Master User Manual