Huggit

Huggit is a high-performance CLI tool designed for developers who want to maintain their code across both Hugging Face and GitHub simultaneously. With one command, sync your progress to both platforms.

For Users

Installation

Install huggit globally using npm:

npm install -g huggit

Quick Start

1. Initialize Huggit in your local git repository:

   huggit init

   This will prompt you for your Hugging Face and GitHub repository URLs and create a .huggit config file.

2. Push your changes:

   huggit push

   This automatically detects your current branch and pushes to both origins.

Color Theme

Huggit features a sleek Orange and Black terminal interface, making it easy to distinguish sync progress and status updates.

For Contributors

We welcome contributions! To set up the project locally for development:

Setup

1. Clone the repository:

   git clone https://github.com/tariqshams/huggit.git
   cd huggit

2. Install dependencies:

   npm install

3. Link for local testing:

   npm link

   Now the huggit command will point to your local development files.

Project Structure

• bin/huggit.js: Executable entry point.
• src/index.js: Main CLI command definitions.
• src/commands/: Implementation of init and push.
• src/utils/theme.js: Visual styling and terminal components.

Development Workflow

• Follow the senior-level code quality standards: modular, clean, and well-commented.
• UI changes should adhere to the Orange (#FFA500) and Black theme.
• Before submitting a PR, ensure your changes work across different branches and repository types.

License

This project is licensed under the Apache-2.0 License. Developed by Tariq Shams.