k1LoW / ghfs

:octocat: Go io/fs implementation for GitHub remote repository

ghfs

ghfs implements the io/fs interfaces for GitHub remote repositories.

The implementation wraps go-github client and use Git Database API.

Supported interface

• fs.FS
• fs.ReadFileFS
• fs.ReadDirFS
• fs.SubFS

Usage

package main

import (
	"fmt"
	"io"
	"log"

	"github.com/k1LoW/ghfs"
)

func main() {
	fsys, err := ghfs.New("golang", "time")
	if err != nil {
		log.Fatal(err)
	}
	f, err := fsys.Open("README.md")
	if err != nil {
		log.Fatal(err)
	}
	b, err := io.ReadAll(f)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", b)
}

References

• johejo/ghfs: Package ghfs wraps the github v3 rest api with io/fs.