SuperAPI AI Directory

ascii-diagram-boxflow

General & other

View repository

Updated 10-15 21:47

About this skill

When 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"
  • "Draw ASCII flowcharts/box diagrams with ascii-diagram-boxflow"
  • "Use ascii-diagram-boxflow to generate box + arrow connection diagrams"

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

  1. Arrow direction is unambiguous; avoid crossings
  2. Line width <= width; no trailing spaces
  3. Long node names must be truncated or wrapped consistently

Keywords

English: ascii-diagram-boxflow, ascii diagram, flowchart, box, arrow, plain text, terminal Chinese: ascii-diagram-boxflow, ASCII box diagram, flowchart, plain text, box, arrow, terminal

Common Gotchas

  1. Version compatibility: Pay attention to compatibility between framework versions and dependency libraries; APIs may differ across versions
  2. Configuration file format: Configuration file format errors are the most common issue; it is recommended to use your editor's syntax checking
  3. Environment variables: Ensure all necessary environment variables are set correctly, and do not hardcode sensitive information
  4. Dependency conflicts: Watch out for dependency conflicts when multiple versions coexist, and use a lock file to pin versions
  5. Performance pitfalls: Pay attention to performance optimization in large-data scenarios, and avoid common issues such as N+1 queries

Usage workflow

Step 1: Environment preparation

Ensure the development environment has the necessary dependencies and tools installed.

Step 2: Configuration initialization

Perform basic configuration according to project requirements.

Step 3: Using core functionality

Implement the core functionality according to the example code.

Step 4: Test verification

Run tests to ensure the functionality works properly.

Step 5: Deployment and release

After development is complete, deploy and monitor.