Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/limebrains/sufler
generating bash/zsh/powershell/fish autocompletions from yml file
https://github.com/limebrains/sufler
autocomplete bash fish powershell python yaml zsh
Last synced: 16 days ago
JSON representation
generating bash/zsh/powershell/fish autocompletions from yml file
- Host: GitHub
- URL: https://github.com/limebrains/sufler
- Owner: limebrains
- License: mit
- Created: 2018-03-06T09:06:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-25T21:56:10.000Z (over 3 years ago)
- Last Synced: 2024-10-03T19:38:33.614Z (about 1 month ago)
- Topics: autocomplete, bash, fish, powershell, python, yaml, zsh
- Language: Python
- Homepage:
- Size: 68.4 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sufler
Sufler - is the tool to help you with generating bash/zsh/powershell/fish autocompletions from YAML file.
[](https://travis-ci.org/limebrains/sufler)
[](https://coveralls.io/github/limebrains/sufler?branch=master)
[](http://sufler.readthedocs.io/en/latest/?badge=latest)
[Documentation](http://sufler.readthedocs.io/en/latest/?badge=latest)
## Usage
[](http://sufler.readthedocs.io)
```bash
| => sufler --help
Usage: sufler [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
init initialize Sufler directory and config file
install install completions
run run command from
```
## Quickstart:
```bash
pip install sufler
```
or
```
bash -c "$(curl -fsSL https://raw.githubusercontent.com/limebrains/sufler/master/install.bash)"
```
you will have directory in your home dir where you can install your custom completions.
```
/Users/pythonicninja/.sufler/
├── completions
│ ├── npm.yml
│ └── pip.yml
└── .config
```
there is repo which accepts PR's with common completions
[sufler-completions - github.com](https://github.com/limebrains/sufler-completions)
## Key ideas:
### Example yml file:
```yaml
'pip': &pip
'install': &install
'--constrain': &constraint
'': *install
'--build': &build
'': *install
'--no-deps': *install
'--install-option':
' wget https://pypi.python.org/simple/ -O ~/.sufler/python_completions -c -q && cat ~/.sufler/python_completions | cut -d ">" -f 2 | cut -d "<" -f 1 | grep "^TREE~1.*"': *install
```
[full raw file](https://raw.githubusercontent.com/limebrains/sufler-completions/master/completions/pip.yml)
Please notice special names of keys such as:
- ``
- ``
- ``
- ``
[All of them are documented in details - readthedocs.io](http://sufler.readthedocs.io/en/latest/user/advanced.html)
### Origin of the name
Name comes from (pol. sufler - [wiki](https://pl.wikipedia.org/wiki/Sufler))
> The prompter (sometimes prompt) in a theatre is a person who prompts or cues actors when they forget their lines or neglect to move on the stage to where they are supposed to be situated.
