rusmux 0.8.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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

# Rusmux - tmux automation

The main purpose of this project is to serve as a substitute for [tmuxinator](https://github.com/tmuxinator/tmuxinator), while still utilizing its yaml files. 

`tmuxinator`, which is written in Ruby, has had instances of breaking due to updates in packages/gems, 
having me scrambling for  a solution. 

Furthermore, the process of installing it on different servers that lack a Ruby installation proved to be tedious.

Hence, [rusmux](https://github.com/MeirKriheli/rusmux) was created. It served as a chance for me to:

* Utilize the existing `.yml` project files from `tmuxinator`.
* Generate a standalone binary that can be easily distributed.
* Enhance my skills and comprehension of [Rust](https://www.rust-lang.org/) and its associated tools.

## 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
      root: ~/src/demo/code  # Optional per window root overriding `project_root`
      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`):

  ```sh
  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`:

  ```sh
  cargo install rusmux
  ```

* With shell script, for the specific version, see the [release page](https://github.com/MeirKriheli/rusmux/releases/latest/), e.g:

  ```sh
  curl --proto '=https' --tlsv1.2 -LsSf https://github.com/MeirKriheli/rusmux/releases/download/v0.x.y/rusmux-installer.sh | sh
  ```



## Commands

* Run a project

  ```sh
  rusmux run [project]
  rusmux start [project]
  ```

* List all existing projects

  ```sh
  rusmux list
  ```
  
* Output shell commands for a project 

  ```sh
  rusmux debug [project]
  ```

* Edit an existing project (`$EDITOR` should be set)

  ```sh
  rusmux edit [project]
  ```

* Stop project's session

  ```sh
  rusmux stop [project]
  rusmux kill [project]
  ```

* Delete an existing project (after confirmation)

  ```sh
  rusmux delete [project]
  ```

* Create a new project, and open it in an editor (`$EDITOR` should be set)

  ```sh
  rusmux new [project]
  ```

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

  ```sh
  rusmux new [project] --blank
  ```

* Copy an existing project to a new one and edit it (`$EDITOR` should be set)

  ```sh
  rusmux copy [existing] [new]
  ```


* Check your environment for potential issues

  ```sh
  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`.