Skip to main content

rmux allows you to run your local project on multiple remote machines in parallel

Project description

rmux

rmux allows you to run your local project on multiple remote machines in parallel.

The command names comes from remote-tmux as it allows multiplexing commands on multiple remote machines, synchronized.

The original purpose was to allow testing local changes to a project on other platforms, like running tox on another distribution.

Usage

# run df locally
rmux df

# close tmux session
exit

# run df on two remote hosts, syncronized windows
HOSTS="node1 node2" rmux df

# run a script downloaded from the web (installs pip)
rmux -w https://bootstrap.pypa.io/get-pip.py

If you fail to define the HOSTS variable the tool will default to localhost but it will still use its logic of doing a rsync and running commands using tmux and ssh.

How it works

rmux will detect current project by looking for the .git folder it in current directory or its parents. If it fails to find any .git folder, it will skip the rsync part.

The script will not rsync .gitignored files but it will sync untracked files.

The destination folder on remote machines is ~/.cache/.rmux/<projectname> which will also become default directory.

The remote user is based on host names or your ssh configuration.

Installation

pip install rmux

While rmux is currently only a pure bash script, I used pip wheel as a way to distribute it as it cross platform and easy to use. In addition, it allows me to easily upgrade it.

If you prefer you can just download the shell script and add it to your path.

See also

  • tmux - terminal multiplexer
  • tmux-xpanes - auto-window layout for tmux, a current requirement for rmux. Still, it should be possible to avoid using it if you have only one remote host, just make a feature request and I can implement it.
  • direnv - define environment variables specific to current directory. This can be very handy if you want to have different set of HOSTS for each project and avoid mentioning them on the command line.
  • rtox which allows running tox on remote machines this being the original project. With rmux you will no longer need rtox as you can just do rmux tox instead of rtox, the big difference being that the session is not closed automatically and that you can now run on multiple remote hosts instead of just one.

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rmux-0.1.0.tar.gz (379.7 kB view details)

Uploaded Source

Built Distribution

rmux-0.1.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file rmux-0.1.0.tar.gz.

File metadata

  • Download URL: rmux-0.1.0.tar.gz
  • Upload date:
  • Size: 379.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for rmux-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bfb23e6ed63061431e912e733826c46810439314f298fe55cc9f4c7e4070c50b
MD5 9efbaa5489e06f4c808bd7c55e14e0b8
BLAKE2b-256 f08a7a8f6efa6c0cb94cb085f5af0f8a08a7f1cdd56b9a80aaf9879184687d53

See more details on using hashes here.

File details

Details for the file rmux-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: rmux-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for rmux-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4ae22f29f55382e9a5e3101468d72ed2cb34315d97f6ccb9b8e412683b58d3e7
MD5 d9df0de3c64f4557b8e7bce15d02413e
BLAKE2b-256 d12344a6d25f383dcc883a03a0b62029a673c794ea019300d49429f3cc500e6f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page