Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/denisidoro/beavr
A command-line autocompleter with steroids :muscle:
https://github.com/denisidoro/beavr
Last synced: 12 days ago
JSON representation
A command-line autocompleter with steroids :muscle:
- Host: GitHub
- URL: https://github.com/denisidoro/beavr
- Owner: denisidoro
- Created: 2019-04-14T00:39:40.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-10-15T14:01:37.000Z (about 5 years ago)
- Last Synced: 2024-10-14T13:47:39.440Z (26 days ago)
- Language: Clojure
- Homepage: https://www.npmjs.com/package/beavr
- Size: 36.1 KB
- Stars: 43
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# beavr
[](https://circleci.com/gh/denisidoro/beavr)
[](https://badge.fury.io/js/beavr)
[](https://img.shields.io/npm/dt/beavr.svg)
A command-line autocompleter with steroids. :muscle:
Based on the desired command spec, beavr suggests arguments and flags. Suggestions can be selected with [fzf](https://github.com/junegunn/fzf), a fuzzy-finder.
:warning: If you're interested in this project you will probably like [navi](https://github.com/denisidoro/navi)!
The main objectives are:
- to increase discoverability, by showing all possible actions you can take;
- to prevent you from running auxiliar commands, copying the result into the clipboard and then pasting into the original command;
- to improve terminal usage as a whole.
Sure, you can find autocompleters out there for all your favorite commands.
However, they are very specific and each one may offer a different learning curve.
beavr, on the other hand, intends to be a general purpose platform for speccing any command with a couple of lines.
## Installation
```bash
brew install fzf # or equivalent
npm install -g beavr
```
## Usage
It's planned for beavr to ship with some command specs and, in case the command isn't available, beaver should infer the spec given the command's `--help` content.
In the meantime, you must define a `.sh` in `$HOME/.config/beavr/` such as in [these examples](https://github.com/denisidoro/beavr/tree/master/specs):
```bash
beavr::help() {
echo "kubectl controls the Kubernetes cluster manager
Usage:
kubectl get
kubectl describe "
}
beavr::suggestion() {
case "$1" in
"resource") echo "pods nodes deployments" | tr ' ' '\n';;
"id") kubectl get $resource | tail -n +2;;
esac
}
```
As of now, they must conform to [neodoc](https://github.com/felixSchl/neodoc)/[docopt](http://docopt.org/) specifications.
## ZSH widget
Simply source [this file](https://github.com/denisidoro/beavr/blob/master/shell/widget.zsh) 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:
```bash
beavr | pbcopy # or similar clipboard tool
# paste into the command line
```
## Roadmap
Refer to [this dashboard](https://github.com/denisidoro/beavr/projects/1).
Feel free to add new issues or to upvote existing ones.
## Etymology
Command-line call builder > builder > [beaver](https://en.wikipedia.org/wiki/Beaver) > beavr.
## Icon
Icon made by [Freepik](https://www.freepik.com) from [flaticon](https://www.flaticon.com), licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/).