O que cli-anything-mermaid faz?
Crie, edite e renderize diagramas Mermaid por meio de arquivos de projeto com estado e o renderizador mermaid.ink. Projetado para agentes de IA e usuários avançados que precisam gerar fluxogramas, diagramas de sequência e outras visualizações sem uma GUI.
Instalação
Esta CLI é instalada como parte do pacote cli-anything-mermaid:
pip install cli-anything-mermaid
Pré-requisitos:
- Python 3.10+
- Nenhum software externo necessário (a renderização usa o serviço em nuvem mermaid.ink)
Uso
Comandos Básicos
# Exibir ajuda
cli-anything-mermaid --help
# Iniciar modo REPL interativo
cli-anything-mermaid
# Criar um novo projeto
cli-anything-mermaid project new -o diagram.json
# Executar com saída JSON (para consumo por agente)
cli-anything-mermaid --json project info
Modo REPL
Quando invocado sem um subcomando, a CLI entra em uma sessão REPL interativa:
cli-anything-mermaid
# Digite comandos interativamente com autocompletar e histórico
Grupos de Comandos
Projeto
Comandos do ciclo de vida do projeto.
| Comando | Descrição |
|---|---|
new | Criar um novo projeto Mermaid com predefinição de amostra e tema opcionais |
open | Abrir um arquivo de projeto Mermaid existente |
save | Salvar o projeto atual em um arquivo |
info | Mostrar informações do projeto atual |
samples | Listar predefinições de diagrama de amostra disponíveis |
Diagrama
Comandos de manipulação da fonte do diagrama.
| Comando | Descrição |
|---|---|
set | Substituir o texto fonte Mermaid (em linha ou de arquivo) |
show | Exibir o código fonte Mermaid atual |
Exportação
Comandos de renderização e compartilhamento.
| Comando | Descrição |
|---|---|
render | Renderizar o diagrama para SVG ou PNG via mermaid.ink |
share | Gerar uma URL do Mermaid Live Editor para compartilhamento |
Sessão
Comandos de estado da sessão.
| Comando | Descrição |
|---|---|
status | Mostrar o estado atual da sessão |
undo | Desfazer a última alteração na fonte do diagrama |
redo | Refazer a última alteração desfeita |
Exemplos
Criar e Renderizar um Fluxograma
# Criar um projeto com amostra de fluxograma
cli-anything-mermaid project new --sample flowchart -o flow.json
# Substituir a fonte do diagrama
cli-anything-mermaid --project flow.json diagram set --text "graph TD; A-->B; B-->C;"
# Renderizar para SVG
cli-anything-mermaid --project flow.json export render output.svg --format svg
Criar um Diagrama de Sequência
# Criar um projeto com amostra de sequência
cli-anything-mermaid project new --sample sequence -o seq.json
# Definir diagrama a partir de arquivo
cli-anything-mermaid --project seq.json diagram set --file my_diagram.mmd
# Renderizar para PNG
cli-anything-mermaid --project seq.json export render output.png --format png
Compartilhar um Diagrama
# Gerar uma URL editável do Mermaid Live
cli-anything-mermaid --project flow.json export share --mode edit
# Gerar uma URL somente visualização
cli-anything-mermaid --project flow.json export share --mode view
Sessão REPL Interativa
cli-anything-mermaid
# new flowchart
# set graph TD; A-->B; B-->C;
# render output.svg
# share
# quit
Gerenciamento de Estado
A CLI mantém o estado da sessão com:
- Undo/Redo: Reverter ou refazer alterações na fonte do diagrama
- Persistência de projeto: Salvar/carregar estado do projeto como JSON
- Rastreamento de sessão: Acompanhar modificações e alterações
Formatos de Saída
Todos os comandos suportam dois modos de saída:
- Legível por humanos (padrão): Tabelas, cores, texto formatado
- Legível por máquina (flag
--json): JSON estruturado para consumo por agentes
# Saída humana
cli-anything-mermaid project info
# Saída JSON para agentes
cli-anything-mermaid --json project info
Para Agentes de IA
Ao usar esta CLI programaticamente:
- Sempre use a flag
--jsonpara saída parseável - Verifique os códigos de retorno - 0 para sucesso, não-zero para erros
- Analise o stderr para mensagens de erro em caso de falha
- Use caminhos absolutos para todas as operações de arquivo
- Verifique se as saídas existem após operações de renderização
Mais Informações
- Documentação completa: Consulte o README.md no pacote
- Cobertura de testes: Consulte o TEST.md no pacote
- Metodologia: Consulte o HARNESS.md no cli-anything-plugin
Versão
1.0.0