Skip to content

Commit 1e1baca

Browse files
committed
add docs for new features around ~/.ssh/config
1 parent c694630 commit 1e1baca

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,49 @@ A simple SSH shortcut menu for OS X
1111
1. Download [Shuttle](http://fitztrev.github.io/shuttle/)
1212
2. Copy to Applications
1313

14+
## Customization
15+
16+
The default, out-of-the-box configuration should be good enough to get started. However, if you're looking to customize the appearance further, here are a few advanced tips.
17+
18+
### Disabling `~/.ssh/config` hosts
19+
20+
By default, Shuttle will parse your `~/.ssh/config` file for hosts.
21+
22+
##### To disable all ~/.ssh/config entries:
23+
24+
```
25+
"show_ssh_config_hosts": false,
26+
```
27+
28+
#### Disable specific hosts:
29+
30+
```
31+
"ssh_config_ignore_hosts": ["github.com", "git.example.com"],
32+
```
33+
34+
#### Disable hosts that contain a keyword:
35+
36+
```
37+
"ssh_config_ignore_keywords": ["git"],
38+
```
39+
40+
### Nested menus for `~/.ssh/config` hosts
41+
42+
#### Create a menu item at "work" > "servers" > "web01"
43+
44+
```
45+
Host work/servers/web01
46+
47+
```
48+
\- *or* -
49+
50+
```
51+
Host gandalf
52+
# shuttle.name = work/servers/web01 (webserver)
53+
54+
```
55+
56+
1457
## Roadmap
1558

1659
* Cloud hosting integration

0 commit comments

Comments
 (0)