Skip to content

Commit

Permalink
readme for #118
Browse files Browse the repository at this point in the history
  • Loading branch information
laktak committed Jun 20, 2024
1 parent 1fb3fe7 commit a50d382
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ You can **fuzzy find your text** instead of selecting it by hand:

Use it for paths, URLs, options from a man page, git hashes, docker container names, ...


## Requirements

<a href="https://github.com/laktak/tome"><img src="https://github.com/laktak/tome/wiki/assets/clippy_tome.gif" align="right" alt="clippy" width="265" height="349"></a>
Expand All @@ -32,6 +33,7 @@ Supported clipboards:
- WSL
- *bring your own*, see the [Wiki](https://github.com/laktak/extrakto/wiki/) for examples (like termux)


## Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm)

Add the plugin to the list of TPM plugins in `.tmux.conf`:
Expand All @@ -42,6 +44,7 @@ Hit `prefix + I` to fetch the plugin and source it. You can use `prefix + U` to

You should now have all `extrakto` key bindings defined.


## Manual Installation

Clone the repo:
Expand All @@ -59,10 +62,12 @@ Reload the tmux environment:

You should now have all `extrakto` key bindings defined.


## Wiki

Add or look for special tips in our [wiki](https://github.com/laktak/extrakto/wiki).


## Options

You can set any of these options by adding them to your `~/.tmux.conf` file:
Expand All @@ -84,7 +89,7 @@ Where `<option>` and `<value>` correspond to one of the options specified below

| Option | Default | Description |
| :--- | :---: | :--- |
| `@extrakto_key` | `tab` | The key binding to start. If you have any special requirements (like a custom key table) set this to 'none' and define a binding in your `.tmux.conf`. See `extrakto.tmux` for a sample. |
| `@extrakto_key` | `tab` | The key binding to start. If you have any special requirements (like a custom key table) set this to 'none'. See "Custom Tmux Keybindings". |
| `@extrakto_copy_key` | `enter` | Key to copy selection to clipboard. |
| `@extrakto_insert_key` | `tab` | Key to insert selection. |
| `@extrakto_filter_key` | `ctrl-f` | Key to toggle filter mode. |
Expand Down Expand Up @@ -122,6 +127,21 @@ set -g @extrakto_fzf_unset_default_opts "false" # keep our custom FZF_DEFAULT_O
set -g @extrakto_fzf_header "i c f g" # for small screens shorten the fzf header
```

### Custom Tmux Keybindings

Instead of using `@extrakto_key` you can define your own key binding to start extrakto in your `.tmux.conf`:

```
tmux bind-key YOUR-KEY run-shell "~/.tmux/plugins/extrakto/scripts/open.sh \"#{pane_id}\""
```

If you wish you can also define different keys to start with a specific filter:

```
tmux bind-key YOUR-KEY run-shell "~/.tmux/plugins/extrakto/scripts/open.sh \"#{pane_id}\" FILTER-NAME"
```


## Custom Filters

You can define your own filters by creating a file in `~/.config/extrakto/extrakto.conf`:
Expand Down

0 comments on commit a50d382

Please sign in to comment.