https://github.com/edfloreshz/sensei
Sensei is a simple command-line tool to open documentation for any crate in crates.io.
https://github.com/edfloreshz/sensei
cli command-line-tool hacktoberfest rust
Last synced: over 1 year ago
JSON representation
Sensei is a simple command-line tool to open documentation for any crate in crates.io.
- Host: GitHub
- URL: https://github.com/edfloreshz/sensei
- Owner: edfloreshz
- License: gpl-2.0
- Created: 2020-12-02T04:21:17.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-10-15T19:45:57.000Z (over 2 years ago)
- Last Synced: 2025-02-27T05:56:28.140Z (over 1 year ago)
- Topics: cli, command-line-tool, hacktoberfest, rust
- Language: Rust
- Homepage:
- Size: 1.16 MB
- Stars: 28
- Watchers: 4
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Sensei (先生)
Sensei is a simple command line tool to open documentation for any crate in crates.io
## Installation
#### Cargo
```shell
cargo install sensei
```
#### Arch Linux
```rust
paru -S sensei
```
## Usage
```rust
sns [OPTIONS] [FLAGS]
```
### Options
```
-v, --version Opens documentation for a specific version.
-q, --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.
```rust
sns rand
```
##### Opening local documentation for a crate.
```rust
sns rand -l
sns rand --local
```
##### Specifying a version.
```rust
sns rand -v 0.7.2
sns rand --version 0.7.2
```
##### Getting version from Cargo.toml
```rust
sns rand --manifest
sns rand -m
```
##### Sending a query.
```rust
sns rand -q Rng
sns rand --query Rng
```