handlr/README.md

121 lines
4.2 KiB
Markdown
Raw Permalink Normal View History

2020-05-16 09:55:08 +02:00
<h1 align=center> <img src="https://user-images.githubusercontent.com/11352152/82113733-3f9c9800-9726-11ea-977d-a2f43e5d392e.png" width=64 align=top /><br/>handlr</h1>
Manage your default applications with ease using `handlr`!
2020-05-17 22:50:57 +02:00
## Features
2020-05-16 09:56:03 +02:00
2020-05-16 09:55:08 +02:00
- Set default handler by extension or mime-type
2020-05-17 23:01:37 +02:00
- Intelligent mime type detection from files based on extension and content
2020-06-20 02:46:30 +02:00
- Open multiple files at once
2021-04-24 00:48:15 +02:00
- Set multiple handlers for mime/extension and use `rofi`/`dmenu` to pick one
- Wildcard support like `text/*`
2020-05-17 22:13:51 +02:00
- Automatically removes invalid/wrong `.desktop` entries from `mimeapps.list`
2020-05-17 23:01:37 +02:00
- Helper commands like `launch`, `get --json` for your scripting needs
- Unnecessarily fast (written in Rust)
- Single compiled binary with no dependencies
2020-05-16 09:55:08 +02:00
2020-05-17 23:01:37 +02:00
## Usage
```sh
# Open a file/URL
handlr open ~/.dotfiles/pacman/packages.txt
handlr open https://google.ca
# Set default handler for png files
handlr set .png feh.desktop
2021-04-24 00:48:15 +02:00
# Set wildcard handler for all text files
handlr set 'text/*' nvim.desktop
2020-05-17 23:01:37 +02:00
# Set default handler based on mime
handlr set application/pdf evince.desktop
# List default apps
handlr list
# Get the handler for a mime/extension
$ handlr get .png
feh.desktop
# Launch a handler with given path/URL
handlr launch x-scheme-handler/https -- https://google.ca
```
## Compared to `xdg-utils`
2021-04-24 00:48:15 +02:00
2020-06-20 02:46:30 +02:00
- Can open multiple files/URLs at once
- Can have multiple handlers and use rofi/dmenu to pick one at runtime
2020-05-17 23:35:53 +02:00
- Far easier to use with simple commands like `get`, `set`, `list`
2020-05-16 09:56:03 +02:00
- Can operate on extensions, **no need to look up or remember mime types**
2020-05-16 09:55:08 +02:00
- useful for common tasks like setting a handler for png/docx/etc files
2021-07-21 19:00:25 +02:00
- Superb autocomplete (currently fish, zsh and bash), including mimes, extensions, and `.desktop` files
2021-04-24 00:48:15 +02:00
- Optional json output for scripting
- Properly supports `Terminal=true` entries
## Setting default terminal
Unfortunately, there isn't an XDG spec and thus a standardized way for `handlr` to get your default terminal emulator to run `Terminal=true` desktop entries. There was a proposal floating around a few years ago to use `x-scheme-handler/terminal` for this purpose. It seems to me the least worst option, compared to handling quirks of N+1 distros or using a handlr-specific config option.
2021-04-25 19:03:49 +02:00
Now if `x-scheme-handler/terminal` is present, `handlr` will use it.
Otherwise, `handlr` will:
2021-04-24 00:48:15 +02:00
1. Find an app with `TerminalEmulator` category
2. Set it as the default for `x-scheme-handler/terminal`
3. Send you a notification to let you know it guessed your terminal and provide instructions to change it if necessary
On the upside, `Terminal=true` entries will now work outside of interactive terminals, unlike `xdg-utils`.
2020-05-16 09:55:08 +02:00
2020-06-20 02:46:30 +02:00
## Setting multiple handlers
1) Open `~/.config/handlr/handlr.toml` and set `enable_selector = true`. Optionally, you can also tweak the `selector` to your selector command (using e.g. rofi or dmenu).
2) Add a second/third/whatever handler using `handlr add`, for example
```
handlr add x-scheme-handler/https firefox-developer-edition.desktop
```
3) Now in this example when you open a URL, you will be prompted to select the desired application.
![](https://user-images.githubusercontent.com/11352152/85187445-c4bb2580-b26d-11ea-80a6-679e494ab062.png)
2020-05-17 22:50:57 +02:00
## Screenshots
2020-05-16 09:55:08 +02:00
<table><tr><td>
2020-05-17 22:50:57 +02:00
<img src=https://user-images.githubusercontent.com/11352152/82159698-2434a880-985e-11ea-95c7-a07694ea9691.png width=500>
2020-05-16 09:55:08 +02:00
</td><td>
2020-05-17 22:50:57 +02:00
<img width=450 src=https://user-images.githubusercontent.com/11352152/82159699-2434a880-985e-11ea-9493-c21773093c38.png>
2020-05-16 09:55:08 +02:00
</td></tr></table>
2020-05-17 22:50:57 +02:00
## Installation
2020-05-20 07:25:24 +02:00
### Arch Linux
2020-05-17 23:39:40 +02:00
```sh
2020-05-20 07:25:24 +02:00
yay -S handlr-bin
2020-05-17 23:39:40 +02:00
```
2020-05-17 22:50:57 +02:00
2020-05-20 07:25:24 +02:00
Optionally you can also install `xdg-utils-handlr` to replace `xdg-open`:
2020-05-17 22:50:57 +02:00
2020-05-20 07:25:24 +02:00
```sh
yay -S xdg-utils-handlr
```
### Rust/Cargo
2020-05-17 22:50:57 +02:00
```sh
cargo install handlr
```
2020-05-20 07:25:24 +02:00
### Binaries
1. Download the latest [release binary](https://github.com/chmln/handlr/releases) and put it somewhere in `$PATH`
2021-07-21 19:00:25 +02:00
2. Download completions for fish:
2020-05-20 07:25:24 +02:00
```sh
curl https://raw.githubusercontent.com/chmln/handlr/master/completions/handlr.fish --create-dirs -o ~/.config/fish/completions/handlr.fish
```
2020-05-17 23:51:10 +02:00
## Attribution
2020-05-16 09:55:08 +02:00
Icons made by <a href="https://www.flaticon.com/authors/eucalyp" title="Eucalyp">Eucalyp</a> from <a href="https://www.flaticon.com/" title="Flaticon"> www.flaticon.com</a>
2020-05-17 23:51:10 +02:00
Cover photo by [creativebloq.com](https://creativebloq.com)