Git

Git performs git operations on repositories inside a sandbox. Obtain it as sandbox.git. Every method takes the repository's in-sandbox path as its first argument. For private repositories, clone/push/pull accept username/password (use a personal access token as the password). See the git guide.

clone()

Clones a repository into the sandbox, optionally at a specific branch or commit, and optionally with credentials for private repos.

clone(
  url: string,
  path: string,
  branch?: string,
  commitId?: string,
  username?: string,
  password?: string,
): Promise<void>

await sandbox.git.clone('https://github.com/acme/app.git', '/workspace/app', 'main')

status()

Returns the working-tree status of a repository: current branch, ahead/behind counts, and per-file staging/worktree state.

status(path: string): Promise<GitStatus>

Returns: GitStatus — { currentBranch, ahead?, behind?, branchPublished?, fileStatus? }.

branches()

Lists the branches of a repository.

branches(path: string): Promise<ListBranchResponse>

Returns: { branches: string[] }.

createBranch()

Creates a new branch.

createBranch(path: string, name: string): Promise<void>

deleteBranch()

Deletes a branch.

deleteBranch(path: string, name: string): Promise<void>

checkoutBranch()

Checks out an existing branch.

checkoutBranch(path: string, branch: string): Promise<void>

add()

Stages files for the next commit. Paths in files are relative to the repository root.

add(path: string, files: string[]): Promise<void>

await sandbox.git.add('/workspace/app', ['src/main.ts', 'README.md'])

commit()

Commits staged changes with the given message and author identity.

commit(path: string, message: string, author: string, email: string): Promise<GitCommitResponse>

Returns: { hash: string }.

const { hash } = await sandbox.git.commit('/workspace/app', 'Fix build', 'CI Bot', 'ci@example.com')

push()

Pushes commits to the remote. Provide username/password for private remotes.

push(path: string, username?: string, password?: string): Promise<void>

pull()

Pulls from the remote. Provide username/password for private remotes.

pull(path: string, username?: string, password?: string): Promise<void>