[{"_1":2,"_152":-5,"_153":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_131":132},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_124":-5,"_125":11,"_126":17,"_127":11,"_128":-5,"_129":130},"canonicalUrl","https://hub.docker.com/r/moul/advanced-ssh-config/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","moul","reponame","advanced-ssh-config","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":58,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":11,"_68":29,"_69":70,"_75":17,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2014-01-25T11:19:14Z","description","","is_private","last_updated","2018-11-28T16:31:47.845049Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",826,"repository_type","star_count",1,"status","status_description","active","source","collaborator_count",0,"full_description","# assh - *Advanced SSH config*\n[![Travis](https://img.shields.io/travis/moul/advanced-ssh-config.svg)](https://travis-ci.org/moul/advanced-ssh-config)\n[![GoDoc](https://godoc.org/github.com/moul/advanced-ssh-config?status.svg)](https://godoc.org/github.com/moul/advanced-ssh-config)\n![License](https://img.shields.io/github/license/moul/advanced-ssh-config.svg)\n[![GitHub release](https://img.shields.io/github/release/moul/advanced-ssh-config.svg)](https://github.com/moul/advanced-ssh-config/releases)\n[![Go Report Card](https://goreportcard.com/badge/github.com/moul/advanced-ssh-config)](https://goreportcard.com/report/github.com/moul/advanced-ssh-config)\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmoul%2Fadvanced-ssh-config.svg?type=shield)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fmoul%2Fadvanced-ssh-config?ref=badge_shield)\n\n

\n\n#### Table of Contents\n\n1. [Overview](#overview)\n2. [Features](#features)\n * [Configuration features](#configuration-features)\n * [Using Gateway from command line](#using-gateway-from-command-line)\n * [Using Gateway from configuration file](#using-gateways-from-configuration-file)\n * [Under the hood features](#under-the-hood-features)\n * [Hooks](#hooks)\n3. [Configuration](#configuration)\n4. [Usage](#usage)\n * [Usage Examples](#usage-examples)\n5. [Install](#install)\n * [Register the wrapper (optional)](#register-the-wrapper-optional)\n6. [Getting started](#getting-started)\n7. [Webapp](#webapp)\n8. [Changelog](#changelog)\n9. [Alternative version](#alternative-version)\n10. [Troubleshooting](#troubleshooting)\n11. [3rd Party Integration](#3rd-party-integration)\n12. [License](#license)\n\n## Overview\n\nA *transparent wrapper* that adds **regex**, **aliases**, **gateways**, **dynamic hostnames**, **graphviz**, **json output**, **yaml configuration** to **SSH**.\n\n[lib-ssh](https://www.libssh.org) wraps `assh` as a [ProxyCommand](https://en.wikibooks.org/wiki/OpenSSH/Cookbook/Proxies_and_Jump_Hosts#ProxyCommand_with_Netcat); it means that it works seamlessly with:\n\n* [ssh](http://www.openbsd.org/cgi-bin/man.cgi?query=ssh&sektion=1)\n* [scp](http://www.openbsd.org/cgi-bin/man.cgi?query=scp&sektion=1)\n* [rsync](http://linuxcommand.org/man_pages/rsync1.html)\n* [git](https://www.kernel.org/pub/software/scm/git/docs/)\n* Desktop applications depending on `lib-ssh` or `ssh` (i.e., [Tower](http://www.git-tower.com), [Atom.io](https://atom.io), [SSH Tunnel Manager](http://projects.tynsoe.org/fr/stm/))\n\nFor specific examples, see [3rd Party Integration](#3rd-party-integration)\n\n## Features\n\n### Configuration features\n\n* **regex** support\n* **aliases** `gate` -> `gate.domain.tld`\n* **gateways** -> transparent ssh connection chaining\n* **includes**: split configuration in multiple files, note that OpenSSH as of v7.3 has [native support for this](https://www.openssh.com/txt/release-7.3)\n* **local command execution**: finally the reverse of **RemoteCommand**\n* **templates**: equivalent to host but you can't connect directly to a template, perfect for inheritance\n* **inheritance**: make hosts inherits from host hosts or templates\n* **variable expansion**: resolve variables from the environment\n* **smart proxycommand**: RAW tcp connection when possible with `netcat` and `socat` as default fallbacks\n* **rate limit**: configure a per-host or global rate-limiting\n* **JSON output**\n* **[Graphviz](http://www.graphviz.org/)**: graphviz reprensentation of the hosts\n\n### Using Gateway from command line\n\n*assh* can use the [ProxyCommand with netcat](https://en.wikibooks.org/wiki/OpenSSH/Cookbook/Proxies_and_Jump_Hosts#ProxyCommand_with_Netcat) feature of OpenSSH **transparently** and without the pain of using extended configuration.\n\nConnect to `hosta` using `hostb` as a gateway.\n\n```\n ┌─────┐\n │ YOU │─ ─ ─ ─ ─\n └─────┘ │\n ┃ ▽\n ┃ ┌─────┐\n firewall │hostb│\n ┃ └─────┘\n ▼ │\n ┌─────┐\n │hosta│◁─ ─ ─ ─ ┘\n └─────┘\n```\n\n```console\n$ ssh hosta/hostb\nuser@hosta $\n```\n\nEquivalent to `ssh -o ProxyCommand=\"ssh hostb nc %h %p\" hosta`\n\n---\n\nConnect to `hosta` using `hostb` as a gateway using `hostc` as a gateway.\n\n```\n ┌─────┐ ┌─────┐\n │ YOU │─ ─ ─ ─ ─ ─ ─▷│hostc│\n └─────┘ └─────┘\n ┃ │\n ┃\n firewall │\n ┃\n ┃ │\n ▼ ▽\n ┌─────┐ ┌─────┐\n │hosta│◁─ ─ ─ ─ ─ ─ ─│hostb│\n └─────┘ └─────┘\n```\n\n```console\n$ ssh hosta/hostb/hostc\nuser@hosta $\n```\n\nEquivalent to `ssh -o ProxyCommand=\"ssh -o ProxyCommand='ssh hostc nc %h %p' hostb nc %h %p\" hosta`\n\n### Using Gateways from configuration file\n\nYou can define an equivalent of the [\"ProxyCommand with netcat\"](https://en.wikibooks.org/wiki/OpenSSH/Cookbook/Proxies_and_Jump_Hosts#ProxyCommand_with_Netcat) feature of OpenSSH, with a simpler syntax, more advanced workflows, and a unique fallback feature.\n\nLet's consider the following `assh.yml` file\n```yaml\nhosts:\n hosta:\n Hostname: 1.2.3.4\n\n hostb:\n Hostname: 5.6.7.8\n Gateways: hosta\n\n hostc:\n Hostname: 9.10.11.12\n Gateways: hostb\n\n hostd:\n Hostname: 13.14.15.16\n GatewayConnectTimeout: 2\n Gateways:\n - direct\n - hosta\n```\n\n* `ssh hosta` -> `ssh 1.2.3.4`\n* `ssh hostb` -> `ssh -o ProxyCommand=\"ssh hostb nc %h %p\" hosta`\n* `ssh hostc` -> `ssh -o ProxyCommand=\"ssh -o ProxyCommand='ssh hostc nc %h %p' hostb nc %h %p\" hosta`\n* `ssh hostd` ->\n * assh will try to `ssh 13.14.15.16`\n * then, fallback on `ssh -o ProxyCommand=\"ssh hostd nc %h %p\" hosta`\n * this method allows you to have the best performances when it is possible, but ensure your commands will work if you are outside of your company for instance\n\n### Under the hood features\n\n* Automatically regenerates `~/.ssh/config` file when needed\n* Inspect parent process to determine log level (if you use `ssh -vv`, **assh** will automatically run in debug mode)\n* Automatically creates `ControlPath` directories so you can use *slashes* in your `ControlPath` option, can be enabled with the `ControlMasterMkdir: true` configuration in host or globally.\n\n### Hooks\n\n#### Events\n\n##### BeforeConnect\n\n`BeforeConnect` is called just before `assh` tries to connect to the remote SSH port.\n\nNote: `BeforeConnect` will be called for each SSH connection; if you use multiple gateways, it will be called for each gateways until one succeed to connect.\n\n---\n\nExample of Golang template variables:\n\n```golang\n// Host: http://godoc.org/github.com/moul/advanced-ssh-config/pkg/config/#Host\n{{.Host.Name}} // localhost\n{{.Host.HostName}} // 127.0.0.1\n{{.Host.Port}} // 22\n{{.Host.User}} // moul\n{{.Host.Prototype}} // moul@127.0.0.1:22\n{{.Host}} // {\"HostName\":\"localhost\",\"Port\":22\",\"User\":\"moul\",\"ControlPersist\":\"yes\",...}\n{{printf \"%s:%s\" .Host.HostName .Host.Port}} // localhost:22\n```\n\n##### OnConnect\n\n`OnConnect` is called as soon as assh is connected to the remote SSH port.\n\nNote: `OnConnect` is not aware of the authentication process and will always be raised.\n\n---\n\nExample of Golang template variables:\n\n```golang\n// Host: http://godoc.org/github.com/moul/advanced-ssh-config/pkg/config/#Host\n{{.Host.Name}} // localhost\n{{.Host.HostName}} // 127.0.0.1\n{{.Host.Port}} // 22\n{{.Host.User}} // moul\n{{.Host.Prototype}} // moul@127.0.0.1:22\n{{.Host}} // {\"HostName\":\"localhost\",\"Port\":22\",\"User\":\"moul\",\"ControlPersist\":\"yes\",...}\n{{printf \"%s:%s\" .Host.HostName .Host.Port}} // localhost:22\n\n// Stats: http://godoc.org/github.com/moul/advanced-ssh-config/pkg/commands/#ConnectionStats\n{{.Stats.ConnectedAt}} // 2016-07-20 11:19:23.467900594 +0200 CEST\n```\n\n##### OnConnectError\n\n`OnConnectError` is called when `assh` fails to open a new TCP connection.\n\n---\n\nExample of Golang template variables:\n\n```golang\n// Host: http://godoc.org/github.com/moul/advanced-ssh-config/pkg/config/#Host\n{{.Host.Name}} // localhost\n{{.Host.HostName}} // 127.0.0.1\n{{.Host.Port}} // 22\n{{.Host.User}} // moul\n{{.Host.Prototype}} // moul@127.0.0.1:22\n{{.Host}} // {\"HostName\":\"localhost\",\"Port\":22\",\"User\":\"moul\",\"ControlPersist\":\"yes\",...}\n{{printf \"%s:%s\" .Host.HostName .Host.Port}} // localhost:22\n\n// Error\n{{.Error}} // dial tcp: lookup localhost: no such host\n```\n\n##### OnDisconnect\n\n`OnDisconnect` is called as the assh socket is closed.\n\n**warning**: if you don't see a notification when closing an SSH connection, then you probably have `ControlMaster` configured; `OnDisconnect` is not linked to the `ssh` program but to its **socket** which may stay alive even after exiting the `ssh` program.\n\n---\n\nExample of Golang template variables:\n\n```golang\n// Host: http://godoc.org/github.com/moul/advanced-ssh-config/pkg/config/#Host\n{{.Host.Name}} // localhost\n{{.Host.HostName}} // 127.0.0.1\n{{.Host.Port}} // 22\n{{.Host.User}} // moul\n{{.Host.Prototype}} // moul@127.0.0.1:22\n{{.Host}} // {\"HostName\":\"localhost\",\"Port\":22\",\"User\":\"moul\",\"ControlPersist\":\"yes\",...}\n{{printf \"%s:%s\" .Host.HostName .Host.Port}} // localhost:22\n\n// Stats: http://godoc.org/github.com/moul/advanced-ssh-config/pkg/commands/#ConnectionStats\n{{.Stats.ConnectedAt}} // 2016-07-20 11:19:23.467900594 +0200 CEST\n{{.Stats.WrittenBytes}} // 3613\n{{.Stats.WrittenBytesHuman}} // 3.6kb\n{{.Stats.DisconnectAt}} // 2016-07-20 11:19:29,520515792 +0200 CEST\n{{.Stats.ConnectionDuration}} // 6.052615198s\n{{.Stats.ConnectionDurationHuman}} // 6s\n{{.Stats.AverageSpeed}} // 596.933bps\n{{.Stats.AverageSpeedHuman}} // 3.4kb/s\n```\n\n##### BeforeConfigWrite\n\n`BeforeConfigWrite` is called just before `assh` rewrite the `~/.ssh/config` file.\n\n---\n\nExample of Golang template variables:\n\n```golang\n{{.SSHConfigPath}} // ~/.ssh/config\n```\n\n#### Hooks drivers\n\n##### Exec driver\n\nExec driver uses [Golang's template system](https://golang.org/pkg/text/template/) to execute a shell command\n\nUsage: `exec [args...]`\n\n```yaml\ndefaults:\n Hooks:\n OnConnect: exec echo '{{.Host}}' | jq .\n# executes: `echo '{\"HostName\":\"localhost\",\"Port\":\"22\",\"User\":\"moul\",\"ControlPersist\":\"yes\",...}' | jq .\n# which results in printing a pretty JSON of the host\n# {\n# \"HostName\": \"localhost\",\n# \"Port\": \"22\",\n# \"User\": \"moul\",\n# \"ControlPersist\": \"yes\",\n# ...\n# }\n```\n\n```yaml\ndefaults:\n Hooks:\n OnConnect: exec echo 'New SSH connection to {{.Host.Prototype}}.' | mail -s \"SSH connection journal\" m+assh@42.am\n# send an email with the connection prototype\n```\n\n```yaml\ndefaults:\n Hooks:\n BeforeConfigWrite: exec cp {{.SSHConfigPath}} {{.SSHConfigPath}}.backup\n# make a copy of ~/.ssh/config before being rewritten\n```\n\n```yaml\ndefaults:\n Hooks:\n AfterConfigWrite: 'exec echo \"# date: `date`\" >> {{.SSHConfigPath}}'\n# Append a comment with the compilation date to the generated ~/.ssh/config file\n```\n\n```yaml\ndefaults:\n Hooks:\n AfterConfigWrite: 'exec cat /path/to/my/provider/generated/.ssh/config >> {{.SSHConfigPath}}'\n# Append another .ssh/config file to the generated .ssh/config file\n```\n\n---\n\nThe `exec` commands are blocking, a new driver for background tasks is planned. For now, you can run a job in background like this:\n\n```yaml\ndefaults:\n Hooks:\n OnConnect:\n - exec sleep 60 &\n# execute the `sleep 60` command in background (non-blocking)\n# if you quit your ssh connection, the process will continue in background.\n```\n\n##### Write driver\n\nWrite driver uses [Golang's template system](https://golang.org/pkg/text/template/) to write out data to stdout\n\nUsage: `write `\n\n```yaml\ndefaults:\n Hooks:\n OnConnect:\n - write New SSH connection to {{.Host.Prototype}}.\n# writes: \"New SSH connection to moul@127.0.0.1:22.\" on the terminal on connection\n```\n\n```yaml\ndefaults:\n Hooks:\n OnDisconnect:\n - \"write SSH connection to {{.Host.Name}} closed, {{ .Stats.WrittenBytes }} bytes written in {{ .Stats.ConnectionDuration }} ({{ .Stats.AverageSpeed }})\"\n# writes: SSH connection to localhost closed, 40 bytes written.\n```\n\n##### Notify driver\n\nNotify driver uses [Golang's template system](https://golang.org/pkg/text/template/) to open Desktop notifications.\n\n**Mac OS X**: Built-in support\n**Linux**: Depends on [gnotifier](https://github.com/haklop/gnotifier)\n**Windows**: Not supported\n**BSD**: Not supported\n\nUsage: `notify `\n\n```yaml\ndefaults:\n Hooks:\n OnConnect: notify New SSH connection to {{.Host.Prototype}}.\n```\n\n![](https://github.com/moul/advanced-ssh-config/raw/master/resources/new_connection_notification.png)\n\n```yaml\ndefaults:\n Hooks:\n OnDisconnect:\n - \"notify SSH connection to {{.Host.Name}} closed, {{ .Stats.WrittenBytes }} bytes written in {{ .Stats.ConnectionDuration }} ({{ .Stats.AverageSpeed }})\"\n```\n\n![](https://github.com/moul/advanced-ssh-config/raw/master/resources/closed_connection_notification.png)\n\n## Configuration\n\n`assh` now manages the `~/.ssh/config` file, take care to keep a backup your `~/.ssh/config` file.\n\n`~/.ssh/assh.yml` is a [YAML](http://www.yaml.org/spec/1.2/spec.html) file containing:\n\n* a `hosts` dictionary containing multiple *HOST* definitions\n* a `defaults` section containing global flags\n* and an `includes` section containing path to other configuration files\n\n```yaml\nhosts:\n\n homer:\n # ssh homer -> ssh 1.2.3.4 -p 2222 -u robert\n Hostname: 1.2.3.4\n User: robert\n Port: 2222\n\n bart:\n # ssh bart -> ssh 5.6.7.8 -u bart <- direct access\n # or ssh 5.6.7.8/homer -u bart <- using homer as a gateway\n Hostname: 5.6.7.8\n User: bart\n Gateways:\n - direct # tries a direct access first\n - homer # fallback on homer gateway\n\n maggie:\n # ssh maggie -> ssh 5.6.7.8 -u maggie <- direct access\n # or ssh 5.6.7.8/homer -u maggie <- using homer as a gateway\n User: maggie\n Inherits: bart # inherits rules from \"bart\"\n\n bart-access:\n # ssh bart-access -> ssh home.simpson.springfield.us -u bart\n Inherits:\n - bart-template\n - simpson-template\n\n lisa-access:\n # ssh lisa-access -> ssh home.simpson.springfield.us -u lisa\n Inherits:\n - lisa-template\n - simpson-template\n\n marvin:\n # ssh marvin -> ssh marvin -p 23\n # ssh sad-robot -> ssh sad-robot -p 23\n # ssh bighead -> ssh bighead -p 23\n # aliases inherit everything from marvin, except hostname\n Port: 23\n Aliases:\n - sad-robot\n - bighead\n\n dolphin:\n # ssh dolphin -> ssh dolphin -p 24\n # ssh ecco -> ssh dolphin -p 24\n # same as above, but with fixed hostname\n Port: 24\n Hostname: dolphin\n Aliases: ecco\n RateLimit: 10M # 10Mbytes/second rate limiting\n\n schooltemplate:\n User: student\n IdentityFile: ~/.ssh/school-rsa\n ForwardX11: yes\n\n schoolgw:\n # ssh school -> ssh gw.school.com -l student -o ForwardX11=no -i ~/.ssh/school-rsa\n Hostname: gw.school.com\n ForwardX11: no\n Inherits: schooltemplate\n\n \"expanded-host[0-7]*\":\n # ssh somehost2042 -> ssh somehost2042.some.zone\n Hostname: \"%h.some.zone\"\n\n vm-*.school.com:\n # ssh vm-42.school.com -> ssh vm-42.school.com/gw.school.com -l student -o ForwardX11=yes -i ~/.ssh/school-rsa\n Gateways: schoolgw\n Inherits: schooltemplate\n # do not automatically create `ControlPath` -> may result in error\n ControlMasterMkdir: true\n\n \"*.shortcut1\":\n ResolveCommand: /bin/sh -c \"echo %h | sed s/.shortcut1/.my-long-domain-name.com/\"\n\n \"*.shortcut2\":\n ResolveCommand: /bin/sh -c \"echo $(echo %h | sed s/.shortcut2//).my-other-long-domain-name.com\"\n\n \"*.scw\":\n # ssh toto.scw -> 1. dynamically resolves the IP address\n # 2. ssh {resolved ip address} -u root -p 22 -o UserKnownHostsFile=null -o StrictHostKeyChecking=no\n # requires github.com/scaleway/scaleway-cli\n ResolveCommand: /bin/sh -c \"scw inspect -f {{.PublicAddress.IP}} server:$(echo %h | sed s/.scw//)\"\n User: root\n Port: 22\n UserKnownHostsFile: /dev/null\n StrictHostKeyChecking: no\n\n my-env-host:\n User: user-$USER\n Hostname: ${HOSTNAME}${HOSTNAME_SUFFIX}\n\ntemplates:\n # Templates are similar to Hosts; you can inherit from them\n # but you cannot ssh to a template\n bart-template:\n User: bart\n lisa-template:\n User: lisa\n simpson-template:\n Host: home.simpson.springfield.us\n\ndefaults:\n # Defaults are applied to each hosts\n ControlMaster: auto\n ControlPath: ~/tmp/.ssh/cm/%h-%p-%r.sock\n ControlPersist: yes\n Port: 22\n User: bob\n Hooks:\n # Automatically backup ~/.ssh/config\n BeforeConfigWrite:\n - 'exec set -x; cp {{.SSHConfigPath}} {{.SSHConfigPath}}.bkp'\n\n AfterConfigWrite:\n # Concat another `ssh_config` file with the one just generated by `assh`\n - 'exec cat ~/.ssh/my-heroku-generated-config >> {{.SSHConfigPath}}'\n\n # Alert me with a Desktop notification\n - notify \"{{.SSHConfigPath}} has been rewritten\"\n\n OnConnect:\n # Log internal information to a file\n - exec printf '{{.}}' | jq . >> ~/.ssh/last_connected_host.txt\n\n # Alert me with a Desktop notification\n - notify New SSH connection to {{.Host.Prototype}} at {{.Stats.ConnectedAt}}\n\n # Write the host prototype to the terminal stderr\n - write New SSH connection to {{.Host.Prototype}}\n\n OnDisconnect:\n # write on terminal and in a Desktop notification some statistics about the finished connection\n - \"write SSH connection to {{.Host.HostName}} closed, {{.Stats.WrittenBytes }} bytes written in {{.Stats.ConnectionDuration}} ({{.Stats.AverageSpeed}}bps)\"\n - \"notify SSH connection to {{.Host.HostName}} closed, {{.Stats.WrittenBytes }} bytes written in {{.Stats.ConnectionDuration}} ({{.Stats.AverageSpeed}}bps)\"\n\nincludes:\n- ~/.ssh/assh.d/*.yml\n- /etc/assh.yml\n- $ENV_VAR/blah-blah-*/*.yml\n\nASSHBinaryPath: ~/bin/assh # optionally set the path of assh\n```\n\nFor further inspiration, these [`assh.yml` files on public GitHub projects](https://github.com/search?utf8=%E2%9C%93&q=in%3Apath+assh.yml+extension%3Ayml&type=Code) can educate you on how people are using assh\n\n\n## Usage\n\n`assh` usage\n\n```\nNAME:\n assh - advanced ssh config\n\nUSAGE:\n assh [global options] command [command options] [arguments...]\n\nVERSION:\n2.8.0 (HEAD)\n\nAUTHOR(S):\n Manfred Touron \n\nCOMMANDS:\n ping Send packets to the SSH server and display statistics\n info Display system-wide information\n config Manage ssh and assh configuration\n sockets Manage control sockets\n help, h Shows a list of commands or help for one command\n\nGLOBAL OPTIONS:\n --config value, -c value Location of config file (default: \"~/.ssh/assh.yml\") [$ASSH_CONFIG]\n --debug, -D Enable debug mode [$ASSH_DEBUG]\n --verbose, -V Enable verbose mode\n --help, -h show help\n --version, -v print the version\n```\n\n### Usage examples\n\n##### `assh config build`\n\nRewrites and replaces the existing ~/.ssh/config file.\n\nThis action is automatically done by assh when detecting configuration changes.\nRunning this command is useful to set up assh or repair the configuration file.\n\n```console\n$ assh config build > ~/.ssh/config\n```\n\n##### `assh config list`\n\nList hosts and options.\n\n```console\n$ assh config list\nListing entries\n\n *.scw -> root@[hostname_not_specified]:22\n StrictHostKeyChecking=no [custom options]\n UserKnownHostsFile=/dev/null [custom options]\n\n *.shortcut1 -> bob@[hostname_not_specified]:22\n\n *.shortcut2 -> bob@[hostname_not_specified]:22\n\n bart -> bart@5.6.7.8:22\n\n bart-access -> bob@[hostname_not_specified]:22\n\n dolphin -> bob@dolphin:24\n\n expanded-host[0-7]* -> bob@%h.some.zone:22\n\n homer -> robert@1.2.3.4:2222\n\n lisa-access -> bob@[hostname_not_specified]:22\n\n maggie -> maggie@[hostname_not_specified]:22\n\n marvin -> bob@[hostname_not_specified]:23\n\n my-env-host -> user-moul@[hostname_not_specified]:22\n\n schoolgw -> bob@gw.school.com:22\n ForwardX11=no [custom options]\n\n schooltemplate -> student@[hostname_not_specified]:22\n ForwardX11=yes [custom options]\n IdentityFile=~/.ssh/school-rsa [custom options]\n\n vm-*.school.com -> bob@[hostname_not_specified]:22\n\n (*) General options:\n ControlMaster: auto\n ControlPath: ~/tmp/.ssh/cm/%h-%p-%r.sock\n ControlPersist: yes\n Port: 22\n User: bob\n```\n\n##### `assh config graphviz`\n\nGenerate a [graphviz](http://www.graphviz.org/) graph of the hosts\n\n```console\n$ assh config graphviz | dot -Tpng > assh-hosts.png\n```\n\n![](https://github.com/moul/advanced-ssh-config/raw/master/resources/graphviz.png)\n\n##### `assh config search `\n\nSearch for `` in hosts and host options.\n\n```console\n$ assh config search bart\nListing results for bart:\n bart -> bart@5.6.7.8:22\n bart-access -> moul@[hostname_not_specified]:22\n```\n\n##### `assh info`\n\nDisplay system-wide information.\n\n```console\n$ assh info\nDebug mode (client): false\nCLI Path: /path/to/assh\nGo version: go1.6.2\nOS/Arch: darwin/amd64\n\nRC files:\n- ~/.ssh/assh.yml\n- ~/.ssh/assh.d/hosts.yml\n- ~/.ssh/assh.d/moul.yml\n- ~/.ssh/assh.d/test.yml\n\nStatistics:\n- 299 hosts\n- 2 templates\n- 4 included files\n```\n\n##### `assh sockets list`\n\nList active control sockets.\n\n```console\n$ assh sockets list\n4 active control sockets in \"~/.ssh/cm/\":\n\n- bart/homer/lisa-22-root.sock (14 minutes)\n- bart/homer-22-root.sock (14 minutes)\n- bart-22-root.sock (14 minutes)\n- marge-22-bart.sock (1 hour)\n```\n\n##### `assh sockets flush`\n\nClose active control sockets.\n\n```console\n$ assh sockets flush\nClosed 4 control sockets.\n```\n\n##### `assh sockets master`\n\nCreate a master control sockets.\n\n```console\n$ assh sockets master\n```\n\n#### `assh ping`\n\nSend packets to the SSH server and display stats.\n\n```console\n$ assh ping -c 4 localhost\nPING localhost (127.0.0.1) PORT 22 (ssh) PROTO tcp\nConnected to 127.0.0.1: seq=0 time=321µs protocol=tcp port=22\nConnected to 127.0.0.1: seq=1 time=501µs protocol=tcp port=22\nConnected to 127.0.0.1: seq=2 time=550µs protocol=tcp port=22\nConnected to 127.0.0.1: seq=3 time=641µs protocol=tcp port=22\n\n--- localhost assh ping statistics ---\n4 packets transmitted, 4 packets received, 0.00% packet loss\nround-trip min/avg/max = 321µs/503.25µs/641µs\n```\n\n## Install\n\nGet the latest version using GO (recommended way):\n\n```bash\ngo get -u github.com/moul/advanced-ssh-config/cmd/assh\n```\n\n**note**: tested with Go1.7 or above\n\n---\n\nGet the latest released version using homebrew (Mac OS X):\n\n```bash\nbrew install assh\n```\n\nBuild the latest version\n\n```bash\nbrew install assh --HEAD\n```\n\n---\n\nGet a released version on: https://github.com/moul/advanced-ssh-config/releases\n\n---\n\n#### Register the wrapper (optional)\n\nTo improve experience when using advanced pattern matching, add the following at the end of your .bashrc or .zshrc:\n\n```bash\nalias ssh=\"assh wrapper ssh\"\n```\n\nThis step is not *mandatory* but highly *recommended*.\n\n---\n\n**Note**: `ssh` does not understand advanced patterns;\nTo bypass this limitation, `assh` maintains a list of *known hosts* and regenerate the `~/.ssh/config` with all those expanded *known hosts*.\n\nWithout the wrapper, the `~/.ssh/config` risks to be outdated when connecting to a new host for the first time and you will need to launch the command again.\n\nWith the wrapper, `ssh` will *always* be called with an updated `~/.ssh/config` file.\n\n## Getting started\n\n1. Backup your old `~/.ssh/config`: `cp ~/.ssh/config ~/.ssh/config.backup`\n2. Create a new `~/.ssh/assh.yml` file\n3. Run `assh config build > ~/.ssh/config` to validate the syntax of your `~/.ssh/assh.yml` file and automatically build your `~/.ssh/config` file\n4. You are ready!\n\n## Webapp\n\n`assh` contains an experimental web ap","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",3841278245,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_97":98,"_46":113,"_114":90,"_115":29,"_116":52,"_53":117,"_118":119,"_120":104,"_121":113,"_122":61,"_123":17},"content_type","creator",6185,"digest","sha256:67590cfe1022c0ac3c0bcfd550b6934bbfd9e75de6c27d017f0c3105bb27e044","full_size",289924292,"id",9211,"images",[99],{"_100":101,"_91":92,"_102":44,"_103":104,"_105":106,"_107":108,"_109":44,"_110":-5,"_111":94,"_59":61,"_112":-5},"architecture","amd64","features","last_pulled","2026-09-18T15:56:35.377971641Z","last_pushed","2018-11-28T16:31:48Z","os","linux","os_features","os_version","size","variant","2018-11-28T16:31:47.449549Z","last_updater","last_updater_username","media_type","latest","repository",7797,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":133,"_140":141,"_129":150,"_151":11},{"_36":134,"_38":135,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":136,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":58,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":11,"_68":29,"_69":137,"_75":17,"_76":139,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":138},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_142":58,"_143":-5,"_144":-5,"_145":146},"count","next","previous","results",[147],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_97":148,"_46":113,"_114":90,"_115":29,"_116":52,"_53":117,"_118":119,"_120":104,"_121":113,"_122":61,"_123":17},[149],{"_100":101,"_91":92,"_102":44,"_103":104,"_105":106,"_107":108,"_109":44,"_110":-5,"_111":94,"_59":61,"_112":-5},[],"canDeleteTags","actionData","errors"]

moul/advanced-ssh-config

Tags for moul/advanced-ssh-config