https://github.com/nyuyuyu/tmux-pet

Tmux plugin for pet snippet manager
https://github.com/nyuyuyu/tmux-pet

tmux tmux-plugins

Last synced: about 2 months ago
JSON representation

Tmux plugin for pet snippet manager

• Host: GitHub
• URL: https://github.com/nyuyuyu/tmux-pet
• Owner: nyuyuyu
• License: mit
• Created: 2019-02-03T08:05:25.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-19T04:16:42.000Z (over 1 year ago)
• Last Synced: 2024-06-02T06:33:26.790Z (4 months ago)
• Topics: tmux, tmux-plugins
• Language: Shell
• Size: 2.93 KB
• Stars: 18
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tmux-pet

This plugin calls [pet](https://github.com/knqyf263/pet) via tmux.

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

Add plugin to the list of TPM plugins in `.tmux.conf`:

    set -g @plugin 'nyuyuyu/tmux-pet'

Hit `prefix + I` to fetch the plugin and source it.

Add `@pet-new-pane-key`, `@pet-vertical-split-pane-key` and/or `@pet-horizontal-split-pane-key` in `.tmux.conf`:

    set -g @pet-new-pane-key 'C-f'

Finally, reload tmux:

    // type this in terminal

    $ tmux source-file ~/.tmux.conf

## Manual Installation

Clone the repo:

    $ git clone https://github.com/nyuyuyu/tmux-pet ~/clone/path

Add this line to the bottom of `.tmux.conf`:

    run-shell ~/clone/path/pet.tmux

Add `@pet-new-pane-key`, `@pet-vertical-split-pane-key` and/or `@pet-horizontal-split-pane-key` in `.tmux.conf`:

    set -g @pet-new-pane-key 'C-f'

Finally, reload tmux:

    // type this in terminal

    $ tmux source-file ~/.tmux.conf

## Plugin options

| Options                          | Description                                                               |

|:---------------------------------|:--------------------------------------------------------------------------|

| `@pet-path`                      | Path to `pet` binary.                                                     |

| `@pet-pane-size`                 | Size of pane to display `pet` command. (e.g. `10`)                        |

| `@pet-pane-percentage`           | Percentage of pane to display `pet` command. (e.g. `50`)                  |

| `@pet-new-pane-key`              | Key binding for opening new full size pane to display `pet` command.      |

| `@pet-vertical-split-pane-key`   | Key binding for opening vertically split pane to display `pet` command.   |

| `@pet-horizontal-split-pane-key` | Key binding for opening horizontally split pane to display `pet` command. |