Git Operations

The Daytona SDK provides built-in Git support. This guide covers all available Git operations and best practices. Daytona SDK provides an option to clone, check status, and manage Git repositories in Sandboxes. You can interact with Git repositories using the git module.

Example

// Basic Git workflow
// Create and initialize sandbox
const sandbox = await daytona.create();

// Clone a repository
await sandbox.git.clone(
  'https://github.com/user/repo.git',
  '/workspace/repo'
);

// Make some changes
await sandbox.fs.uploadFile(
  '/workspace/repo/test.txt',
  new File([Buffer.from('Hello, World!')], 'test.txt')
);

// Stage and commit changes
await sandbox.git.add('/workspace/repo', ['test.txt']);
await sandbox.git.commit(
  '/workspace/repo',
  'Add test file',
  'John Doe',
  'john@example.com'
);

// Push changes (with authentication)
await sandbox.git.push(
  '/workspace/repo',
  'user',
  'token'
);

Git

Constructors

new Git()

new Git(
   sandbox: Sandbox,
   toolboxApi: ToolboxApi,
   instance: SandboxInstance): Git

Parameters

Parameter	Type
`sandbox`	`Sandbox`
`toolboxApi`	`ToolboxApi`
`instance`	`SandboxInstance`

Returns

Git

Methods

add()

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

Stages files for commit.

This method stages the specified files for the next commit, similar to running ‘git add’ on the command line.

Parameters

Parameter	Type	Description
`path`	`string`	Absolute path to the Git repository root
`files`	`string[]`	List of file paths or directories to stage, relative to the repository root

Returns

Promise<void>

Examples

// Stage a single file
await git.add('/workspace/repo', ['file.txt']);

// Stage whole repository
await git.add('/workspace/repo', ['.']);

branches()

branches(path: string): Promise<ListBranchResponse>

List branches in the repository.

This method returns information about all branches in the repository.

Parameters

Parameter	Type	Description
`path`	`string`	Absolute path to the Git repository root

Returns

Promise<ListBranchResponse>

List of branches in the repository

Example

const response = await git.branches('/workspace/repo');
console.log(`Branches: ${response.branches}`);

clone()

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

Clones a Git repository.

This method clones a Git repository into the specified path. It supports cloning specific branches or commits, and can authenticate with the remote repository if credentials are provided.

Parameters

Parameter	Type	Description
`url`	`string`	Repository URL to clone from
`path`	`string`	Absolute path where the repository should be cloned
`branch?`	`string`	Specific branch to clone. If not specified, clones the default branch
`commitId?`	`string`	Specific commit to clone. If specified, the repository will be left in a detached HEAD state at this commit
`username?`	`string`	Git username for authentication
`password?`	`string`	Git password or token for authentication

Returns

Promise<void>

Examples

// Clone the default branch
await git.clone(
  'https://github.com/user/repo.git',
  '/workspace/repo'
);

// Clone a specific branch with authentication
await git.clone(
  'https://github.com/user/private-repo.git',
  '/workspace/private',
  branch='develop',
  username='user',
  password='token'
);

// Clone a specific commit
await git.clone(
  'https://github.com/user/repo.git',
  '/workspace/repo-old',
  commitId='abc123'
);

commit()

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

Commits staged changes.

This method creates a new commit with the staged changes. Make sure to stage changes using the add() method before committing.

Parameters

Parameter	Type	Description
`path`	`string`	Absolute path to the Git repository root
`message`	`string`	Commit message describing the changes
`author`	`string`	Name of the commit author
`email`	`string`	Email address of the commit author

Returns

Promise<void>

Example

// Stage and commit changes
await git.add('/workspace/repo', ['README.md']);
await git.commit(
  '/workspace/repo',
  'Update documentation',
  'John Doe',
  'john@example.com'
);

pull()

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

Pulls changes from the remote repository.

This method fetches and merges changes from the remote repository. If the remote requires authentication, username and password/token must be provided.

Parameters

Parameter	Type	Description
`path`	`string`	Absolute path to the Git repository root
`username?`	`string`	Git username for authentication
`password?`	`string`	Git password or token for authentication

Returns

Promise<void>

Examples

// Pull from a public repository
await git.pull('/workspace/repo');

// Pull from a private repository
await git.pull(
  '/workspace/repo',
  'user',
  'token'
);

push()

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

Push local changes to the remote repository.

This method pushes committed changes to the remote repository. If the remote requires authentication, username and password/token must be provided.

Parameters

Parameter	Type	Description
`path`	`string`	Absolute path to the Git repository root
`username?`	`string`	Git username for authentication
`password?`	`string`	Git password or token for authentication

Returns

Promise<void>

Examples

// Push to a public repository
await git.push('/workspace/repo');

// Push to a private repository
await git.push(
  '/workspace/repo',
  'user',
  'token'
);

status()

status(path: string): Promise<GitStatus>

Gets the current status of the Git repository.

This method returns information about the current state of the repository, including staged and unstaged changes, current branch, and untracked files.

Parameters

Parameter	Type	Description
`path`	`string`	Absolute path to the Git repository root

Returns

Promise<GitStatus>

Current repository status including:

currentBranch: Name of the current branch
ahead: Number of commits ahead of the remote branch
behind: Number of commits behind the remote branch
branchPublished: Whether the branch has been published to the remote repository
fileStatus: List of file statuses

Example

const status = await sandbox.git.status('/workspace/repo');
console.log(`Current branch: ${status.currentBranch}`);
console.log(`Commits ahead: ${status.ahead}`);
console.log(`Commits behind: ${status.behind}`);