How do I display these diagrams in GitHub or GitLab?

Simply copy the generated .atxt or .utxt content into a Markdown code block using triple backticks and a fixed-width specifier like 'text' to ensure proper alignment.

Can I use this for complex system architectures?

Yes, though ASCII diagrams are best suited for focused logic. For extremely complex systems, it is recommended to use short labels and Unicode mode to maintain readability in fixed-width environments.

What is the difference between ASCII and Unicode output?

Standard ASCII (-txt) uses basic characters like dashes and pipes for maximum compatibility, while Unicode (-utxt) uses specialized box-drawing characters for a cleaner, more professional visual appearance.

Which diagram types can I create in ASCII?

It supports all major PlantUML types, including sequence, class, activity, state, component, use case, and deployment diagrams.

Does this skill require a local PlantUML installation?

Yes, the skill utilizes your local PlantUML environment or JAR file to process syntax and generate the corresponding text-based output files.

PlantUML ASCII Diagram Generator

Name: PlantUML ASCII Diagram Generator
Author: Tahir-yamin

byTahir-yamin

•

学习与文档

Generates terminal-friendly ASCII and Unicode text diagrams directly from PlantUML code for documentation and CLI environments.

The PlantUML ASCII skill enables developers to create structural and behavioral visualizations without the overhead of graphical rendering. By leveraging PlantUML's powerful syntax, it produces clean ASCII or Unicode-enhanced text diagrams that are perfect for terminal-based workflows, Git commit messages, and version-controlled Markdown documentation. This skill is particularly useful for maintaining architecture maps that remain readable in any text editor, supporting a wide array of formats including sequence, class, and activity diagrams while ensuring high visual fidelity through optional Unicode box-drawing characters.

主要功能

01Supports multiple diagram types including sequence, class, state, and activity diagrams

02Creates lightweight, version-controllable documentation without external image assets

035 GitHub stars

04Integrates seamlessly with terminal workflows and command-line interfaces

05Converts PlantUML syntax into pure ASCII text for universal compatibility

06Generates high-quality Unicode box-drawing diagrams using the -utxt flag

使用场景

01Visualizing complex logic flows or state machines during remote SSH terminal sessions

02Including sequence diagrams in Git pull request descriptions for better code review context

03Embedding readable architecture diagrams directly into README.md files without hosting images

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tahir-yamin/dev-engineering-playbook plantuml-ascii

For use in Claude.ai and ChatGPT

Download Skill