README.md

Sensei (先生)

Sensei is a simple command line tool to open documentation for any crate in crates.io

Installation

Cargo

cargo install sensei

Arch Linux

paru -S sensei

Usage

sns <crate> [OPTIONS] [FLAGS]

Options

-v, --version <version>    Opens documentation for a specific version.
-q, --query <query>      Specifies query to search documentation.

Flags

-h, --help      Prints help information
-l, --local    Tries to open local documentation.
-m, --manifest  Looks up the version in Cargo.toml

Examples

Opening documentation for a crate.

sns rand

Opening local documentation for a crate.

sns rand -l
sns rand --local

Specifying a version.

sns rand -v 0.7.2
sns rand --version 0.7.2

Getting version from Cargo.toml

sns rand --manifest
sns rand -m

Sending a query.

sns rand -q Rng
sns rand --query Rng