SDK Reference

GoGreen provides production-ready SDKs in six languages: Go, TypeScript, Python, Java, Rust, and C# / .NET. All SDKs support local evaluation, real-time streaming, event tracking, multi-region failover, and offline mode. Choose your language below for install commands and full documentation.

All SDKs

Language	Install	Documentation
Go	`go get github.com/MarkDurbin104/GoGreen/sdk/go`	Full reference below
TypeScript / JavaScript	`npm install @gogreenflags/sdk`	TypeScript / JavaScript SDK →
Python	`pip install gogreen-sdk` or `pip install git+https://github.com/MarkDurbin104/GoGreen.git#subdirectory=sdk/python`	Python SDK →
Java	Maven: `com.gogreen:gogreen-sdk:1.0.0` / Gradle: `implementation 'com.gogreen:gogreen-sdk:1.0.0'`	Java SDK →
Rust	Add `gogreen-sdk = "0.1"` to `Cargo.toml` or use git dependency (see Rust SDK →)	Rust SDK →
C# / .NET	`dotnet add package GoGreen.Sdk`	C# SDK →

Go SDK

Installation


go get github.com/MarkDurbin104/GoGreen/sdk/go

Initialization


import (
    gogreen "github.com/MarkDurbin104/GoGreen/sdk/go"
    shared "github.com/MarkDurbin104/GoGreen/lib/shared-data"
)
 
client, err := gogreen.NewClient(gogreen.Config{
    SDKKey:          "YOUR_SDK_KEY",
    EnvID:           "YOUR_ENV_ID",
    APIBaseURL:      "https://app.gogreenflags.com",
    StreamURL:       "https://app.gogreenflags.com",
    EventsURL:       "https://app.gogreenflags.com",
    EnableStreaming:  true,
    PollInterval:    30 * time.Second,
    RequestTimeout:  5 * time.Second,
    FlushInterval:   60 * time.Second,
})
if err != nil {
    log.Fatal(err)
}
defer client.Close()

Configuration Options

Option	Type	Default	Description
`SDKKey`	`string`	required	SDK key from Environment Settings
`EnvID`	`string`	required	Environment ID
`APIBaseURL`	`string`	`localhost:8091`	Evaluation API base URL
`StreamURL`	`string`	`localhost:8094`	Streaming service URL
`EventsURL`	`string`	`localhost:8093`	Events ingestion URL
`EnableStreaming`	`bool`	`false`	Enable real-time SSE updates
`PollInterval`	`Duration`	`30s`	Polling interval (when streaming is disabled)
`RequestTimeout`	`Duration`	`5s`	HTTP request timeout
`FlushInterval`	`Duration`	`60s`	Event flush interval
`Offline`	`bool`	`false`	Offline mode (no network calls)
`BootstrapConfig`	`*EnvironmentConfig`	`nil`	Pre-loaded config (skip initial fetch)
`AllAttributesPrivate`	`bool`	`false`	Redact all user attributes in events
`PrivateAttributes`	`[]string`	`nil`	Specific attributes to redact
`APIBaseURLs`	`[]string`	`nil`	Multi-region failover URLs (overrides APIBaseURL)
`StreamURLs`	`[]string`	`nil`	Multi-region failover stream URLs

Evaluating Flags


user := shared.EvaluationContext{
    Key:    "user-123",
    Custom: map[string]interface{}{
        "plan":    "enterprise",
        "country": "US",
    },
}
 
// Simple evaluation
enabled := client.BoolVariation("feature-x", user, false)
theme := client.StringVariation("ui-theme", user, "light")
limit := client.NumberVariation("rate-limit", user, 100)
config := client.JSONVariation("feature-config", user, map[string]interface{}{})
 
// Detailed evaluation (includes reason, variation index, rule index)
val, detail := client.BoolVariationDetail("feature-x", user, false)
fmt.Printf("Value: %v, Reason: %s\n", val, detail.Reason)
// Reasons: FALLTHROUGH, RULE_MATCH, TARGET_MATCH, PREREQUISITE_FAILED, OFF, ERROR

Tracking Events


// Track custom events for experimentation
client.Track("purchase", user, map[string]any{
    "revenue":  49.99,
    "currency": "USD",
})

Event Listeners


// Listen for flag changes
client.On("config_updated", func(data interface{}) {
    fmt.Println("Flags updated!")
})
 
// Listen for diagnostic events
client.On("diagnostic", func(data interface{}) {
    event := data.(gogreen.DiagnosticEvent)
    fmt.Printf("Status: %s\n", event.ConnectionStatus)
})
 
// Listen for errors
client.On("error", func(data interface{}) {
    fmt.Printf("Error: %v\n", data)
})

Testing


// Create an offline test client with predetermined flag values
client, _ := gogreen.NewTestClient(map[string]interface{}{
    "feature-x":  true,
    "ui-theme":   "dark",
    "rate-limit": 50,
})
 
// Use in tests — no network calls
enabled := client.BoolVariation("feature-x", user, false) // returns true

Multi-Region Failover


client, _ := gogreen.NewClient(gogreen.Config{
    SDKKey: "YOUR_SDK_KEY",
    EnvID:  "YOUR_ENV_ID",
    // Try URLs in order; fall back on connection failure
    APIBaseURLs: []string{
        "https://eval-us.gogreenflags.com",
        "https://eval-eu.gogreenflags.com",
    },
    StreamURLs: []string{
        "https://stream-us.gogreenflags.com",
        "https://stream-eu.gogreenflags.com",
    },
})

TypeScript & JavaScript SDK

Full reference: TypeScript / JavaScript → (install, GoGreenClient, streaming, events, SSR bootstrap).


npm install @gogreenflags/sdk