Skip to content

Document depth option for shallow git clones #27383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
elithrar merged 1 commit into from
Feb 6, 2026
Merged

Document depth option for shallow git clones #27383

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions src/content/docs/sandbox/api/files.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,9 +189,9 @@ await sandbox.gitCheckout(repoUrl: string, options?: GitCheckoutOptions): Promis
**Parameters**:
- `repoUrl` - Git repository URL
- `options` (optional):
- `branch` - Branch to checkout (default: main branch)
- `targetDir` - Directory to clone into (default: repo name)
- `depth` - Clone depth for shallow clone
- `branch` - Branch to checkout (default: repository default branch)
- `targetDir` - Directory to clone into (default: `/workspace/{repoName}`)
- `depth` - Clone depth for shallow clones (e.g., `1` for latest commit only)

<TypeScriptExample>
```
Expand All @@ -200,7 +200,12 @@ await sandbox.gitCheckout('https://github.com/user/repo');
// Specific branch
await sandbox.gitCheckout('https://github.com/user/repo', {
branch: 'develop',
targetDir: 'my-project'
targetDir: '/workspace/my-project'
});

// Shallow clone (faster for large repositories)
await sandbox.gitCheckout('https://github.com/facebook/react', {
depth: 1
});
```
</TypeScriptExample>
Expand Down
Loading