1-setup.md

1. Setup

Install better-tmux CLI:

curl -sSL https://raw.githubusercontent.com/bettervim/better-tmux/main/scripts/install.sh | bash

The CLI contain only two commands / arguments:

💡 Don't worry about this for now, we'll cover the basic usage later.

In the folder where you want to store your configuration (we recommend ~/), run the following command:

git clone https://github.com/bettervim/better-tmux-template.git ~/better-tmux && rm -rf better-tmux/.git

Now, install the dependencies using your favorite package manager:

pnpm install
# or bun install
# or yarn install
# or npm install

To test changes in your configuration, you'll need to run the better-tmux CLI, specifying your configuration file. For example:

better-tmux --file ~/better-tmux/index.tsx

We recommend you to modify your tmux.conf to execute the CLI on every reload and point to the index.tsx of your config folder:

# ~/tmux.conf
run-shell 'better-tmux --file ~/better-tmux/index.tsx'

To update better-tmux CLI, run the following command:

curl -sSL https://raw.githubusercontent.com/bettervim/better-tmux/main/scripts/update.sh | bash

Tip

Additionally, you need to update your better-tmux package inside of your tmux config using npm / yarn (or pnpm / bun / etc).

To uninstall better-tmux CLI, run the following command:

curl -sSL https://raw.githubusercontent.com/bettervim/better-tmux/main/scripts/uninstall.sh | bash