Interface GitClient

packages/computer/src/git/index.ts:232–317

/** Methods returned by `createGitClient`. */
export interface GitClient {
  /** Shallow-clone a remote into the bound workspace. */
  clone(options: GitCloneOptions): Promise<void>;
  /** Unified diff between a ref (default HEAD) and the working tree. */
  diff(options?: GitDiffOptions): Promise<string>;
  /** Per-file change summary backing `--stat` / `--name-only` / `--name-status`. */
  diffSummary(options?: GitDiffOptions): Promise<DiffSummaryEntry[]>;
  /** Initialise a new repository in the bound workspace. */
  init(options?: GitInitOptions): Promise<void>;
  /** Describe the working-tree / index / HEAD delta. */
  status(options?: GitStatusOptions): Promise<StatusEntry[]>;
  /** Stage paths into the index. */
  add(options: GitAddOptions): Promise<void>;
  /** Unstage paths from the index. */
  rm(options: GitRmOptions): Promise<void>;
  /** Write the current index to a new commit on HEAD. */
  commit(options: GitCommitOptions): Promise<CommitResult>;
  /** Walk commits from `ref` (default HEAD) backwards through history. */
  log(options?: GitLogOptions): Promise<CommitView[]>;
  /** Read a single commit by ref or oid. */
  show(options: GitShowOptions): Promise<CommitView>;
  /** Resolve a ref to its SHA-1 oid. */
  revParse(options: GitRevParseOptions): Promise<string>;
  /** Find the repository root by walking up from `dir`. */
  repoRoot(options?: GitRepoRootOptions): Promise<string>;
  /** Current branch name, or undefined on detached HEAD. */
  currentBranch(options?: GitCurrentBranchOptions): Promise<string | undefined>;
  /** List files in the index (or at a given ref). */
  lsFiles(options?: GitLsFilesOptions): Promise<string[]>;
  /** List one level of a tree (or sub-tree). */
  lsTree(options: GitLsTreeOptions): Promise<TreeEntryView[]>;
  /** Create a branch. */
  branch(options: GitBranchOptions): Promise<void>;
  /** Delete a branch. */
  branchDelete(options: GitBranchDeleteOptions): Promise<void>;
  /** List local branches. */
  branchList(options?: GitBranchListOptions): Promise<string[]>;
  /** Create a lightweight tag. */
  tag(options: GitTagOptions): Promise<void>;
  /** Delete a tag. */
  tagDelete(options: GitTagDeleteOptions): Promise<void>;
  /** List tags. */
  tagList(options?: GitTagListOptions): Promise<string[]>;
  /** Move HEAD to a ref, or update working-tree paths to a ref. */
  checkout(options: GitCheckoutOptions): Promise<void>;
  /** Fetch refs from a remote. */
  fetch(options?: GitFetchOptions): Promise<FetchResult>;
  /** Push local refs to a remote. */
  push(options?: GitPushOptions): Promise<PushResult>;
  /** Fetch and merge in one step. */
  pull(options?: GitPullOptions): Promise<void>;
  /** Merge a ref into the current branch (or `ours`). */
  merge(options: GitMergeOptions): Promise<MergeResult>;
  /** Add a named remote pointing at a URL. */
  remoteAdd(options: GitRemoteAddOptions): Promise<void>;
  /** Remove a named remote. */
  remoteRemove(options: GitRemoteRemoveOptions): Promise<void>;
  /** List configured remotes. */