Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

github

package

Go to main page

Versions in this module

v1

v1.0.4

May 26, 2026

v1.0.3

May 20, 2026

Changes in this version

+ const DefaultTokenReadyDelay

+ var ErrInstallationNotFound = errors.New("installation not found for owner")

v1.0.2

Apr 16, 2026

v1.0.1

Apr 14, 2026

v1.0.0

Mar 31, 2026

Changes in this version

+ const DefaultBaseURL

+ const DefaultTimeout

+ var DefaultRetryConfig = &RetryConfig

+ var ErrFileNotFound = errors.New("file not found")

+ var ErrInvalidRepository = errors.New("invalid repository format (expected owner/repo)")

+ var ErrRepositoryNotFound = errors.New("repository not found or not accessible")

+ var ErrRepositoryRequired = errors.New("repository is required")

+ var New = newClient

+ type APIError struct

+ func (e *APIError) Error() string

+ func (e *APIError) StatusCode() int

+ type Client struct

+ func (c *Client) GetContents(ctx context.Context, repository string, path string) ([]byte, error)

+ func (c *Client) RateLimit(ctx context.Context, token string) (RateLimitInfo, error)

+ func (c *Client) RequestToken(ctx context.Context, req *TokenRequest) (*TokenResponse, error)

+ func (c *Client) RevokeToken(ctx context.Context, token string) error

+ type ClientIface interface

+ GetContents func(ctx context.Context, repository string, path string) ([]byte, error)

+ RateLimit func(ctx context.Context, token string) (RateLimitInfo, error)

+ RequestToken func(ctx context.Context, req *TokenRequest) (*TokenResponse, error)

+ RevokeToken func(ctx context.Context, token string) error

+ type MockClient struct

+ func (m *MockClient) GetContents(ctx context.Context, repository string, path string) ([]byte, error)

+ func (m *MockClient) RateLimit(ctx context.Context, token string) (RateLimitInfo, error)

+ func (m *MockClient) RequestToken(ctx context.Context, req *TokenRequest) (*TokenResponse, error)

+ func (m *MockClient) RevokeToken(ctx context.Context, token string) error

+ type NetworkError struct

+ func (e *NetworkError) Error() string

+ func (e *NetworkError) Unwrap() error

+ type Options struct

+ BaseURL string

+ ClientID string

+ PrivateKey string

+ Timeout time.Duration

+ type RateLimitInfo struct

+ Remaining int

+ ResetAt time.Time

+ type RetryConfig struct

+ InitialBackoff time.Duration

+ JitterFraction float64

+ MaxAttempts int

+ MaxBackoff time.Duration

+ Multiplier float64

+ type TokenRequest struct

+ Permissions map[string]string

+ Repository string

+ type TokenResponse struct

+ ExpiresAt time.Time

+ Token string