gitCheckout

async gitCheckout(
  repoUrl: string,
  options?: {
    branch?: string;
    targetDir?: string;
    depth?: number;
  }
): Promise<GitCheckoutResult>

import { getSandbox } from '@cloudflare/sandbox';

const sandbox = getSandbox(env.SANDBOX, 'my-sandbox');

// Clone a public repository
const result = await sandbox.gitCheckout(
  'https://github.com/cloudflare/sandbox-sdk'
);

console.log('Cloned to:', result.targetDir); // /workspace/sandbox-sdk
console.log('Branch:', result.branch); // main

// Clone only the latest commit for faster cloning
const result = await sandbox.gitCheckout(
  'https://github.com/large/repository',
  {
    depth: 1,
    targetDir: '/workspace/my-repo'
  }
);

const result = await sandbox.gitCheckout(
  'https://github.com/user/repo',
  {
    branch: 'develop',
    targetDir: '/workspace/dev'
  }
);

// Use personal access token in URL
const token = env.GITHUB_TOKEN;
const result = await sandbox.gitCheckout(
  `https://${token}@github.com/user/private-repo`
);

// Or set up SSH key beforehand
await sandbox.exec('mkdir -p ~/.ssh');
await sandbox.writeFile('~/.ssh/id_rsa', env.SSH_PRIVATE_KEY);
await sandbox.exec('chmod 600 ~/.ssh/id_rsa');

const result = await sandbox.gitCheckout(
  'git@github.com:user/private-repo.git'
);

try {
  await sandbox.gitCheckout('https://github.com/invalid/repo');
} catch (error) {
  console.error('Clone failed:', error.message);
}