Skip to main content

Options

string
Branch name, tag, or commit SHA. Defaults to the default branch.
string
Glob patterns for files to include in the archive.
string
Glob patterns for files to exclude from the archive.
number
Maximum blob size in bytes. When provided, files larger than this limit are excluded from the archive.
string
Prefix to add to each entry in the tar archive (e.g., repo/).

Returns

Returns a streaming response containing a tar.gz archive.
  • TypeScript: Standard Fetch Response.
  • Python: Async response object with .aread() for bytes.
  • Go: *http.Response (remember to close Body).