githubmodels-go

githubmodels-go is a Go client library for interacting with the GitHub Models API, inspired by the OpenAI Go SDK (openai-go).
It allows you to list models, perform chat/inference completions, and supports streaming responses using your GITHUB_TOKEN for authentication.

---

Features

• List available models in the GitHub Models catalog
• Create chat completions (like OpenAI’s ChatCompletion)
• Rate limit tracking (headers parsed automatically)
• Token usage tracking (prompt, completion, total)
• Optional streaming support for real-time responses
• Supports organization-scoped endpoints
• Easy-to-use Go client interface

---

Installation

go get github.com/tigillo/githubmodels-go

Usage

Initialize Client

package main

import (
    "context"
    "fmt"
    "os"
    "time"

    githubmodels "github.com/tigillo/githubmodels-go/client"
    "github.com/tigillo/githubmodels-go/models"
)

func main() {
    token := os.Getenv("GITHUB_TOKEN")
    client := githubmodels.NewClient(token)

    ctx := context.Background()
    
    // Example: list models
    modelsList, err := client.ListModels(ctx)
    if err != nil {
        panic(err)
    }

    for _, m := range modelsList {
        fmt.Println(m.ID, "-", m.Description)
    }
}

Create Chat Completion

resp, err := client.ChatCompletion(ctx, models.ChatRequest{
    Model: "github/code-chat",
    Messages: []models.Message{
        {Role: "user", Content: "Write a Go function to reverse a string"},
    },
})

// Check for rate limit info even on error
if resp != nil && resp.RateLimit.Limit > 0 {
    fmt.Printf("Rate Limit: %d/%d remaining\n", resp.RateLimit.Remaining, resp.RateLimit.Limit)
    fmt.Printf("Resets at: %s\n", time.Unix(resp.RateLimit.Reset, 0))
}

if err != nil {
    panic(err)
}

fmt.Println(resp.Choices[0].Message.Content)

// Check token usage
fmt.Printf("Token Usage: %d prompt + %d completion = %d total\n",
    resp.Usage.PromptTokens, resp.Usage.CompletionTokens, resp.Usage.TotalTokens)

Environment Variables

The library uses the GITHUB_TOKEN environment variable by default for authentication. Ensure your token has the required scopes:

• models:read for catalog access
• models:execute for inference/chat completions

Contributing

Contributions are welcome! Feel free to:

• Open issues for bugs or feature requests
• Submit pull requests for enhancements or fixes
• Add examples or tests