Skip to content

Installation

Gerasimos (Makis) Maropoulos edited this page May 28, 2026 · 6 revisions

When to use this page

  • First time setting up neffos in a Go project.
  • Upgrading to a newer release.

Requirements

  • Go 1.21 or newer. (Current development targets Go 1.26 — see go.mod.)
  • One of the supported WebSocket adapters (gorilla or gobwas) — both are pulled in transitively, you don't install them separately.

Install

go get github.com/kataras/neffos@latest

Or pin in your go.mod:

module your_project_name

go 1.21

require (
    github.com/kataras/neffos v0.0.22
)

If you're starting a new project, prefer @latest. Pin a specific version once you ship to production.

Verify the install with a one-liner:

package main

import (
    "fmt"
    _ "github.com/kataras/neffos"
)

func main() { fmt.Println("neffos installed") }

Troubleshooting

Network errors during go get usually mean GOPROXY is misconfigured. Reset to the default:

go env -w GOPROXY=https://proxy.golang.org,direct

If you're behind a corporate proxy, replace https://proxy.golang.org with your internal Go module proxy.

How to update

go get -u github.com/kataras/neffos@latest

Prefer tagged releases for production. The master branch is usually stable but may include unreleased changes — use it only when you need a specific unreleased fix.

Browser / Node.js client

For the JavaScript/TypeScript client, see neffos.js:

npm install neffos.js

Types are bundled — no separate @types/* install required.

See also

Clone this wiki locally