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.

Python

def clone(
    url: str,
    path: str,
    branch: str | None = None,
    commit_id: str | None = None,
    username: str | None = None,
    password: str | None = None,
) -> None

Parameter	Type	Default	Description
`url`	`str`	—	Repository URL.
`path`	`str`	—	In-sandbox destination directory.
`branch`	`str`	`None`	Branch to check out.
`commit_id`	`str`	`None`	Specific commit to check out.
`username`	`str`	`None`	Username for private repos.
`password`	`str`	`None`	Password or access token.

Python

sandbox.git.clone("https://github.com/acme/app.git", "/workspace/app", branch="main")

status()

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

Python

def status(path: str) -> Dict[str, Any]

branches()

Lists the branches of a repository.

Python

def branches(path: str) -> Dict[str, Any]

Returns: a dict with a branches list.

create_branch()

Creates a new branch.

Python

def create_branch(path: str, name: str) -> None

delete_branch()

Deletes a branch.

Python

def delete_branch(path: str, name: str) -> None

checkout_branch()

Checks out an existing branch.

Python

def checkout_branch(path: str, branch: str) -> None

add()

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

Python

def add(path: str, files: List[str]) -> None

Python

sandbox.git.add("/workspace/app", ["src/main.py", "README.md"])

commit()

Commits staged changes with the given message and author identity.

Python

def commit(path: str, message: str, author: str, email: str) -> Dict[str, Any]

Parameter	Type	Default	Description
`path`	`str`	—	Repository path.
`message`	`str`	—	Commit message.
`author`	`str`	—	Author name.
`email`	`str`	—	Author email.

Returns: a dict with the commit hash.

Python

result = sandbox.git.commit("/workspace/app", "Fix build", "CI Bot", "ci@example.com")
print(result["hash"])

push()

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

Python

def push(path: str, username: str | None = None, password: str | None = None) -> None

pull()

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

Python

def pull(path: str, username: str | None = None, password: str | None = None) -> None

On this page