Skip to content

Commit 0490a90

Browse files
committed
Update Readme
1 parent 56bd4d0 commit 0490a90

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

README.md

+13-14
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,26 @@
44
Based on the alternative [Bitwarden](https://bitwarden.com/) CLI [rbw](https://git.tozt.net/rbw) and inspired by [rofi-pass](https://github.com/carnager/rofi-pass), `rbw-rofi` is a simplistic password typer/copier using [rofi](https://github.com/davatorium/rofi) and [wofi](https://hg.sr.ht/~scoopta/wofi).
55

66
## Features
7-
- Type the selected password with `Enter` or `Alt+3` (and copy TOTP to clipboard)
8-
- Type the selected username with `Alt+2`
7+
- Autotype password or username (`Enter`/`Alt+3` and `Alt+2`, respectively)
98
- Autotype username and password (with a `tab` character in between) with `Alt+1` (and copy TOTP to clipboard)
10-
- Copy the username to your clipboard with `Alt+u`
11-
- Copy the password to your clipboard with `Alt+p`
12-
- Copy the totp to your clipboard with `Alt+t`
9+
- Copy username, password or TOTP to the clipboard (`Alt+u`, `Alt+p` and `Alt+t`, respectively)
10+
- Show an autotype menu with all fields
1311

1412
## Configuration
1513
You can configure `rofi-rbw` either with cli arguments or with a config file called `$XDG_CONFIG_HOME/rofi-rbw.rc`. In the file, use the long option names without double dashes.
1614

1715
### Options
1816

19-
| long option | short option | possible values | description |
20-
| --- | --- | --- | --- |
21-
| `--action` | `-a` | `type-password` (default), `type-username`, `autotype`, `copy-username`, `copy-password` | Chose what `rofi-rbw` should do. |
22-
| `--prompt` | `-r` | any string | Define the prompt text for `rofimoji`. |
23-
| `--show-help` | | `true` (default), `false` | Show a help message with the available shortcuts. |
24-
| `--selector` | | `rofi`, `wofi` | Show the selection dialog with this application. |
25-
| `--clipboarder` | | `xsel`, `xclip`, `wl-copy` | Access the clipboard with this application. |
26-
| `--typer` | | `xdotool`, `wtype` | Type the characters using this application. |
17+
| long option | short option | possible values | description |
18+
|-------------------|--------------|---------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
19+
| `--action` | `-a` | `type-password` (default), `type-username`, `autotype`, `copy-username`, `copy-password`, `copy-totp`, `menu` | Chose what `rofi-rbw` should do. |
20+
| `--prompt` | `-r` | any string | Define the prompt text for `rofimoji`. |
21+
| `--show-help` | | `true` (default), `false` | Show a help message with the available shortcuts. |
2722
| `--selector-args` | | | Define arguments that will be passed through to `rofi` or `wofi`.<br/>Please note that you need to specify it as `--selector-args="<args>"` or `--selector-args " <args>"` because of a [bug in argparse](https://bugs.python.org/issue9334) |
23+
| `--selector` | | `rofi`, `wofi` | Show the selection dialog with this application. |
24+
| `--clipboarder` | | `xsel`, `xclip`, `wl-copy` | Access the clipboard with this application. |
25+
| `--typer` | | `xdotool`, `wtype` | Type the characters using this application. |
26+
| `--no-help` | | | By default, `rofi-rbw` shows a list of possible keybindings. If it annoys you, you can deactivate it with this parameter. |
2827

2928
## Installation
3029

@@ -34,6 +33,6 @@ Install the [rofi-rbw](https://aur.archlinux.org/packages/rofi-rbw/) AUR package
3433
### From PyPI
3534
`rofi-rbw` is on [PyPI](https://pypi.org/project/rofi-rbw/). You can install it with `pip install --user rofi-rbw` (or `sudo pip install rofi-rbw`).
3635

37-
### Manual
36+
### Manually
3837
Download the wheel file from releases and install it with `sudo pip install $filename` (or you can use `pip install --user $filename` to only install it for the local user).
3938
Note that it needs `configargparse` to work.

0 commit comments

Comments
 (0)