Quickstart#
On this page
Get from an install to a sharpened sketch in about five minutes. For the full reference see README.md; for the shortcut tables see CHEATSHEET.md.
1. Install#
Requires Node.js 22.12 or newer. From npm, the command line and then the desktop app, which brings Electron, about 100 MB:
npm install -g @isocialpractice/napkin-sketch
napkin-sketch --install-gui
napkin-sketch # opens a new blank sketch
From a clone, npm start is the fastest way to see the app:
npm install
npm run build
npm start # builds, then opens a new blank sketch
Two other ways to run a clone:
# Use the CLI from anywhere (local checkout)
npm link
napkin-sketch
# Build a native installer into release/
npm run dist:win # or dist:mac, dist:linux
The window opens maximized, which still shows the title bar. Pass
-f / --full-screen for true full screen.
2. Draw something#
The Select tool is active on launch, so press B first to pick up the brush.
B- brush. Draw a wobbly box and a lopsided circle.Wthen5- set the stroke width to 5.C- cycle to the next Quick Access Color;Shift + Cgoes back.- Start a stroke, then hold
Space- it becomes a clean straight line. AddShiftmid-drag to hold it level, plumb or at 45 degrees. Or click, then holdShiftand click again: a line joins the two clicks. - Start a stroke, then hold
Ctrl + Space- a quarter-ellipse curve. AddAltfor a quarter circle, tapShiftto swing the apex 90 degrees. - Before a stroke, hold
Spaceand drag to pan, or holdCtrlto pick something up with the selection tool.
3. Sharpen it#
Press H (Sharpen all) and watch the box square up and the circle round
out, with a subtle wobble left in so it still reads as hand-drawn.
Two ways to run the engine:
- Sharpen all (
H) - clean up the whole page when you are ready. - Live sharpen - beautify each stroke the moment you lift the pen. It is
off by default; turn it on in Quick Settings (
Ctrl + ,).
Tune the result in Quick Settings: wobble, smoothing, circle snap, end taper, rotational symmetry (raise it above 1 for mandala mode), and text size.
4. Work with layers#
Every new element gets its own layer, named after the tool that drew it.
| Do this | Press |
|---|---|
| Show / hide the Layers panel | Ctrl + L |
| Rename the active layer | F2 (or double-click the row) |
| Group the selected layers | Ctrl + G |
| Ungroup | Ctrl + Shift + G |
| Move a layer up / down | Ctrl + ] / Ctrl + [ |
| Move a layer to the top / bottom | Ctrl + Shift + ] / Ctrl + Shift + [ |
| Select the layer above / below | Alt + ] / Alt + [ |
Click a row to make it active; Shift-click to multi-select; drag a row to
restack it, or drop it onto a group row to nest it inside. Selecting on the
canvas highlights the matching rows, and the other way round.
Press S for the Select tool, click a shape, press X to put the fill in
front, then click a Quick Access Color to fill it (with the stroke in front,
the color goes to its outline). Press A for Direct Select and drag an anchor point to reshape
a path; drag over empty canvas to pick the anchors in a box, then drag one of
them or press the arrow keys to move them all, or Delete to take them out
of the path.
5. Save and export#
| Action | Shortcut |
|---|---|
| Save | Ctrl + S |
| Save As | Ctrl + Shift + S |
| Import a file | Ctrl + I |
| Export | File > Export > PNG / JPEG / SVG / PDF |
Sketch books save as .skbk, a human-readable JSON document written
atomically, so an interrupted save cannot corrupt the file you already had.
SVG export is lossless and keeps layer names, gradients, and dash styles, so
the file round-trips back into napkin-sketch unchanged.
6. Drive it from the command line#
# New sketch named "ideas"
napkin-sketch --new ideas
# Open an existing sketch book
napkin-sketch --book ./notes.skbk
# Sharpen a saved book headlessly, then open it
napkin-sketch --sharpen ./notes
# Open a new sketch with a file imported
napkin-sketch --import logo.svg
# Import several files, laid out in a grid
napkin-sketch -m logo.svg,"site map.svg",photo.png
The sharpen engine is pure and deterministic (seeded from each stroke's id),
so --sharpen produces the same result on disk as the GUI does on screen.
7. Where to go next#
- CHEATSHEET.md - every shortcut, CLI flag, and npm script on one page.
- Sketch Support tools - Rectangle (
R), Ellipse (L), Curve (V), Vector Path (P), Paint Bucket (G), Eyedropper (I), Rotate (Ctrl + R), Join strokes (Ctrl + J). - Effects and blends - Effect > Stylize, Warp and 3D, and the Appearance
panel (
Shift + F6), put shadows, glows, bevels, Splatter, Warp and 3D Extrude and Revolve on a mark; Layers > Blend gives a layer one of sixteen blend modes, such as Stack Blend, which is Multiply. - Type (
T) - click to type, drag a box, or click a selected shape or path to type in it or along it; the Type panel (Ctrl + Shift + T) sets the characters and paragraphs, and Type > Markdown Flow (Ctrl + Alt + M) shows Markdown as it renders, with Clean Language Accents coloring its code. - Composition Styles (
Shift + F5) - restyle a page by its layers' names in one click, from styles of your own. - Verbose Settings (
Ctrl + Alt + ,) - everything in Quick Settings plus zoom and pan sensitivity, endpoint snap, toolbar placement and rearrange mode, theme, Quick Access Colors, and auto-save. Settings persist across launches and export to a JSON file. - Embedding - the drawing engine ships as a browser-safe package with no Electron or Node dependency. See Embedding the editor.
- Animation Mode (
Ctrl + Shift + N) - an optional, experimental add-on, left out of a default install because it needs an agentic AI command-line tool you install and sign in to yourself. Add it withnpm run animation-mode -- --install, then restart the app.
Troubleshooting#
| Symptom | Fix |
|---|---|
napkin-sketch is not found | Install it from npm, or run npm run build then npm link in a clone |
napkin-sketch says no desktop app | Run napkin-sketch --install-gui, which adds it with Electron |
| Strokes are not being cleaned up as you draw | Live sharpen is off by default; enable it in Ctrl + , or press H |
| Nothing draws | The Select tool is active at launch; press B for the brush |
Ctrl + Shift + N does nothing | Animation Mode is not installed; run npm run animation-mode -- --status |
| The cursor is a crosshair, not a circle | CapsLock is on; that is the precision cursor |
| A change to the source is not showing | Rebuild with npm run build, or leave npm run build:watch running |
Linux: a SUID sandbox error on npm start | See the install page's [install errors][install-errors] |
macOS: spawn ... ENOENT, malware warning | See the install page's [install errors][install-errors] |
[install-errors]: https://isocialpractice.github.io/napkin-sketch/install.html#troubleshooting-install-errors