getCommitDiff()

Get the diff for a specific commit.

TypeScript

// Get commit diff (shows changes from parent)
const commitDiff = await repo.getCommitDiff({
  sha: "abc123def456...",
});

// Get commit diff compared to a specific base
const customDiff = await repo.getCommitDiff({
  sha: "abc123def456...",
  baseSha: "def789abc123...", // optional base commit to compare against
});

// Process file changes
commitDiff.files.forEach((file) => {
  console.log(`${file.state}: ${file.path}`);
  console.log(`Raw status: ${file.rawState}`);
});

// Filter to specific files
const filteredDiff = await repo.getCommitDiff({
  sha: "abc123def456...",
  paths: ["package.json", "src/main.ts"],
});

Options

Parameter	Type	Description
sha	Required	The commit SHA to get the diff for
baseSha (TypeScript) base_sha (Python)	Optional	Base commit SHA to compare against. If not specified, compares against the commit’s parent(s)
paths	Optional	Array of file paths to filter the diff. When provided, only returns diffs for the specified files and bypasses size/type filtering

Response

Field	Type	Description
stats	Object	Summary with files, additions, deletions, and changes
files	Array	List of changed files with path, state, rawState, and diff content