README
¶
pkg/git
Extracts git repository information from the working directory or from transcript files.
Files
| File | Role |
|---|---|
git.go |
Live git commands (DetectGitInfo, GetHeadSHA, GetRepoURL, ToGitHubURL) |
Key API
DetectGitInfo(cwd)— Returns*GitInfowith repo URL, branch, commit SHA, message, author, dirty status, configured remotes, and tracking remote (CF-493). Returnsnil(not error) if not in a git repo.GetHeadSHA(cwd)— Returns the full 40-char HEAD commit SHA. Returns empty string and nil if not in a git repo.GetRepoURL(cwd)— Returnsremote.origin.url.DetectRemotes(cwd)— Returns[]GitRemote(merged fetch + push per remote, ingit remote -vorder) for cwd. Returns(nil, nil)outside a git repo; silent best-effort.DetectTrackingRemote(cwd, branch)— Returnsbranch.<branch>.remotegit config value, or""when unset / on any error.branch == ""short-circuits without invoking git.DetectBranch(cwd)— Returnsgit rev-parse --abbrev-ref HEADfor cwd, or""on error. Detached HEAD returns the literal string"HEAD".ToGitHubURL(gitURL)— Converts git remote URLs (SSH, HTTPS,git@) tohttps://github.com/owner/repo. Returns empty string for non-GitHub URLs.ExtractGitInfoFromTranscript(path)— Parses a JSONL transcript to findgitBranchandcwdfields. Used when the working directory may no longer exist. Best-effort populates remotes + tracking remote from the discovered cwd.
How to Extend
Adding a new git field: Add the field to the GitInfo struct, then add the corresponding git command in DetectGitInfo(). Follow the existing pattern: run gitCommand(), check for errors, assign to struct.
Invariants
- All git command arguments must be hardcoded string literals or values derived from git's own output / local config. Never pass arbitrary user input directly to
gitCommand().exec.Commanddoesn't invoke a shell, so injection isn't possible per se, but unvalidated args can confuse git or surface unexpected files (--execstyle flags). Callers that need to inject a value (e.g.,DetectTrackingRemotesubstituting a branch name) must source it from a trusted local channel. DetectGitInforeturns nil, not error, when not in a git repo. Callers check for nil, not err. Being outside a git repo is normal (not an error condition).DetectRemotes/DetectTrackingRemote/DetectBranchare silent best-effort. Return zero values on any error (including not-a-repo); no logs even at debug level. Callers can plug them into chains without nil-checking each individually.- Two extraction paths exist intentionally. Live git commands (
DetectGitInfo) work when the repo is available. Transcript parsing (ExtractGitInfoFromTranscript) works when replaying sessions where the repo may be gone. Don't merge these — they serve different lifecycle phases. GitRemotewire format mirrors CF-494'sdb.GitRemoteexactly. JSON tags arename/fetch_url/push_urlwith noomitemptyon the URL fields — both URLs are always emitted per the locked CF-493/CF-494 wire-format decision.parseRemoteVOutputdrops any entry with empty name or both URLs empty (CF-494 strict validation 400s the chunk otherwise).
Testing
go test ./pkg/git/...
Tests create temporary git repositories with git init and verify extraction. ExtractGitInfoFromTranscript tests use synthetic JSONL files.
Dependencies
Uses: standard library (os/exec for git commands), pkg/types (JSONL scanner)
Used by: cmd/ (post-tool-use hook for commit linking), pkg/sync/ (metadata extraction)
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DetectBranch ¶ added in v0.16.1
DetectBranch returns the current branch name (`git rev-parse --abbrev-ref HEAD`) for the given cwd, or "" on error. Detached HEAD returns the literal string "HEAD".
func DetectTrackingRemote ¶ added in v0.16.1
DetectTrackingRemote returns the value of branch.<branch>.remote git config for the given cwd, or "" when unset / on any error. Silent. branch == "" short-circuits to "" without invoking git.
func GetHeadSHA ¶
GetHeadSHA returns the full SHA of the HEAD commit. Returns empty string and nil if not in a git repo.
func GetRepoURL ¶
GetRepoURL returns the remote origin URL for a git repository Returns empty string if not a git repo or no remote configured
func ToGitHubURL ¶
ToGitHubURL converts a git remote URL to a GitHub HTTPS URL. Handles: git@github.com:owner/repo.git, https://github.com/owner/repo.git, ssh://git@github.com/owner/repo.git Returns empty string if not a GitHub URL.
Types ¶
type GitInfo ¶
type GitInfo struct {
RepoURL string `json:"repo_url,omitempty"`
Branch string `json:"branch,omitempty"`
CommitSHA string `json:"commit_sha,omitempty"`
CommitMessage string `json:"commit_message,omitempty"`
Author string `json:"author,omitempty"`
IsDirty bool `json:"is_dirty"`
Remotes []GitRemote `json:"remotes,omitempty"`
TrackingRemote string `json:"tracking_remote,omitempty"`
}
GitInfo contains git repository information
func DetectGitInfo ¶
DetectGitInfo detects git information from the given directory Returns nil if not in a git repository (this is not an error)
func ExtractGitInfoFromTranscript ¶
ExtractGitInfoFromTranscript parses a Claude Code transcript file to extract git information This is useful for uploading sessions where the original directory may not exist
type GitRemote ¶ added in v0.16.1
type GitRemote struct {
Name string `json:"name"`
FetchURL string `json:"fetch_url"`
PushURL string `json:"push_url"`
}
GitRemote describes a single git remote (one entry in `git remote -v`, merging the (fetch) and (push) lines). JSON tags mirror CF-494's db.GitRemote exactly — no omitempty on URL fields, since the CLI always emits both per the locked wire-format decision.
func DetectRemotes ¶ added in v0.16.1
DetectRemotes returns the configured git remotes for cwd. Returns (nil, nil) when cwd is not a git repo or when git is unavailable — silent best-effort, matching GetRepoURL's pattern.
Source Files