Skip to content

ImitationGameLabs/git-remote-helper

Repository files navigation

Git Remote Helper

A simple library for Git remote helper implementation.

What is a Git remote helper? See Git remote helpers documentation

Components Introduction

This project contains three core crates:

  • git-remote-helper: The core library that encapsulates the main logic of Git remote helpers. It provides a clean and friendly API to help developers implement various custom Git remote helpers. It handles protocol communication with the Git process, command distribution, and state management, allowing developers to focus on the specific implementation of transport protocols.
  • git-remote-proxy: A small utility that can be inserted between Git and git remote helper to track and record their communication via stdio. Primarily used for observing and learning how the Git remote helper protocol works in practice, it serves as a useful tool for development and debugging.
  • git-remote-demo: An example implementation using the git-remote-helper library. It creates a custom Git remote helper that uses another Git repository in the local filesystem as a simulated remote repository, enabling quick validation of the core logic and functionality within the git-remote-helper library.

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

About

A simple library for building git remote helpers.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published