GitHub to Hugging Face Transfer

A modern web application and CLI tool that simplifies the process of transferring public GitHub repositories to Hugging Face Hub. Built with React, TypeScript, and Tailwind CSS.

Features

• 🔄 One-click repository transfer from GitHub to Hugging Face
• ✅ Comprehensive validation of inputs
• 🔒 Secure API token handling
• 📝 Optional repository description
• 🚀 Real-time progress updates
• ⚡ Fast and efficient file transfer
• 🎨 Modern, responsive UI
• 🖥️ Command-line interface for automation

Web Interface

Prerequisites

• A public GitHub repository
• A Hugging Face account and API token
• Node.js 18 or higher

Getting Started

1. Clone this repository
2. Install dependencies:

   npm install

3. Start the development server:

   npm run dev

Usage

1. Enter your GitHub repository URL
2. Paste your Hugging Face API token
3. Specify the target repository name for Hugging Face
4. (Optional) Add a description for your repository
5. Click "Transfer Repository" and wait for the process to complete

Command Line Interface (CLI)

The CLI tool provides the same functionality as the web interface but can be used from the terminal or integrated into scripts.

Installation

Install the CLI tool globally:

npm install -g gh-to-hf

CLI Usage

Basic usage:

gh-to-hf --github https://github.com/user/repo \
         --token your-hf-token \
         --repo user/new-repo \
         --description "Optional description"

Options:

• -g, --github <url>: GitHub repository URL (required)
• -t, --token <token>: Hugging Face API token (required)
• -r, --repo <name>: Target repository name on Hugging Face (required)
• -d, --description <text>: Repository description (optional)
• -v, --version: Show version number
• -h, --help: Show help information

Example with all options:

gh-to-hf \
  --github https://github.com/username/repo \
  --token hf_xxxxxxxxxxxxx \
  --repo username/new-repo \
  --description "A transferred repository"

Programmatic Usage

The CLI tool can also be used programmatically in your Node.js applications:

import { transferRepository } from 'gh-to-hf';

await transferRepository({
  githubUrl: 'https://github.com/user/repo',
  hfToken: 'your-hf-token',
  repoName: 'user/new-repo',
  description: 'Optional description'
});

Technical Details

The application performs several steps during the transfer process:

1. Validation

   • Verifies GitHub URL format and repository accessibility
   • Validates Hugging Face API token
   • Checks target repository name availability

2. Transfer Process

   • Creates a new repository on Hugging Face Hub
   • Fetches all files from the GitHub repository
   • Uploads files to Hugging Face
   • Updates repository metadata

Limitations

• Only supports repositories on the 'main' branch
• Binary files are not supported
• Large repositories might be affected by API rate limits
• Sequential file transfer might be slow for large repositories

Security

• API tokens are never stored
• All operations are performed client-side
• HTTPS-only API communication
• Input validation and sanitization

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Development

Web Interface

# Start development server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

CLI Tool

# Build CLI
cd cli
npm install
npm run build

# Link for local development
npm link

# Run in development mode
npm run dev

License

This project is licensed under the MIT License - see the LICENSE file for details.