Baedal

Simple Git repository downloader CLI tool supporting GitHub, GitLab, and Bitbucket.

Requirements

• Node.js >= 18.0.0

Installation

npm install -g baedal
# or
yarn global add baedal

Usage

GitHub

# Download entire repository (defaults to GitHub)
baedal user/repo

# Download to specific directory
baedal user/repo ./output

# Download specific folder or file
baedal user/repo/src/components ./components

# Exclude specific files or patterns
baedal user/repo --exclude "*.test.ts"
baedal user/repo --exclude "*.md" ".gitignore"
baedal user/repo ./output --exclude "test/**" "docs/**"

# File conflict handling
baedal user/repo --force                # Force overwrite without confirmation
baedal user/repo --skip-existing        # Skip existing files, only add new files
baedal user/repo --no-clobber          # Abort if any file would be overwritten

# Explicit GitHub prefix
baedal github:user/repo

# Using GitHub URL
baedal https://github.com/user/repo

GitLab

# Download from GitLab using prefix
baedal gitlab:user/repo

# Download to specific directory
baedal gitlab:user/repo ./output

# Download specific folder or file
baedal gitlab:user/repo/src/components ./components

# Exclude specific files or patterns
baedal gitlab:user/repo --exclude "*.test.ts"
baedal gitlab:user/repo --exclude "*.test.ts" "*.md"

# Using GitLab URL
baedal https://gitlab.com/user/repo

Bitbucket

# Download from Bitbucket using prefix
baedal bitbucket:user/repo

# Download to specific directory
baedal bitbucket:user/repo ./output

# Download specific folder or file
baedal bitbucket:user/repo/src/components ./components

# Exclude specific files or patterns
baedal bitbucket:user/repo --exclude "*.test.ts"
baedal bitbucket:user/repo --exclude "*.test.ts" "*.md"

# Using Bitbucket URL
baedal https://bitbucket.org/user/repo

Private Repository Authentication

Baedal supports downloading from private repositories using authentication tokens.

Using CLI Flag

# GitHub (Personal Access Token)
baedal user/private-repo --token YOUR_GITHUB_TOKEN

# GitLab (Private Token)
baedal gitlab:user/private-repo --token YOUR_GITLAB_TOKEN

# Bitbucket (App Password)
baedal bitbucket:user/private-repo --token YOUR_BITBUCKET_TOKEN

Using Environment Variables

Set one of the following environment variables:

# Generic token (works for all providers)
export BAEDAL_TOKEN=your_token

# Provider-specific tokens
export GITHUB_TOKEN=your_github_token
export GITLAB_TOKEN=your_gitlab_token
export BITBUCKET_TOKEN=your_bitbucket_token

# Then use baedal normally
baedal user/private-repo

Token Generation

• GitHub: Create a Personal Access Token at Settings > Developer settings > Personal access tokens
  • Required scope: repo (for private repositories)
• GitLab: Create a Private Token at User Settings > Access Tokens
  • Required scope: read_repository
• Bitbucket: Create an App Password at Personal settings > App passwords
  • Required permission: Repositories: Read

Features

• Download from GitHub, GitLab, and Bitbucket repositories
• Support for private repositories with authentication tokens
• Support for specific folders/files
• Exclude specific files or patterns using glob patterns
• File conflict handling modes (force, skip-existing, no-clobber)
• Automatic branch detection (main/master)
• Multiple input formats (prefix, URL, or simple user/repo)
• Zero configuration

Library Usage

import { baedal } from "baedal";

// GitHub (default)
await baedal("user/repo");
await baedal("user/repo", "./output");
await baedal("user/repo/src", "./src");

// With exclude option
await baedal("user/repo", "./output", {
  exclude: ["*.test.ts", "*.md", "test/**"],
});

// Exclude without specifying destination (uses current directory)
await baedal("user/repo", {
  exclude: ["*.test.ts", "docs/**"],
});

// File conflict handling
await baedal("user/repo", "./output", {
  force: true, // Force overwrite without confirmation
});
await baedal("user/repo", "./output", {
  skipExisting: true, // Skip existing files, only add new files
});
await baedal("user/repo", "./output", {
  noClobber: true, // Abort if any file would be overwritten
});

// Private repository with token
await baedal("user/private-repo", "./output", {
  token: process.env.GITHUB_TOKEN,
});

// GitLab
await baedal("gitlab:user/repo");
await baedal("gitlab:user/repo", "./output");
await baedal("https://gitlab.com/user/repo/src", "./src");

// GitLab private repository
await baedal("gitlab:user/private-repo", "./output", {
  token: process.env.GITLAB_TOKEN,
});

// Bitbucket
await baedal("bitbucket:user/repo");
await baedal("bitbucket:user/repo", "./output");
await baedal("https://bitbucket.org/user/repo/src", "./src");

// Bitbucket private repository
await baedal("bitbucket:user/private-repo", "./output", {
  token: process.env.BITBUCKET_TOKEN,
});

Contributing

This project started as a small personal project with a development environment highly tailored to the owner. Given the low probability of external contributors, the current setup is unlikely to change.

If you'd like to contribute, please contact kubrickcode@gmail.com and we'll adapt the environment to accommodate contributions.

License

MIT