Skip to content

Commit

Permalink
Add pass_plugin and vonalc to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fxdave committed Apr 23, 2023
1 parent a8935f7 commit 3245075
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,35 @@ If you use bspwm, an example rule to keep Vonal floating:

## The current state

Currently, there are 2 plugins:
Currently, there are 3 plugins:

- **Application launcher plugin:** A fuzzy search for .desktop files and executables in $PATH, supporting sub-actions
- **Application launcher (launcher_plugin):** A fuzzy search for .desktop files and executables in $PATH, supporting sub-actions
- trigger: anything
- shortcuts:
- Up, Down, Left, Right, Enter
- example commands:
- `chr` finds chromium
- `chr github.com` finds chromium and on enter, it opens it with `github.com`
- `,` is for settings like reload application cache
- **Calculator plugin:** a python proxy
- **Calculator (math_plugin):** a python proxy
- trigger: `=`
- example commands:
- `= sin(radians(90))` prints `1.0`
- `= [i for i in range(1000) if i %99 == 0]` shows the numbers between 0 and 999 that are dividable by 99
- **Password manager (pass_plugin):** A configurable password manager plugin. It works with every password managers, however, the default config is only for GNU pass. This is not meant to be used from the search menu although you can reach it that way as well.
- suggested binding: `super+p` `vonalc set_query pass_plugin show`
- trigger: `pass_plugin`

Warning: On update you have to manually enable new plugins.

## Vonal Client Commands (vonalc)
Synopsis: `vonalc commandA arg1 arg2 commandB arg1 ...`

- `show`: show the window
- `hide`: hide the window
- `toggle`: show/hide the window
- `set_query "something"`: writes the word "something" to the searchbar.


## Configuration
The configuration file is created on the fly to `~/.config/vonal/config.toml`.
Expand Down

0 comments on commit 3245075

Please sign in to comment.