Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor fixes #10

Merged
merged 2 commits into from Apr 16, 2019
Merged

Minor fixes #10

merged 2 commits into from Apr 16, 2019

Conversation

denisidoro
Copy link
Owner

@denisidoro denisidoro commented Apr 16, 2019

beavr

npm version

A command-line autocompleter with steroids.

Based on the target command documentation, it suggests arguments, flags and allows you to select between options with fzf, a fuzzy-finder.

Demo

Installation

npm install beavr

Usage

It's planned for beavr to infer documentation from the target tool's --help content.

In the meantime, you must define a <your-cmd>.sh in $HOME/.config/beavr/ such as these examples.

As of now, they must conform to Neodoc/docopt specifications.

ZSH widget

Simply source this file in your .zshrc.

By default, the widget is trigged by Alt + G.

Widgets for other shells

While there is no widget for other shells, please run the following:

beavr <your-cmd> | pbcopy # or similar clipboard tool

Roadmap

Please refer to this dashboard.

Etymology

Command-line call builder > builder > beaver > beavr

Icon

Icon made by Freepik from flaticon is licensed by CC 3.0 BY.

@denisidoro denisidoro merged commit 2947721 into master Apr 16, 2019
@denisidoro denisidoro deleted the minor/fixes branch April 16, 2019 21:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant