pombadev / bropages Goto Github PK

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

License: MIT License

Rust 100.00%

bropages cli tldr-pages manpage tldr

bropages's Introduction

bropages (bro)

A CLI to interact with bropages.org.

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

Screencast

Installation

The binary name for bropages is bro.

Currently bropages is only available through cargo.

cargo install bropages

Available options

USAGE:
    bro [OPTIONS] <query>

ARGS:
    <query>
            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 <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.
I don't have any intentions to add the add, no/...no or thanks commands.

TODO

Cache results ?

bropages's People

Contributors

Stargazers

Watchers

Forkers

psehgaft 3p1cw0mb4t

bropages's Issues

proxy support

Doesn't seem to support $HTTP_PROXY or $HTTPS_PROXY environment variables.

installation options

On the GitHub README, it says:

Currently bropages is only available through cargo

on the bropages.org there is another option for installation:

gem install bropages

should add gem install bropages to README as well

Unable to install on Centos9

Trying to install on Centos Stream 9. When i run cargo install bropages

Caused by:
  process didn't exit successfully: `/tmp/cargo-installS7Vh2z/release/build/bropages-5db906cb1f09dfa0/build-script-build` (exit status: 101)
  --- stderr
  thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: Os { code: 2, kind: NotFound, message: "No such file or directory" }', /home/student/.cargo/registry/src/github.com-1ecc6299db9ec823/bropages-1.40.0/build.rs:7:10
  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
warning: build failed, waiting for other jobs to finish...
error: failed to compile `bropages v1.40.0`, intermediate artifacts can be found at `/tmp/cargo-installS7Vh2z`

When i run cargo install --git https://github.com/pombadev/bropages.git, i get virtually the same error

Caused by:
  process didn't exit successfully: `/tmp/cargo-install2G52JH/release/build/bropages-8182132bf134a16d/build-script-build` (exit status: 101)
  --- stderr
  thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: Os { code: 2, kind: NotFound, message: "No such file or directory" }', build.rs:7:10
  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
warning: build failed, waiting for other jobs to finish...
error: failed to compile `bropages v1.40.0 (https://github.com/pombadev/bropages.git#aa6c2f24)`, intermediate artifacts can be found at `/tmp/cargo-install2G52JH

Comments hard to read in default oh-my-zsh color pallette

Given a good portion of users will be using this with oh-my-zsh on the default color palette, could be nice if comments were a bit easier to read.

Thanks for making this.

Wrong number of arguments (given 2, expected 1)

~ bro --trace find
/home/aljustiet/.local/share/gem/ruby/3.0.0/gems/json_pure-1.8.1/lib/json/common.rb:155:in `initialize': wrong number of arguments (given 2, expected 1) (Argum>
        from /home/aljustiet/.local/share/gem/ruby/3.0.0/gems/json_pure-1.8.1/lib/json/common.rb:155:in `new'
        from /home/aljustiet/.local/share/gem/ruby/3.0.0/gems/json_pure-1.8.1/lib/json/common.rb:155:in `parse'
        from /home/aljustiet/.local/share/gem/ruby/3.0.0/gems/bropages-0.1.0/lib/bro.rb:264:in `block (2 levels) in <top (required)>'
        from /home/aljustiet/.local/share/gem/ruby/3.0.0/gems/commander-4.1.5/lib/commander/command.rb:180:in `call'
        from /home/aljustiet/.local/share/gem/ruby/3.0.0/gems/commander-4.1.5/lib/commander/command.rb:155:in `run'
        from /home/aljustiet/.local/share/gem/ruby/3.0.0/gems/commander-4.1.5/lib/commander/runner.rb:402:in `run_active_command'
        from /home/aljustiet/.local/share/gem/ruby/3.0.0/gems/commander-4.1.5/lib/commander/runner.rb:78:in `run!'
        from /home/aljustiet/.local/share/gem/ruby/3.0.0/gems/commander-4.1.5/lib/commander/delegates.rb:7:in `run!'
        from /home/aljustiet/.local/share/gem/ruby/3.0.0/gems/commander-4.1.5/lib/commander/import.rb:10:in `block in <top (required)>'