API

Ferritin – terminal-based Rust documentation viewer

Ferritin is a terminal-based Rust documentation viewer. It reads rustdoc JSON output and displays Rust documentation directly in your terminal.

The software supports documentation for local workspace crates, the Rust standard library, and crates from crates.io. It offers both an interactive terminal interface and a command-line mode for quick documentation lookups.

This is free and open source software.

Key Features

  • Browse Rust documentation interactively from the terminal.
  • View documentation for local workspace crates, standard library components, and crates from crates.io.
  • Search across all available crates or within a specific crate.
  • Use a one-shot command-line interface for quick documentation lookups.
  • Navigate with the keyboard or mouse.
  • Provides syntax highlighting, Unicode box drawing, italics, and OSC 8 hyperlinks.
  • Follow navigation history and a breadcrumb trail.
  • Automatically detects terminal, plain text, and agent-oriented output formats.
  • Offers structured JSON output for scripting and programmatic use.
  • Caches downloaded documentation and lazily generated search indexes.
  • Supports mouse hover previews in compatible terminals.

Website: github.com/jbr/ferritin
Support:
Developer: Jacob Rothstein
License: Apache License 2.0 / MIT License

Human-friendly CLI for browsing Rust documentation

Ferritin is written in Rust. Learn Rust with our recommended free books and free tutorials.


Related Software

API Documentation Browsers
DevDocsAPI documentation browser written in Ruby and JavaScript
ZealSimple offline documentation browser
Qt AssistantTool for viewing on-line documentation in Qt help file format
BibliotecaBrowse and read GNOME documentation
DevhelpDeveloper tool for browsing and searching API documentation
dedocTerminal-based viewer for DevDoc
dashtSearch API docs offline in your terminal or browser
FerritinTerminal-based Rust documentation viewer
quickDocsDeveloper docs reader
Doc BrowserAPI documentation browser with support for DevDocs, Dash and Hoogle

Read our verdict in the software roundup.


Best Free and Open Source Software LinuxLinks helps you discover the best free and open source software for Linux. Explore our extensive collection of recommended applications, including alternatives to popular proprietary software.

We also publish software reviews, Linux tutorials, hardware reviews, free programming books and articles covering the wider open source community. Browse our Linux resources to discover more.

Know a useful free and open source Linux application we haven't covered? Suggest a program for inclusion.

Has your software been featured on LinuxLinks? Display one of our Featured on LinuxLinks badges on your website or GitHub README.
Subscribe

Please read our Comment Policy before commenting.

Notify of
guest
0 Comments
Oldest
Newest Most Voted