cli-anything-mermaid

cli-anything-mermaid

通过有状态的项目文件和 mermaid.ink 渲染器创建、编辑和渲染 Mermaid 图表。专为需要在无 GUI 环境下生成流程图、序列图及其他可视化的 AI Agent 和高级用户设计。

安装

此命令行工具作为 cli-anything-mermaid 包的一部分安装：

pip install cli-anything-mermaid

前置条件：

• Python 3.10+
• 无需外部软件（渲染使用 mermaid.ink 云服务）

用法

基本命令

# Show help
cli-anything-mermaid --help

# Start interactive REPL mode
cli-anything-mermaid

# Create a new project
cli-anything-mermaid project new -o diagram.json

# Run with JSON output (for agent consumption)
cli-anything-mermaid --json project info

REPL 模式

在不带子命令调用时，命令行工具会进入交互式 REPL 会话：

cli-anything-mermaid
# Enter commands interactively with tab-completion and history

命令组

Project

项目生命周期命令。

命令	描述
new	创建新的 Mermaid 项目，可选示例预设和主题
open	打开现有的 Mermaid 项目文件
save	将当前项目保存到文件
info	显示当前项目信息
samples	列出可用的示例图表预设

Diagram

图表源代码操作命令。

命令	描述
set	替换 Mermaid 源文本（内联或从文件）
show	打印当前 Mermaid 源代码

Export

渲染和分享命令。

命令	描述
render	通过 mermaid.ink 将图表渲染为 SVG 或 PNG
share	生成用于分享的 Mermaid Live Editor URL

Session

会话状态命令。

命令	描述
status	显示当前会话状态
undo	撤销上一次图表源代码更改
redo	重做上一次撤销的更改

示例

创建并渲染流程图

# Create a project with flowchart sample
cli-anything-mermaid project new --sample flowchart -o flow.json

# Replace diagram source
cli-anything-mermaid --project flow.json diagram set --text "graph TD; A-->B; B-->C;"

# Render to SVG
cli-anything-mermaid --project flow.json export render output.svg --format svg

创建序列图

# Create project with sequence sample
cli-anything-mermaid project new --sample sequence -o seq.json

# Set diagram from file
cli-anything-mermaid --project seq.json diagram set --file my_diagram.mmd

# Render to PNG
cli-anything-mermaid --project seq.json export render output.png --format png

分享图表

# Generate an editable Mermaid Live URL
cli-anything-mermaid --project flow.json export share --mode edit

# Generate a view-only URL
cli-anything-mermaid --project flow.json export share --mode view

交互式 REPL 会话

cli-anything-mermaid
# new flowchart
# set graph TD; A-->B; B-->C;
# render output.svg
# share
# quit

状态管理

命令行工具通过以下方式维护会话状态：

• 撤销/重做：还原或重放图表源代码更改
• 项目持久化：将项目状态保存/加载为 JSON
• 会话跟踪：跟踪修改和更改

输出格式

所有命令均支持双输出模式：

• 人类可读（默认）：表格、颜色、格式化文本
• 机器可读（--json 标志）：供 Agent 使用的结构化 JSON

# Human output
cli-anything-mermaid project info

# JSON output for agents
cli-anything-mermaid --json project info

面向 AI Agent

以编程方式使用此命令行工具时：

1. 始终使用 --json 标志 以获得可解析的输出
2. 检查返回码 - 0 表示成功，非零表示错误
3. 解析 stderr 以获取失败时的错误消息
4. 使用绝对路径 进行所有文件操作
5. 验证输出存在 在渲染操作之后

更多信息

• 完整文档：参见包中的 README.md
• 测试覆盖率：参见包中的 TEST.md
• 方法论：参见 cli-anything-plugin 中的 HARNESS.md

版本

1.0.0