ascii-diagram-boxflow
npx machina-cli add skill partme-ai/full-stack-skills/ascii-diagram-boxflow --openclawWhen to use this skill
CRITICAL TRIGGER RULE
- Use this skill ONLY when the user explicitly mentions the exact skill name:
ascii-diagram-boxflow.
Trigger phrases include:
- "ascii-diagram-boxflow"
- "use ascii-diagram-boxflow"
- "用 ascii-diagram-boxflow 画 ASCII 流程图/框图"
- "使用 ascii-diagram-boxflow 生成 box + 箭头连接图"
Boundary
- ASCII output only. Do not output Mermaid/PlantUML.
- Recommended nodes <= 12; if larger, split into sub-diagrams.
- Auto-layout is best-effort for linear and simple branching. Complex layouts require manual ordering or splitting.
How to use this skill
Inputs
- nodes (node list; names required)
- edges (connections: from/to)
- direction (TB | LR, default TB)
- width (default 80)
- boxWidth (default 16)
- numbering (default false)
Outputs (required)
- diagram (ASCII-only)
- layoutRules (box width + arrow/line rules)
- splitAdvice (how to split complex diagrams)
Script
scripts/boxflow.py: best-effort for linear flows and single 2-way branching
Examples
examples/login-flow.md
Quality checklist
- Arrow direction is unambiguous; avoid crossings
- Line width
<= width; no trailing spaces - Long node names must be truncated or wrapped consistently
Keywords
English: ascii-diagram-boxflow, ascii diagram, flowchart, box, arrow, plain text, terminal 中文: ascii-diagram-boxflow, ASCII 框图, 流程图, 纯文本, 盒子, 箭头, 终端
Source
git clone https://github.com/partme-ai/full-stack-skills/blob/main/skills/ascii-diagram-boxflow/SKILL.mdView on GitHub Overview
ascii-diagram-boxflow generates plain ASCII box-flow diagrams (boxes and arrows) for environments without renderers. It applies alignment rules and split strategies to keep complex graphs readable, while respecting width and box sizing. The skill accepts node lists, edge connections, and layout options and outputs the diagram plus layout rules and split guidance.
How This Skill Works
The script boxflow.py produces best-effort layouts for linear flows and single two-way branching. It enforces width constraints, truncates or wraps long node names, and provides splitAdvice when the diagram is too large to fit in one diagram.
When to Use It
- Use ascii-diagram-boxflow when you need plain ASCII diagrams in terminal environments without renderers.
- When your diagram features multiple boxes and arrows but must stay within a fixed width.
- When the diagram is too complex for a single diagram and splitting into sub-diagrams is preferred.
- When you want an auto-layout for simple or linear flows with clear arrow directions.
- When you need structured outputs: diagram, layoutRules, and splitAdvice for reproducibility.
Quick Start
- Step 1: Define inputs: list of nodes, edges, direction, width, and boxWidth.
- Step 2: Run the script (e.g., python scripts/boxflow.py) to generate diagram, layoutRules, and splitAdvice.
- Step 3: Review the ASCII diagram and, if needed, adjust inputs or split into sub-diagrams using splitAdvice.
Best Practices
- Keep node names concise to fit within boxWidth and overall width.
- Choose direction TB (top-to-bottom) or LR (left-to-right) based on reading flow.
- Aim for 12 or fewer nodes per diagram to maximize readability.
- Enable numbering if you need precise reference across sub-diagrams.
- Review splitAdvice to decide where to break large graphs into sub-diagrams.
Example Use Cases
- Login flow drawn in ASCII to document authentication steps in a terminal wiki.
- Onboarding steps for a new user, showing boxes for signup, verification, and welcome emails.
- API call sequence illustrating request, processing, and response paths.
- Deployment pipeline from code commit to production rollout with verification and monitoring.
- Troubleshooting flowchart guiding incident response in a terminal-based runbook.
