Metadata-Version: 2.1
Name: vim-prompt
Version: 0.1.0
Summary: A Vim cheatsheet prompter and command browser using rofi/fzf
Home-page: https://github.com/ubuntupunk/vim-prompt
Author: Ubuntpunk
Author-email: ubuntupunk@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"

# Vim Cheat Sheet | rofi / fzf launcher

![dark-cover](https://github.com/ubuntpunk/rofi-vim/blob/main/src/readme/Dark-Cover.png#gh-dark-mode-only)
![light-cover](https://github.com/ubuntpunk/rofi-vim/blob/main/src/readme/Light-Cover.png#gh-light-mode-only)

This project provides two helpers to access to **Vim commands** and **shortcuts** via an **interactive cheat sheet**


## Versions

There are two versions to suit different user preferences:

1. **CLI Version**: Ideal for users who prefer interacting through the command line.
2. **Rofi Popup Version**: Designed for users who prefer a graphical interface, providing a visually appealing and intuitive experience, great for tiling window managers like [i3](https://i3wm.org/) and [bspwm](https://github.com/baskerville/bspwm).

## Usage

| Keyword        | Description                                                                    | Example     |
| -------------- | ------------------------------------------------------------------------------ | ----------- |
| ``vm {query}`` | Search for vim**commands** and **shortcuts** for a given `query` | `vm exit` |

## Features

* Search for Vim Commands either by their description or their Hotkey.
* Hitting enter on a command will redirect to [Vim Cheat Sheet](https://vim.rtorr.com/ "rtorr website") on the same command.

* Command fragments have not been tested and my not be fully functional, please report if any of them didn't work.

## Installation

### Manual Installation

* Download the [Latest Release](https://github.com/ubuntpunk/rofi-vim/releases/latest)
* Extract the archive and copy the files to `~/.local/share/rofi-vim`

### System requirements
- Rofi
- Fzf

### Installation 
Ubuntu/Debian
```bash
sudo apt install rofi fzf
``` 

### Operation
`fzf-vim`  `# Uses fzf interface`

`rofi-vim`  `# Uses rofi interface`

## Disclaimer

* The database of this repository is the result of the work of [Vim Cheat Sheet](https://vim.rtorr.com/ "rtorr website")
and based upon the [FlowLauncher Plugin VimCheatSheet Project](https://github.com/MoAlSeifi/Flow.Launcher.Plugin.VimCheatSheet)

* This project is not associated with Vim Cheat Sheet or FlowLauncher.

## References

- Powered by [Vim Cheat Sheet](https://vim.rtorr.com/ "rtorr website") as source for [commands.json](https://github.com/ubuntpunk/rofi-vim/blob/main/db/commands.json "commands json database")
