Suggest the `-t` option to ssh ... (#184)

Commit `6fabec0`

Eric Hanchrow · 2026-06-28 10:14:36 -0400 EDT

parent b9e135f

Suggest the `-t` option to ssh ... (#184)

... when running without config.

1 files changed, +13, -0

M README.md

+13, -0

......@@ -294,6 +294,19 @@ Instead, this tool specifically focuses on session persistence and defers window

## ssh workflow

### Try it out quickly
If you'd like to try out `zmx` and `ssh` without fiddling your `ssh` config, make sure to pass the `-t` option to `ssh`.  Here's an example:

```bash
ssh -t dev-box zmx attach default
```

Without `-t`, the remote shell will not know it's talking to a terminal, and the display will likely get messed up.

This option isn't needed if you follow the configuration steps below, because `RequestTTY yes` does the same thing.

### Configure it for regular use

Using `zmx` with `ssh` is a first-class citizen. Instead of using `ssh` to remote into your system with a single terminal and `n` tmux panes, you open `n` terminals and run `ssh` for all of them. This might sound tedious, but there are tools to make this a delightful workflow.

First, create an `ssh` config entry for your remote dev server:

...	...		@@ -294,6 +294,19 @@ Instead, this tool specifically focuses on session persistence and defers window
294	294
295	295		## ssh workflow
296	296
	297	+	### Try it out quickly
	298	+	If you'd like to try out `zmx` and `ssh` without fiddling your `ssh` config, make sure to pass the `-t` option to `ssh`. Here's an example:
	299	+
	300	+	```bash
	301	+	ssh -t dev-box zmx attach default
	302	+	```
	303	+
	304	+	Without `-t`, the remote shell will not know it's talking to a terminal, and the display will likely get messed up.
	305	+
	306	+	This option isn't needed if you follow the configuration steps below, because `RequestTTY yes` does the same thing.
	307	+
	308	+	### Configure it for regular use
	309	+
297	310		Using `zmx` with `ssh` is a first-class citizen. Instead of using `ssh` to remote into your system with a single terminal and `n` tmux panes, you open `n` terminals and run `ssh` for all of them. This might sound tedious, but there are tools to make this a delightful workflow.
298	311
299	312		First, create an `ssh` config entry for your remote dev server:

Commit 6fabec0

Commit `6fabec0`