Skip to content

Managing your git config

Git Documentation

Manage settings within your local git config, changing the behavior of the git client.

Retrieve all settings

Retrieve all git config for the current repository using Config.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
package main

import (
    "fmt"
    "log"

    git "github.com/purpleclay/gitz"
)

func main() {
    client, _ := git.NewClient()

    cfg, err := client.Config()
    if err != nil {
        log.Fatal("failed to retrieve config for current repository")
    }

    fmt.Println(cfg["user.name"])
}

The value for the config setting would be:

purpleclay

Retrieve a batch of settings

A batch of settings can be retrieved using ConfigL (local), ConfigS (system), or ConfigG (global). A partial retrieval is not supported and will fail if any are missing. All values for a setting are retrieved and ordered by the latest.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
package main

import (
    "fmt"
    "log"

    git "github.com/purpleclay/gitz"
)

func main() {
    client, _ := git.NewClient()
    cfg, err := client.ConfigL("user.name", "user.email")
    if err != nil {
        log.Fatal("failed to retrieve local config settings")
    }

    fmt.Println(cfg["user.name"][0])
    fmt.Println(cfg["user.email"][0])
}

The value for each config setting would be:

purpleclay
**********************

Update a batch of settings

You can update multiple settings in a batch using ConfigSetL (local), ConfigSetS (system), or ConfigSetG (global). Pre-validation of config paths improves the chance of a successful update, but a partial batch may occur upon failure.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
package main

import (
    "log"

    git "github.com/purpleclay/gitz"
)

func main() {
    client, _ := git.NewClient()

    err := client.ConfigSetL("custom.setting1", "value",
        "custom.setting2", "value")
    if err != nil {
        log.Fatal("failed to set local config settings")
    }
}