Skip to content

GitAPI

Since Plugin API: 1.0.0

Read-only Git operations on the captured Host; requires filesystem.read and installed Git. Git CLI commands time out after 15 seconds and reject output larger than 8 MiB; results are never silently truncated. File arguments use repository-relative forward slashes.

Signature

interface GitAPI {
getInfo(path: string): Promise<GitInfo | null>;
getLanguages(path: string): Promise<readonly RepositoryLanguage[]>;
status(path: string): Promise<readonly GitFileStatus[]>;
diff(path: string, options?: GitDiffOptions): Promise<string>;
log(path: string, options?: GitLogOptions): Promise<readonly GitCommit[]>;
listBranches(path: string): Promise<readonly GitBranch[]>;
readBlob(path: string, revision: string, file: string): Promise<string>;
}

Members

Name Type Required Description
getInfo (path: string) => Promise<GitInfo &#124; null> yes Discovers the containing repository, including linked worktrees.
getLanguages (path: string) => Promise<readonly RepositoryLanguage[]> yes -
status (path: string) => Promise<readonly GitFileStatus[]> yes Repository-relative paths, including untracked files.
diff (path: string, options?: GitDiffOptions) => Promise<string> yes Unified patch for tracked files; binary changes are described, not decoded.
log (path: string, options?: GitLogOptions) => Promise<readonly GitCommit[]> yes HEAD history, newest first. Empty for an unborn branch.
listBranches (path: string) => Promise<readonly GitBranch[]> yes Local branches and their configured upstreams.
readBlob (path: string, revision: string, file: string) => Promise<string> yes UTF-8 text at a commit revision; rejects NUL-containing content and unsafe paths.

This article includes AI-assisted content.

Documentation is licensed under CC BY 4.0. Phoundry names and marks remain reserved.