Skip to content

tmux-compose is yet another tmuxinator alternative

Notifications You must be signed in to change notification settings

anatoo/tmux-compose

Repository files navigation

tmux-compose

NPM Version

tmux-compose is yet another tmuxinator alternative.

  • Start your tmux sessions from the defined config file
  • Built with TypeScript

Install

npm install -g tmux-compose

Usage

Create a config file: tmux-compose.yaml.

# tmux-compose.yaml

# Session name
name: my-session

# Root directory of your project(optional)
root: ./

windows:
  # Window name and commands to run
  editor: vim
  dev: npm run dev

Run the following command to start the session in same directory.

$ tmux-compose start

my-session will be created and attached to the session.

-c option is available to specify the config file.

$ tmux-compose start -c tmux-compose.yaml

License

MIT

Development

Prerequisites:

  • Node.js
  • Bun

Tasks:

  • bun install: Install dependencies
  • bun run test: Run tests
  • bun run build: Build

About

tmux-compose is yet another tmuxinator alternative

Resources

Stars

Watchers

Forks