copyrat 0.6.1

A tmux plugin for copy-pasting within tmux panes.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

# Installation

This guide provides multiple ways to install `tmux-copyrat`. Choose the method
that best suits your setup.

## Prerequisites

- [tmux](https://tmux.github.io) 3.0+
- `curl` or `wget` (for automatic binary download)

## Method 1: Tmux Plugin Manager (TPM) - Recommended

If you use [TPM](https://github.com/tmux-plugins/tpm), add this line to your `~/.tmux.conf`:

```tmux
set -g @plugin 'graelo/tmux-copyrat'
```

Then reload your tmux configuration:

1. Ask TPM to install the plugin: press <kbd>prefix</kbd> + <kbd>I</kbd>
2. The plugin will automatically download the appropriate binary for your
   system on first use
3. Later on, ask TPM to update the plugin: press <kbd>prefix</kbd> +
   <kbd>U</kbd>. See section [Updating](#updating) below.

## Method 2: Manual Installation

### Clone the Repository

```bash
# Clone the repository
git clone https://github.com/graelo/tmux-copyrat ~/.tmux/plugins/tmux-copyrat
```

### Add to tmux Configuration

Add this line to your `~/.tmux.conf`:

```tmux
run-shell ~/.tmux/plugins/tmux-copyrat/tmux-copyrat.tmux
```

### Reload Configuration

```bash
tmux source-file ~/.tmux.conf
```

The plugin will automatically download the appropriate binary for your system
on first use.

## Method 3: Custom Key Bindings

For advanced users who prefer to manage their own key bindings, you can:

1. Download the binary using Method 2 (or manually download from [GitHub
   releases](https://github.com/graelo/tmux-copyrat/releases))
2. Skip sourcing the `tmux-copyrat.tmux` file
3. Create custom key bindings in your `~/.tmux.conf`

**Important**: When creating custom bindings, avoid using `run-shell` as tmux
*launches these processes without attaching them to a pty. Refer to the
*[`tmux-copyrat.tmux`](https://raw.githubusercontent.com/graelo/tmux-copyrat/main/tmux-copyrat.tmux)
*file for proper syntax examples.

## Customization

**Important**: If using TPM, never modify the plugin files directly in
`~/.tmux/plugins/tmux-copyrat/`!

When using TPM, any changes you make to plugin files will be lost when you
update the plugin. Instead, customize the plugin by adding options to your
`~/.tmux.conf`:

```tmux
# Example customizations in ~/.tmux.conf
set -g @copyrat-keyswitch "c"           # Use 'c' instead of 't'
set -g @copyrat-window-name "[search]"  # Custom window name
set -g @copyrat-keytable "search"       # Custom keytable name
```

See [CONFIGURATION.md](CONFIGURATION.md) for all available options and examples.

## Updating

The plugin only downloads the binary if it doesn't exist. To get the latest version:

```bash
# Navigate to plugin directory
cd ~/.tmux/plugins/tmux-copyrat

# Force download latest binary
./install-binary.sh --force
```

## Verification

After installation, you should be able to use the default key bindings:

- <kbd>prefix</kbd> + <kbd>t</kbd> + <kbd>h</kbd> - highlight hashes
- <kbd>prefix</kbd> + <kbd>t</kbd> + <kbd>u</kbd> - highlight URLs
- <kbd>prefix</kbd> + <kbd>t</kbd> + <kbd>d</kbd> - highlight dates
- <kbd>prefix</kbd> + <kbd>t</kbd> + <kbd>i</kbd> - highlight IP addresses

See [CONFIGURATION.md](CONFIGURATION.md) for customization options.