Categorygithub.com/nxdir-s/gomux
repository
1.0.7
Repository: https://github.com/nxdir-s/gomux.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# README

GoMux

GoMux is a command-line tool that helps with setting up tmux for a project

Installation

GoMux can be installed with the following command

$ go install github.com/nxdir-s/gomux/cmd/gomux@latest

Usage

GoMux is intended to be used to setup tmux windows for a project. While in a project directory run the following to automatically setup tmux

$ gomux

Configuration

GoMux can be configured using a toml file named .gomux.toml. Tmux windows can be configured by adding windows sub-tables. A window requires a name and a cmd that will be executed

TOML documentation

Example Config

title = 'Example GoMux Config'

session = 'SessionName'
start_index = 0

[windows]

[windows.editor]
name = 'editor'
cmd = ['vim .']

[windows.docker]
name = 'docker'
cmd = ['docker compose up']

[windows.database]
name = 'database'
cmd = ['psql']

[windows.server]
name = 'server'
cmd = ['go run cmd/server/main.go']