Skip to content

Commit

Permalink
Adds documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
dsummersl committed Feb 7, 2019
1 parent dc5674a commit 25a0780
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,39 @@ Introduction

A command line application to connect to multiple hosts within a tmux session.

Usage:
Supports connections to SSH hosts, local docker and docker-compose.

**SSH**

By default intmux will open up to six hosts in a new tmux session. For example,
the following command creates a new tmux session with two windows (one ssh'd to
host1, another to user@host2):

intmux ssh host1 user@host2
intmux -i inputfile.txt ssh

Help:
One could use the `--sync` option to enable tmux's 'synchronized-panes' setting:

intmux --sync ssh host1 host2 host3

**Docker**

intmux can also be used to connect to all running docker instances:

intmux docker

Or connect to specific containers:

intmux docker a7e8a0b392ea f947ff94a995

**Docker-compose**

All running services of the docker-compose in your current working directory can
also be connected to:

intmux compose

**Help**

intmux --help

Expand Down

0 comments on commit 25a0780

Please sign in to comment.