@termdraw/app
v0.3.5
Published
Standalone termDRAW terminal drawing app.
Maintainers
Readme
@termdraw/app
@termdraw/app is the standalone termDRAW terminal app for developers who want editable diagrams, UI mocks, and text graphics without leaving the terminal.
What it does
- Draw boxes, lines, paint strokes, and text as retained objects.
- Select, move, resize, and recolor objects after you draw them.
- Group related content inside boxes while everything stays aligned to terminal cells.
- Export plain text or fenced Markdown for docs, tickets, and prompts.
Install
Requirements:
- Bun 1.3+
- A terminal with mouse support
npm install --global @termdraw/appQuick start
termdrawDraw something, then press Enter or Ctrl+S to write the result to stdout.
Usage
# save plain text directly to a file
termdraw --output diagram.txt
# export a fenced Markdown code block
termdraw --fenced > diagram.md
# show CLI help
termdraw --helptermDRAW! outputs terminal text, not SVG or bitmap graphics.
OpenTUI package
If you want the embeddable OpenTUI components instead of the packaged app:
npm install @termdraw/opentui @opentui/core @opentui/react reactContributing
Contributions are welcome.
Before opening a PR:
- keep the change focused
- run
bun run check - add or update tests when editor behavior changes
- open an issue first for larger UX or API changes
Security
Please report security issues privately through GitHub Security Advisories:
License
MIT. See LICENSE.
