base on Command line tool for the Mermaid library # mermaid-cli [](https://www.npmjs.com/package/@mermaid-js/mermaid-cli) [](https://www.npmjs.com/package/@mermaid-js/mermaid-cli) [](https://hub.docker.com/r/minlag/mermaid-cli) [](https://github.com/mermaid-js/mermaid-cli/actions/workflows/compile-mermaid.yml) [](https://percy.io/Mermaid/mermaid-cli) [](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE) This is a command-line interface (CLI) for [mermaid](https://mermaid.js.org/). It takes a mermaid definition file as input and generates an SVG/PNG/PDF file as output. ## Installation ```sh npm install -g @mermaid-js/mermaid-cli ``` ## Usage Convert Mermaid mmd Diagram File To SVG ```sh mmdc -i input.mmd -o output.svg ``` > **Note** > > See [Alternative installations](#alternative-installations) if you don't want to install the package globally. > > Locate how to call the mmdc executable for your preferred method > i.e. Docker, Yarn, NPM, local install, etc. ## Examples ### Create A PNG With A Dark Theme And Transparent Background ```sh mmdc -i input.mmd -o output.png -t dark -b transparent ``` ### Animating an SVG file with custom CSS The `--cssFile` option can be used to inline some custom CSS. Please see [./test-positive/flowchart1.css](test-positive/flowchart1.css) for an example of a CSS file that has animations. **Warning**: If you want to override `mermaid`'s [`themeCSS`](https://mermaid.js.org/config/schema-docs/config.html#themecss), we recommend instead adding `{"themeCSS": "..."})` to your mermaid `--configFile`. You may also need to use [`!important`](https://developer.mozilla.org/en-US/docs/Web/CSS/important) to override mermaid's `themeCSS`. **Warning**: Inline CSS files may be blocked by your browser, depending on the [HTTP Content-Security-Policy header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) of the website that hosts your SVG. ```sh mmdc --input test-positive/flowchart1.mmd --cssFile test-positive/flowchart1.css -o docs/animated-flowchart.svg ``` <details> <summary>Example output: docs/animated-flowchart.svg</summary>  </details> ### Transform a markdown file with mermaid diagrams ```sh mmdc -i readme.template.md -o readme.md ``` This command transforms a markdown file itself. The mermaid-cli will find the mermaid diagrams, create SVG files from them and refer to those in the markdown output. This: ~~~md ### Some markdown ```mermaid graph [....] ``` ### Some more markdown ```mermaid sequenceDiagram [....] ``` ### Mermaid with custom title/desc ```mermaid graph accTitle: My title here accDescr: My description here A-->B ``` ~~~ Becomes: ```md ### Some markdown  ### Some more markdown  ### Mermaid with custom title/desc  ``` ### Piping from stdin You can easily pipe input from stdin. This example shows how to use a heredoc to send a diagram as stdin to mermaid-cli (mmdc). ```sh cat << EOF | mmdc --input - graph TD A[Client] --> B[Load Balancer] EOF ``` ### See All Available Options ```sh mmdc -h ``` # Alternative installations ## Use Docker/Podman: ```sh docker pull minlag/mermaid-cli ``` or pull from Github Container Registry ```sh docker pull ghcr.io/mermaid-js/mermaid-cli/mermaid-cli ``` or e.g. version 8.8.0 ```sh docker pull minlag/mermaid-cli:8.8.0 ``` The container looks for input files in `/data`. So for example, if you have a diagram defined on your system in `/path/to/diagrams/diagram.mmd`, you can use the container to generate an SVG file as follows: ```sh docker run --rm -u `id -u`:`id -g` -v /path/to/diagrams:/data minlag/mermaid-cli -i diagram.mmd ``` Or, if using [Podman](https://podman.io/), instead do: ```sh podman run --userns keep-id --user ${UID} --rm -v /path/to/diagrams:/data:z ghcr.io/mermaid-js/mermaid-cli/mermaid-cli -i diagram.mmd ``` The key differences in the podman command versus the docker command are: - The addition of the `--userns keep-id` argument. This allows the container to keep the same UID as the current user's UID in the container namespace instead of mapping to a subuid. To learn more, see the [`userns=mode` documentation](https://docs.podman.io/en/v4.4/markdown/options/userns.container.html). - The addition of `:z` to the end of the volume mapping. This instructs podman to relabel the files in the volume with the SELinux label `container_file_t`, which allows processes in the container to access the files. See the "Labeling Volume Mounts" section of [podman-run (1)](https://docs.podman.io/en/latest/markdown/podman-run.1.html#volume-v-source-volume-host-dir-container-dir-options) for more info. In previous version, the input files were mounted in `/home/mermaidcli`. You can restore this behaviour with the `--workdir` option: ```sh docker run [...] --workdir=/home/mermaidcli minlag/mermaid-cli [...] ``` ## Use Node.JS API It's possible to call `mermaid-cli` via a Node.JS API. Please be aware that **the NodeJS API is not covered by semver**, as `mermaid-cli` follows `mermaid`'s versioning. ```js import { run } from "@mermaid-js/mermaid-cli" await run( "input.mmd", "output.svg", // {optional options}, ) ``` ## Install locally Some people are [having issues](https://github.com/mermaidjs/mermaid.cli/issues/15) installing this tool globally. Installing it locally is an alternative solution: ``` npm install @mermaid-js/mermaid-cli ./node_modules/.bin/mmdc -h ``` ### Run with npx [`npx`](https://www.npmjs.com/package/npx) is installed by default with NPM. It downloads and runs commands at the same time. To use Mermaid CLI with npx, you need to use the `-p` flag because the package name is different than the command it installs (`mmdc`). `npx -p @mermaid-js/mermaid-cli mmdc -h` ## Install with [brew](https://brew.sh) > **Warning** > > This method of installation is no longer supported. > For more details, see the [discussion](https://github.com/mermaid-js/mermaid-cli/issues/288). > An old version of mermaid-cli can be installed with brew. > ```sh > brew install mermaid-cli > ``` ## Known issues 1. [Linux sandbox issue](docs/linux-sandbox-issue.md) 2. [Docker permission denied issue](docs/docker-permission-denied.md) 3. [How to setup up mermaid to use already installed chromium?](docs/already-installed-chromium.md) ## For contributors Contributions are welcome. See the [contribution guide](CONTRIBUTING.md). ", Assign "at most 3 tags" to the expected json: {"id":"11548","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"