Skip to main content

Installation

This guide covers how to install KiviGo and its backends for your Go projects.

Core Library​

Install the main KiviGo library:

go get github.com/kivigo/kivigo@latest

Backend Installation​

KiviGo uses a modular architecture where each backend is a separate Go module. This keeps your dependencies minimal - you only install what you need. Retrieve the backend installation instructions on each backend's documentation page. See backends overview to choose the right one for your use case: Backends Overview.

Troubleshooting​

Common Issues​

Module not found errors:

  • Ensure you're using Go 1.21 or later
  • Run go mod tidy after installation
  • Check your GOPROXY settings if behind a corporate proxy

Version conflicts:

  • Use go mod graph to identify conflicting dependencies
  • Pin specific versions using go get package@version

Build errors:

  • Some backends require CGO (like BadgerDB) - ensure you have a C compiler
  • Check backend-specific documentation for additional requirements

Next Steps​

Now that KiviGo is installed:

  1. Start with Quick Start - Learn the basics with simple examples
  2. Explore Operations - Understand all available operations
  3. Try Examples - See practical usage patterns
  4. Choose your Backend - Pick the right storage for your use case