Installation
2 minute read
Installing Rivaas is easy. Use it as a complete framework with the app package or use individual packages as needed.
Install the Full Framework
The app package provides a complete web framework. It includes everything you need to build production-ready APIs:
go get rivaas.dev/app
This installs the main framework with all packages (router, logging, metrics, tracing, etc.).
Install Individual Packages
Rivaas packages work independently. Install only what you need:
# High-performance router
go get rivaas.dev/router
# Full framework
go get rivaas.dev/app# Request binding
go get rivaas.dev/binding
# Validation
go get rivaas.dev/validation
# Configuration
go get rivaas.dev/config# Structured logging
go get rivaas.dev/logging
# Metrics collection
go get rivaas.dev/metrics
# Distributed tracing
go get rivaas.dev/tracing# OpenAPI generation
go get rivaas.dev/openapi
# Error formatting
go get rivaas.dev/errorsVerify Installation
Create a simple test file to verify your installation:
package main
import (
"context"
"log"
"net/http"
"os"
"os/signal"
"syscall"
"rivaas.dev/app"
)
func main() {
a, err := app.New()
if err != nil {
log.Fatalf("Failed to create app: %v", err)
}
a.GET("/", func(c *app.Context) {
c.JSON(http.StatusOK, map[string]string{
"message": "✅ Rivaas installed successfully!",
})
})
ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
defer cancel()
log.Println("Test server running on http://localhost:8080")
if err := a.Start(ctx); err != nil {
log.Fatal(err)
}
}
Run it:
go run main.go
Test it in another terminal:
curl http://localhost:8080
# Output: {"message":"✅ Rivaas installed successfully!"}
Press Ctrl+C to stop the server gracefully.
System Requirements
- Go Version: 1.25 or higher
- Operating Systems: Linux, macOS, Windows
- Architecture: amd64, arm64
Updating Rivaas
To update to the latest version:
go get -u rivaas.dev/app
To update a specific package:
go get -u rivaas.dev/router
Development Dependencies
For development, you may want additional tools:
# Install Go tools (optional but recommended)
go install golang.org/x/tools/cmd/goimports@latest
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
Troubleshooting
Go Version Issues
If you see an error about Go version:
go: module rivaas.dev/app requires go >= 1.25
Update your Go installation to 1.25 or higher from go.dev/dl.
Module Cache Issues
If installation fails, try cleaning the module cache:
go clean -modcache
go get rivaas.dev/app
Network Issues
If you’re behind a proxy or firewall:
# Set proxy (if needed)
export GOPROXY=https://proxy.golang.org,direct
# Or use a custom proxy
export GOPROXY=https://goproxy.io,direct
Next Steps
Now that you have Rivaas installed, build your first application:
Build Your First Application →
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.