git

Documentation

Overview

Package git provides Git operation wrappers for cloning and updating repositories.

Index

• func Clone(url, dest string, depth int) error
• func IsIgnored(repoPath, targetPath string) (bool, error)
• func IsRepo(path string) bool
• func IsURL(s string) bool
• func Pull(repoPath string) error
• func ValidateRemote(repoPath string) error
• func ValidateURL(s string) error

Functions

func Clone

func Clone(url, dest string, depth int) error

Clone clones a git repository from url to dest with the specified depth. It validates the URL before execution to prevent injection attacks. Output is streamed to os.Stdout and os.Stderr. Stdin is connected to os.Stdin to support interactive authentication (e.g., SSH passphrase, credentials).

func IsIgnored

func IsIgnored(repoPath, targetPath string) (bool, error)

IsIgnored checks if the given path is ignored by git.

func IsRepo

func IsRepo(path string) bool

func IsURL

func IsURL(s string) bool

IsURL returns true if s looks like a valid git repository URL. This acts as a loose check, but callers should prefer ValidateURL for security.

func Pull

func Pull(repoPath string) error

Pull performs a fast-forward-only pull in the specified repository directory. Output is streamed to os.Stdout and os.Stderr. Stdin is connected to os.Stdin to support interactive authentication (e.g., SSH passphrase, credentials).

func ValidateRemote

func ValidateRemote(repoPath string) error

ValidateRemote checks if repoPath is a valid git repository by verifying the existence of a .git directory.

func ValidateURL

func ValidateURL(s string) error

ValidateURL checks if the provided string is a safe and valid git URL. It allows:

• HTTP/HTTPS: https://github.com/user/repo.git
• SSH: ssh://git@github.com/user/repo.git
• Git: git://github.com/user/repo.git
• SCP-like SSH: git@github.com:user/repo.git

It rejects:

• Strings starting with "-" (argument injection)
• "ext::" protocol (remote code execution risk)
• Unknown schemes