Skip to content

Repository files navigation

rustdoc-viewer

A terminal-based viewer for Rust documentation, driven by rustdoc's JSON output.

Browse std in the terminal: fuzzy-search every item, read rendered docs with syntax-highlighted examples, and follow intra-doc links the way you would in a browser.

Requirements

The nightly toolchain's rust-docs-json component:

rustup component add rust-docs-json --toolchain nightly

rdv reads the JSON emitted by that component and expects a specific rustdoc format version. If your nightly has moved ahead of what this build supports, point it at an older toolchain instead of downgrading:

RDV_TOOLCHAIN=nightly-2026-08-23 rdv

The same applies when running the test suite: the tests assert against the real std documentation and fail, rather than skipping, when it cannot be loaded.

Usage

cargo run --release

The binary is named rdv. It opens on the std root module; press / to search.

std, core, and alloc are loaded and merged into one universe, so Vec and Option are found and shown under their familiar std:: names rather than the crates that define them.

Keys

Key Action
/ open search
open selected · follow focused link
tab / ⇧tab focus next / previous link
u go up to the parent item
^o / backspace go back
^f go forward
j / k / / scroll
^d / ^u half page
g / G top / bottom
n / p next / previous section
space fold or unfold a section
? toggle help
esc close search or help
q quit

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

About

A text-mode rustdoc viewer

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages