https://github.com/brianp/muxed
Another TMUX project manager
https://github.com/brianp/muxed
multiplexer muxed rust screen terminal tmux tmux-configs tmux-configuration tmux-session window window-manager
Last synced: 10 months ago
JSON representation
Another TMUX project manager
- Host: GitHub
- URL: https://github.com/brianp/muxed
- Owner: brianp
- License: mit
- Created: 2014-07-04T05:13:15.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2022-04-16T20:07:13.000Z (about 4 years ago)
- Last Synced: 2025-05-06T10:02:56.282Z (about 1 year ago)
- Topics: multiplexer, muxed, rust, screen, terminal, tmux, tmux-configs, tmux-configuration, tmux-session, window, window-manager
- Language: Rust
- Homepage:
- Size: 629 KB
- Stars: 60
- Watchers: 5
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Muxed - “Another TMUX project manager”
=====
[](https://travis-ci.org/brianp/muxed)
Drop muxed in to your `$PATH` and take it for a spin. Happy to receive feature requests or bug reports!
## Muxed
**Muxed**: Provides the functionality for creating, opening and parsing your project configs to
launch a TMUX session.
**Snapshot**: __Experimental__ : Create a config file based on a running tmux
session.
## Installation
### Download a release:
See the [releases](https://github.com/brianp/muxed/releases) page for muxed packages.
Download and untar the package as desired.
Make sure the bin is somewhere in your `$PATH`. I
generally move the bins in to `/usr/local/bin`.
```shell
$ tar -xvzf muxed-VERSION-SYSTEM.tar.gz
x muxed
$ mv muxed /usr/local/bin
$ muxed --help
$ muxed my_new_project
```
### From Homebrew taps
This will add a [tap](https://github.com/brianp/homebrew-muxed) to install a pre-compiled Muxed bin.
```shell
$ brew tap brianp/homebrew-muxed
$ brew install muxed_bin
```
## For development
### With Docker
Docker commands are long so I use a make file that points all the commands to a
runing docker container.
```shell
$ git clone git@github.com:brianp/muxed.git
$ export MUXED_ENV=nix
$ make build
$ make start
$ make cargo cmd='test --workspace --color=always'
```
### From source:
Have rust stable installed.
Clone this repo. Then run cargo to build the source, and again use cargo to run the app.
```shell
$ git clone git@github.com:brianp/muxed.git
$ cargo build
$ cargo run -- --help
$ cargo test --workspace --color=always
```
## Setup
### 1. Create a new project file.
If this is your first run, muxed will create the `~/.muxed/` directory for you.
```shell
$ muxed new my_project
Looks like this is your first time here. Muxed could't find the configuration directory: `/root/.muxed`
Creating that now 👌
✌ The template file my_project.yml has been written to /root/.muxed
Happy tmuxing!
```
The generated template will look like this (but with some inline docs):
```yaml
root: "~/"
windows:
- editor:
layout: "main-vertical"
panes: ["vi", "ls -alh"]
- processes: "ls /proc"
- logs: "tail -f /var/log/dmesg"
```
This config will create a new tmux session with three windows named *editor*,
*processes* and *logs*. By default your view will be on the first window opened,
on the first pane, which in this case is *vi* in the *editor* window. The first window will have
two panes split vertically, the left will have the editor *vi* running and the
right will have a shell listing of your current working directory.
### 2. Edit your template
Now you can use your favourite editor and make changes to the config as desired.
This makes the assumption you have an `$EDITOR` env var set.
```shell
$ muxed edit my_project
```
### 3. Open TMUX with your muxed config
```shell
$ muxed my_project
```
## Usage Options
```shell
Usage:
muxed (list | ls)
muxed [flags] [options]
muxed edit [options]
muxed load [flags] [options]
muxed new [flags] [options]
muxed snapshot [flags] [options]
muxed (-h | --help)
muxed (-v | --version)
Flags:
-d If you want to create a muxed session without connecting to it
-f Overwrite existing file if one exists
--debug Prints debug information while executing (project opening only)
-h, --help Prints help information
-v, --version Prints version information
Options:
-p The directory your project config files live in. Defaults to ~/.muxed/
-t The name of the running TMUX session to codify
Args:
The name of your project to open
Subcommands:
list List the availiable project configs
edit Edit an existing project file
load Load the specified project, this is the default command
new To create a new project file
snapshot -t Capture a running session and create a config file for it
```
## Inspiration
This project has been inspired by the work done on the [tmuxinator](https://github.com/tmuxinator/tmuxinator) project. Check it out for a `ruby` based tmux session management solution.
## Copyright
Copyright (c) 2014-2020 Brian Pearce. See [LICENSE](https://github.com/brianp/muxed/blob/master/LICENSE) for further details.