https://github.com/pombadev/bropages

Highly readable supplement to man pages from http://bropages.org. Shows simple, concise examples for commands with syntax highlighting.
https://github.com/pombadev/bropages

bropages cli manpage tldr tldr-pages

Last synced: 10 months ago
JSON representation

Highly readable supplement to man pages from http://bropages.org. Shows simple, concise examples for commands with syntax highlighting.

• Host: GitHub
• URL: https://github.com/pombadev/bropages
• Owner: pombadev
• License: mit
• Created: 2020-03-07T20:43:42.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-09T04:36:06.000Z (about 2 years ago)
• Last Synced: 2024-11-21T23:53:16.286Z (over 1 year ago)
• Topics: bropages, cli, manpage, tldr, tldr-pages
• Language: Rust
• Homepage:
• Size: 2.73 MB
• Stars: 27
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-MIT.md

Awesome Lists containing this project

README

          
bropages (bro)

------------

A CLI to interact with [bropages.org](http://bropages.org).

Highly readable supplement to man pages. Shows simple, concise examples for commands with syntax highlighting.

[![Crates.io](https://img.shields.io/crates/v/bropages)](https://crates.io/crates/bropages)

![License](https://img.shields.io/crates/l/bropages)

### Screencast

[![A screenshot](./screencast.gif)](./screencast.gif)

### Installation

The binary name for bropages is `bro`.

Currently `bropages` is only available through `cargo`.

```

cargo install bropages

```

### Available options

```

USAGE:

    bro [OPTIONS] 

ARGS:

    

            Command to lookup

OPTIONS:

    -h, --help

            Print help information

        --list-themes

            Display a list of supported themes for syntax highlighting.

        --no-paging

            Disable piping of the output through a pager

    -s, --search

            Search if provided query exist in the database

            This searches for entries in the http://bropages.org database

    -t, --theme 

            Set the theme for syntax highlighting, default is `OneHalfDark`. Use '--list-themes' to

            see all available themes.

            [possible values: 1337, Coldark-Cold, Coldark-Dark, DarkNeon, Dracula, GitHub, "Monokai

            Extended", "Monokai Extended Bright", "Monokai Extended Light", "Monokai Extended

            Origin", Nord, OneHalfDark, OneHalfLight, "Solarized (dark)", "Solarized (light)",

            "Sublime Snazzy", TwoDark, "Visual Studio Dark+", ansi, base16, base16-256,

            gruvbox-dark, gruvbox-light, zenburn]

    -V, --version

            Print version information

```

### Note

- This is an unofficial rust port of [ruby bropages](https://rubygems.org/gems/bropages).

- I don't have any intentions to add the `add`, `no`/`...no` or `thanks` commands.

### TODO

 - [ ] Cache results ?