Loading documentation...
Loading documentation...
Loading documentation...
This guide will help you install and set up Helix in your Go project.
Before installing Helix, ensure you have:
go mod init if needed)Use go get to install Helix:
go get github.com/kolosys/helixThis will download the package and add it to your go.mod file.
Import the package in your Go source files:
import "github.com/kolosys/helix"Helix includes several packages. Import the ones you need:
The main helix package provides the HTTP web framework:
// Package helix provides a zero-dependency, context-aware, high-performance
// HTTP web framework for Go with stdlib compatibility.
import "github.com/kolosys/helix"The logs package provides structured logging:
// Package logs provides a high-performance, context-aware structured logging library.
//
// Features:
// - Zero-allocation hot paths using sync.Pool
// - Context-aware logging with context.Context
// - Type-safe field builders
// - Multiple output formats (text, JSON, pretty)
// - Sampling for high-volume logs
// - Async logging option
// - Hook system for extensibility
// - Built-in caller information
// - Chained/fluent API
//
// Basic usage:
//
// log := logs.New()
// log.Info("server started", logs.Int("port", 8080))
//
// With context:
//
// log.InfoContext(ctx, "request processed", logs.Duration("latency", time.Since(start)))
import "github.com/kolosys/helix/logs"The middleware package provides HTTP middleware:
// Package middleware provides HTTP middleware for the Helix framework.
import "github.com/kolosys/helix/middleware"Create a simple test file to verify the installation:
package main
import (
"fmt"
"github.com/kolosys/helix"
)
func main() {
fmt.Println("Helix installed successfully!")
fmt.Printf("Helix version: %s
", helix.Version)
}Run the test:
go run main.goTo update to the latest version:
go get -u github.com/kolosys/helixTo update to a specific version:
go get github.com/kolosys/helix@v1.2.3To install a specific version of the package:
go get github.com/kolosys/helix@v1.0.0Check available versions on the GitHub releases page.
If you want to contribute or modify the library:
git clone https://github.com/kolosys/helix.git
cd helixgo mod downloadgo test ./...Run tests with race detection:
go test -race ./...If you encounter a "module not found" error:
go mod init if needed)go clean -modcache and reinstall:
go clean -modcache
go get github.com/kolosys/helixFor private repositories, configure Git to use SSH or a personal access token:
git config --global url."git@github.com:".insteadOf "https://github.com/"Or set up GOPRIVATE:
export GOPRIVATE=github.com/kolosys/helixIf you encounter compatibility issues:
go versionThis guide will help you install and set up Helix in your Go project.
Before installing Helix, ensure you have:
go mod init if needed)Use go get to install Helix:
go get github.com/kolosys/helixThis will download the package and add it to your go.mod file.
Import the package in your Go source files:
import "github.com/kolosys/helix"Helix includes several packages. Import the ones you need:
The main helix package provides the HTTP web framework:
// Package helix provides a zero-dependency, context-aware, high-performance
// HTTP web framework for Go with stdlib compatibility.
import "github.com/kolosys/helix"The logs package provides structured logging:
// Package logs provides a high-performance, context-aware structured logging library.
//
// Features:
// - Zero-allocation hot paths using sync.Pool
// - Context-aware logging with context.Context
// - Type-safe field builders
// - Multiple output formats (text, JSON, pretty)
// - Sampling for high-volume logs
// - Async logging option
// - Hook system for extensibility
// - Built-in caller information
// - Chained/fluent API
//
// Basic usage:
//
// log := logs.New()
// log.Info("server started", logs.Int("port", 8080))
//
// With context:
//
// log.InfoContext(ctx, "request processed", logs.Duration("latency", time.Since(start)))
import "github.com/kolosys/helix/logs"The middleware package provides HTTP middleware:
// Package middleware provides HTTP middleware for the Helix framework.
import "github.com/kolosys/helix/middleware"Create a simple test file to verify the installation:
package main
import (
"fmt"
"github.com/kolosys/helix"
)
func main() {
fmt.Println("Helix installed successfully!")
fmt.Printf("Helix version: %s
", helix.Version)
}Run the test:
go run main.goTo update to the latest version:
go get -u github.com/kolosys/helixTo update to a specific version:
go get github.com/kolosys/helix@v1.2.3To install a specific version of the package:
go get github.com/kolosys/helix@v1.0.0Check available versions on the GitHub releases page.
If you want to contribute or modify the library:
git clone https://github.com/kolosys/helix.git
cd helixgo mod downloadgo test ./...Run tests with race detection:
go test -race ./...If you encounter a "module not found" error:
go mod init if needed)go clean -modcache and reinstall:
go clean -modcache
go get github.com/kolosys/helixFor private repositories, configure Git to use SSH or a personal access token:
git config --global url."git@github.com:".insteadOf "https://github.com/"Or set up GOPRIVATE:
export GOPRIVATE=github.com/kolosys/helixIf you encounter compatibility issues:
go versiongo get github.com/kolosys/heliximport "github.com/kolosys/helix"// Package helix provides a zero-dependency, context-aware, high-performance
// HTTP web framework for Go with stdlib compatibility.
import "github.com/kolosys/helix"// Package logs provides a high-performance, context-aware structured logging library.
//
// Features:
// - Zero-allocation hot paths using sync.Pool
// - Context-aware logging with context.Context
// - Type-safe field builders
// - Multiple output formats (text, JSON, pretty)
// - Sampling for high-volume logs
// - Async logging option
// - Hook system for extensibility
// - Built-in caller information
// - Chained/fluent API
//
// Basic usage:
//
// log := logs.New()
// log.Info("server started", logs.Int("port", 8080))
//
// With context:
//
// log.InfoContext(ctx, "request processed", logs.Duration("latency", time.Since(start)))
import "github.com/kolosys/helix/logs"// Package middleware provides HTTP middleware for the Helix framework.
import "github.com/kolosys/helix/middleware"package main
import (
"fmt"
"github.com/kolosys/helix"
)
func main() {
fmt.Println("Helix installed successfully!")
fmt.Printf("Helix version: %s
", helix.Version)
}go run main.gogo get -u github.com/kolosys/helixgo get github.com/kolosys/helix@v1.2.3go get github.com/kolosys/helix@v1.0.0git clone https://github.com/kolosys/helix.git
cd helixgo mod downloadgo test ./...go test -race ./...go clean -modcache
go get github.com/kolosys/helixgit config --global url."git@github.com:".insteadOf "https://github.com/"export GOPRIVATE=github.com/kolosys/helixgo get github.com/kolosys/heliximport "github.com/kolosys/helix"// Package helix provides a zero-dependency, context-aware, high-performance
// HTTP web framework for Go with stdlib compatibility.
import "github.com/kolosys/helix"// Package logs provides a high-performance, context-aware structured logging library.
//
// Features:
// - Zero-allocation hot paths using sync.Pool
// - Context-aware logging with context.Context
// - Type-safe field builders
// - Multiple output formats (text, JSON, pretty)
// - Sampling for high-volume logs
// - Async logging option
// - Hook system for extensibility
// - Built-in caller information
// - Chained/fluent API
//
// Basic usage:
//
// log := logs.New()
// log.Info("server started", logs.Int("port", 8080))
//
// With context:
//
// log.InfoContext(ctx, "request processed", logs.Duration("latency", time.Since(start)))
import "github.com/kolosys/helix/logs"// Package middleware provides HTTP middleware for the Helix framework.
import "github.com/kolosys/helix/middleware"package main
import (
"fmt"
"github.com/kolosys/helix"
)
func main() {
fmt.Println("Helix installed successfully!")
fmt.Printf("Helix version: %s
", helix.Version)
}go run main.gogo get -u github.com/kolosys/helixgo get github.com/kolosys/helix@v1.2.3go get github.com/kolosys/helix@v1.0.0git clone https://github.com/kolosys/helix.git
cd helixgo mod downloadgo test ./...go test -race ./...go clean -modcache
go get github.com/kolosys/helixgit config --global url."git@github.com:".insteadOf "https://github.com/"export GOPRIVATE=github.com/kolosys/helix