by kevinburke

kevinburke / ssh_config

Go parser for ssh_config files

239 Stars 30 Forks Last release: Not found Other 45 Commits 5 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:


This is a Go parser for

files. Importantly, this parser attempts to preserve comments in a given file, so you can manipulate a
file from a program, if your heart desires.

It's designed to be used with the excellent x/crypto/ssh package, which handles SSH negotiation but isn't very easy to configure.


functions will attempt to read values from
and fall back to
. The first argument is the host name to match on, and the second argument is the key you want to retrieve.
port := ssh_config.Get("myhost", "Port")

You can also load a config file and read values from it.

var config = `
Host *.test
  Compression yes

cfg, err := ssh_config.Decode(strings.NewReader(config)) fmt.Println(cfg.Get("example.test", "Port"))

Some SSH arguments have default values - for example, the default value for

. If you call Get(), and no value for the given Host/keyword pair exists in the config, we'll return a default for the keyword if one exists.

Manipulating SSH config files

Here's how you can manipulate an SSH config file, and then write it back to disk.

f, _ := os.Open(filepath.Join(os.Getenv("HOME"), ".ssh", "config"))
cfg, _ := ssh_config.Decode(f)
for _, host := range cfg.Hosts {
    fmt.Println("patterns:", host.Patterns)
    for _, node := range host.Nodes {
        // Manipulate the nodes as you see fit, or use a type switch to
        // distinguish between Empty, KV, and Include nodes.

// Print the config to stdout: fmt.Println(cfg.String())

Spec compliance

Wherever possible we try to implement the specification as documented in the

manpage. Unimplemented features should be present in the issues list.

Notably, the

directive is currently unsupported.


This is the second comment-preserving configuration parser I've written, after an /etc/hosts parser. Eventually, I will write one for every Linux file format.


Donations free up time to make improvements to the library, and respond to bug reports. You can send donations via Paypal's "Send Money" feature to [email protected] Donations are not tax deductible in the USA.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.