obsoleszenz / rusmux

Tmux automation in rust

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Rusmux - tmux automation

Built primarily to replace tmuxinator while using it's yaml files.

tmuxinator is written in Ruby, and various packages/gem upgrades broke it occasionally, having me scrambling for a fix.

On top of that, installing it on various servers missing Ruby installation was a chore.

Thus rusmux was born. I've used it as an opportunity to:

  • Work with the existing .yml project files of tmuxinator.
  • Provide a single binary I can copy around.
  • Further my knowledge and understanding of Rust and the tooling around it.

Example

cat ~/.config/rusmux/demo.yml
project_name: demo
project_root: ~/src/demo
on_project_start:
  - sudo systemctl start postgresql
  - sudo systemctl start mysqld
# on_project_stop: 
pre_window:
  - workon demo
  - cd demo
windows:
  - editor: vim
  - shells:
      layout: main-vertical
      panes:
        - #
        - grunt serve
  - mail: python -m smtpd -n -c DebuggingServer localhost:1025

Install

  • Arch Linux users can install rusmux from AUR, e.g. (using paru):

      paru -S rusmux
    
  • Get a compiled binary from the Releases page and place it in your $PATH.

  • With cargo:

      cargo install rusmux
    

Commands

  • Run a project

      rusmux [project]
    

    or

      rusmux run [project]
    
  • List all existing projects

      rusmux list
    
  • Output shell commands for a project

      rusmux debug [project]
    
  • Edit an existing project ($EDITOR should be set)

      rusmux edit [project]
    
  • Stop project's session

      rusmux stop [project]
    
  • Delete an existing project (after confirmation)

      rusmux delete [project]
    
  • Create a new project, and open it in an editor ($EDITOR should be set)

      rusmux new [project]
    

    This creates the project from default template. To create one with just the project name:

      rusmux new [project] --blank
    
  • Copy an existing project to a new one and edit it ($EDITOR should be set)

      rusmux copy [existing] [new]
    
  • Check your environment for potential issues

      rusmux doctor
    

    Checks for tmux in $PATH and $SHELL & $EDITOR are set.

About

Tmux automation in rust

License:MIT License


Languages

Language:Rust 100.0%