v0.9.0
guide / Real use cases

Real use cases

Ten situations you actually meet, with the exact keys. Nothing here needs a

v0.9.0 15 / 21 3 min read docs/GUIDE.md

Read one long article

An essay, a blog post, a paper — you want the text and nothing else.

wr https://blog.example/posts/the-case-for-boring-tools
t              sections: jump straight to the part you need
]   [          read it top-down, heading by heading
/   word       find a term; n jumps to the next
*              bookmark it: `~` brings it back tomorrow
d   u          half a page at a time when the text is dense

If the page has a paywall JavaScript wall, x opens it in your browser.

Follow documentation across pages

Library docs are the reason H exists: jump in, read one paragraph, jump back.

wr https://go.dev/doc/effective_go
f              label every link on the page
s              open the one labelled "s" — say, "Formatting"
…read…
H              back on this page, at exactly this line
f              next link

With ten pages open in a row, v lists them all — you can jump between them with the arrow keys and Enter instead of walking back one by one.

Research a question end to end

wr postgres vacuum bloat
(three or four results, as a normal page)
f    s         open the first result
read, and if the page has what you need:
*              bookmark it
H              back to the results
f    d         open the next one

Or stay on the results page and use / to find the word you came for, then f to open the link that mentions it.

Copy commands from a tutorial

wr https://example.com/tutorials/deploy-with-docker
drag over the code block, or double-click a line
   the copy drops the frame and the left margin: paste and run
y              copy again if you need it twice

For a command inside a paragraph, copy the line the same way: wrapped paragraphs are joined back into one line, so a long command pastes as one line.

Read a project README

wr https://github.com/sazardev/wr            # the rendered page
wr https://raw.githubusercontent.com/sazardev/wr/main/README.md

The second form is the Markdown itself, ideal for READMEs: headings, tables and code render exactly as on GitHub, with no navigation around them.

Read your own notes offline

wr ~/notes/ideas.md
wr ./docs/deploy.html

Notes are local pages: f labels the links between them, t gives you the headings, / finds a word. A folder of Markdown files becomes a small knowledge base you can read on a plane.

A morning scan with the start page

Bookmark the handful of sites you read daily (* on each one), then every morning just run wr: the start page lists them as links. f and one letter opens the first; H brings you back to the list. v shows what you read yesterday if you want to continue where you left off.

Read on a remote machine over SSH

ssh build-server
wr https://go.dev/doc/

Everything works, including copying: the text goes to the clipboard of the machine you are sitting at through OSC 52, as long as your terminal allows it (most do; Alacritty and kitty out of the box). Drag-select is the fastest way here, since the remote machine has no clipboard of its own worth using.

Feed a page to your editor or a script

wr --md https://go.dev/doc/effective_go | grep -n "interface"
wr --md URL | pandoc -f gfm -t html
COLUMNS=60 wr https://example.com/changelog | less -R

Use --md for the Markdown, the plain pipe for a formatted render, -L to drop link addresses, --fresh when you know the cached copy is stale.