Skip to content

ramble-render-puml

by official

Artifact

Turn PlantUML text into a base64-encoded PNG image via the plantuml CLI

ramble plantuml render png
# ramble-render-puml

Turn PlantUML text into a base64-encoded PNG image via the plantuml CLI

## Installation

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

```bash
cmdforge install ramble-render-puml
```

## Usage

Pipe PlantUML markup text into the tool to render it as a base64-encoded PNG:

```bash
echo "@startuml
Alice -> Bob: Hello
@enduml" | ramble-render-puml
```

```bash
cat diagram.puml | ramble-render-puml > diagram.b64
```

The tool outputs base64-encoded PNG data to stdout, which can be embedded directly in HTML or decoded to a file:

```bash
echo "@startuml
class User {
  +name: string
  +login()
}
@enduml" | ramble-render-puml | base64 -d > diagram.png
```

## Arguments

This tool has no configurable arguments.

## How It Works

1. **Render PlantUML to base64 PNG** - Executes a Python code step that takes the input PlantUML text, passes it through the `plantuml` CLI to generate a PNG image, then encodes the result as base64 for easy embedding or transport.

## Dependencies

- **plantuml** - The PlantUML command-line tool must be installed and available in your PATH

No reviews yet.

Issues

No issues reported for this tool.