Skip to content

wensheng/kitdraw

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

kitdraw

Sketch, annotate, and save PNGs or SVGs without leaving your terminal.

(Part of kit* series of graphic terminal apps: kitim kitmd kitpdf kitdraw kitDOOM)

(kitdraw runs on terminals that supports the Kitty graphics protocol: Ghostty, Kitty, WezTerm, cmux)

Install

cargo install kitdraw

Why

  • Stop jumping from terminal to Preview, markup tools, or browser tabs just to circle something in a screenshot.
  • Turn quick visual notes into real PNG files immediately, with numbered saves that do not clobber your last sketch.
  • Stay keyboard-light and mouse-direct: no tool palettes, no modes to babysit, no canvas gymnastics.

Key Capabilities

  • Draw directly on your terminal canvas with Kitty/Ghostty graphics and smooth mouse-driven strokes.
  • Annotate existing images in place by loading a PNG/JPEG/etc. and drawing right over it.
  • Save clean PNG or SVG output automatically with undo, clear, color controls, shape tools, arrows, text, highlighter, redaction, contrast-aware default ink, and adjustable render resolution for speed.

Usage

kitdraw
kitdraw screenshot.png
kitdraw screenshot.png --resolution-scale 0.25 -o notes.png
kitdraw screenshot.png -o notes.svg
kitdraw screenshot.png --export-size canvas -o terminal-sized.png

How It Works

terminal size -> scaled RGBA canvas -> mouse annotations -> zlib Kitty frames -> autosaved PNG/SVG

The fast path is intentionally simple: keep a committed image for completed drawing elements, preview only the active annotation, compress RGBA frames with Kitty's graphics protocol, and write the final composited canvas on exit. Image annotations export at the original image size by default; use --export-size canvas to keep the terminal canvas dimensions.


Controls

Action Control
Draw active tool Left mouse drag
Freehand tool f
Rectangle tool r
Ellipse tool e
Arrow tool a
Text tool t, then click, type, and press Enter
Highlighter tool h
Redaction tool x
Change stroke/text size [ / ]
Change color Click a status-bar swatch, or press c and enter a color name/hex value
Undo z
Clear drawing layer C
Save and quit q, Esc, or Ctrl-C

About

Draw it fast, build it faster. Put your ideas in motion instantly. Do all in terminal.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages