Skip to content

visualizer

by official

Utility

Generate PlantUML diagrams from code or process descriptions

utility plantuml diagram visualization
# visualizer

Generate PlantUML diagrams from code or process descriptions

## Installation

This is a CmdForge tool. Install it from the registry:

```bash
cmdforge install visualizer
```

## Usage

Use `visualizer` as a pipeline command by piping text input:

```bash
# Generate diagram from a process description
echo "User logs in, validates credentials, redirects to dashboard" | visualizer

# Analyze code and create class diagram
cat src/user.py | visualizer --t class

# Generate sequence diagram and save to custom file
echo "Client sends request, API validates token, Database queries user data, API returns response" | visualizer --t sequence --of api-flow.puml

# Generate multiple diagram variations
cat architecture.txt | visualizer --n 3
```

## Arguments

| Flag | Variable | Default | Description |
|------|----------|---------|-------------|
| `--n` | number | 1 | Number of diagram variations to generate |
| `--t` | type | any | Diagram type (sequence, class, component, activity, state, usecase, deployment, or any) |
| `--of` | outputfile | diagram.puml | Output filename for the generated PlantUML diagram |

## How It Works

1. **AI Analysis** - Analyzes the input text or code using the opencode-grok provider to generate appropriate PlantUML diagram syntax
2. **Post-processing** - Processes and formats the PlantUML output, saving it to the specified file

The tool outputs the processed diagram content and saves the `.puml` file, which can be rendered using PlantUML tools or online renderers.

## Dependencies

None

No reviews yet.

Issues

No issues reported for this tool.