git

Documentation

Index

• type Client
  • func NewClient() *Client
  • func (c *Client) Add(dir string, paths ...string) error
  • func (c *Client) Commit(dir string, message string, paths ...string) error
  • func (c *Client) GetMainWorktreeRoot() (string, error)
  • func (c *Client) GetRepoRoot() (string, error)
  • func (c *Client) GetUserName() string
  • func (c *Client) IsRepo() bool
  • func (c *Client) IsRepoAt(dir string) bool
  • func (c *Client) IsWorktree() bool
  • func (c *Client) StatusPorcelain(dir string, paths ...string) (string, error)

Types

type Client

type Client struct{}

Client provides git operations.

func NewClient

func NewClient() *Client

NewClient creates a new git client.

func (*Client) Add

func (c *Client) Add(dir string, paths ...string) error

Add stages the given paths. dir sets the working directory for the command.

func (*Client) Commit

func (c *Client) Commit(dir string, message string, paths ...string) error

Commit creates a commit with the given message. When paths are provided, only those paths are included in the commit - other staged changes are left untouched. This is equivalent to running `git commit -m <msg> -- <paths>`, which scopes the commit to the specified paths without the --only flag. dir sets the working directory for the command.

func (*Client) GetMainWorktreeRoot

func (c *Client) GetMainWorktreeRoot() (string, error)

GetMainWorktreeRoot returns the root directory of the main worktree. Returns an error if not in a git repo or not in a worktree.

func (*Client) GetRepoRoot

func (c *Client) GetRepoRoot() (string, error)

GetRepoRoot returns the repository root directory. Returns an error if not in a git repository.

func (*Client) GetUserName

func (c *Client) GetUserName() string

GetUserName returns the configured git user.name. Returns empty string if git is unavailable or user.name is not configured.

func (*Client) IsRepo

func (c *Client) IsRepo() bool

IsRepo returns true if the current directory is inside a git repository.

func (*Client) IsRepoAt

func (c *Client) IsRepoAt(dir string) bool

IsRepoAt returns true if the given directory is inside a git repository.

func (*Client) IsWorktree

func (c *Client) IsWorktree() bool

IsWorktree returns true if the current directory is inside a git worktree (not the main worktree). Returns false if not in a git repo.

func (*Client) StatusPorcelain

func (c *Client) StatusPorcelain(dir string, paths ...string) (string, error)

StatusPorcelain returns `git status --porcelain` output for the given paths. Empty output means no changes. dir sets the working directory for the command.