rusmux 0.6.0

Automate tmux sessions configuration
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

# Rusmux - tmux automation

Built primarily to replace 
[tmuxinator](https://github.com/tmuxinator/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](https://github.com/MeirKriheli/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](https://www.rust-lang.org/)
  and the tooling around it.

## Example

```sh
cat ~/.config/rusmux/demo.yml
```

```yaml
project_name: demo  # can also use name
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
      options:  # per window options
        main-pane-width: 60%
      panes:
        - #
        - grunt serve
        - remote-log: # name is meaningless, for multi commands
          - ssh me@example.com
          - cd /var/logs
          - tail -f project.log 
  - mail: python -m smtpd -n -c DebuggingServer localhost:1025

```

## Install

* Arch Linux users can install [rusmux from AUR](https://aur.archlinux.org/packages/rusmux),
  e.g. (using `paru`):

        paru -S rusmux

* Get a compiled binary from the
  [Releases](https://github.com/MeirKriheli/rusmux/releases) page and place it
  in your `$PATH`.

* With `cargo`:

        cargo install rusmux


## Commands

* Run a project

        rusmux [project]

  or 

        rusmux run [project]
        rusmux start [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]
        rusmux kill [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.


> **NOTE** In the commands above, `project`, `existing` and `new` can be:
>
> * A simple name, like `my_project`, `awesome_server`, which will be created with a `yaml` extension in the config directory.
> * A path to a file (determined by an extension and/or path separator), e.g. `~/projects/my_project/session.yaml`.