cli-anything-mermaid は何をしますか？
Mermaid図の作成、編集、レンダリングを行うCLIツール。プロジェクトファイルとmermaid.inkレンダラーを使用し、GUIなしでフローチャート、シーケンス図、その他の視覚化を生成する必要があるAIエージェントや上級ユーザー向けに設計されています。
インストール
このCLIは、cli-anything-mermaid パッケージの一部としてインストールされます。
pip install cli-anything-mermaid
前提条件:
- Python 3.10+
- 外部ソフトウェア不要（レンダリングはmermaid.inkクラウドサービスを使用）
使用方法
基本コマンド
# ヘルプを表示
cli-anything-mermaid --help
# 対話型REPLモードを開始
cli-anything-mermaid
# 新しいプロジェクトを作成
cli-anything-mermaid project new -o diagram.json
# JSON出力で実行（エージェントによる利用向け）
cli-anything-mermaid --json project info
REPLモード
サブコマンドなしで呼び出すと、対話型REPLセッションが開始されます。
cli-anything-mermaid
# タブ補完と履歴機能を使って対話的にコマンドを入力
コマンドグループ
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 | 最後に元に戻した変更をやり直す |
例
フローチャートを作成してレンダリング
# フローチャートサンプルでプロジェクトを作成
cli-anything-mermaid project new --sample flowchart -o flow.json
# 図のソースを置換
cli-anything-mermaid --project flow.json diagram set --text "graph TD; A-->B; B-->C;"
# SVGにレンダリング
cli-anything-mermaid --project flow.json export render output.svg --format svg
シーケンス図を作成
# シーケンスサンプルでプロジェクトを作成
cli-anything-mermaid project new --sample sequence -o seq.json
# ファイルから図を設定
cli-anything-mermaid --project seq.json diagram set --file my_diagram.mmd
# PNGにレンダリング
cli-anything-mermaid --project seq.json export render output.png --format png
図を共有
# 編集可能なMermaid Live URLを生成
cli-anything-mermaid --project flow.json export share --mode edit
# 表示専用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
状態管理
CLIは以下のセッション状態を管理します。
- アンドゥ/リドゥ: 図のソース変更を元に戻したり、やり直したりできます
- プロジェクトの永続化: プロジェクト状態をJSONとして保存/読み込み
- セッション追跡: 変更や修正を追跡
出力形式
すべてのコマンドは2つの出力モードをサポートします。
- 人間可読（デフォルト）: 表、色付き、整形されたテキスト
- 機械可読（
--jsonフラグ）: エージェントによる利用向けの構造化JSON
# 人間向け出力
cli-anything-mermaid project info
# エージェント向けJSON出力
cli-anything-mermaid --json project info
AIエージェント向け
このCLIをプログラムで使用する場合:
- 解析可能な出力のために 常に
--jsonフラグを使用 してください - リターンコードを確認 - 0は成功、非0はエラーを示します
- エラー発生時は stderrを解析 してエラーメッセージを取得してください
- すべてのファイル操作には 絶対パスを使用 してください
- レンダリング操作後は 出力が存在することを確認 してください
詳細情報
- 完全なドキュメント: パッケージ内のREADME.mdを参照
- テストカバレッジ: パッケージ内のTEST.mdを参照
- 方法論: cli-anything-plugin内のHARNESS.mdを参照
バージョン
1.0.0