Installation

Prerequisites

• Go: Version 1.25 or later
• Redis: Version 3.0 or later, or Valkey: Version 7.2 or later

ACOR uses the standard RESP protocol via go-redis v9 and works with any Redis- or Valkey-compatible server. RESP3 is negotiated on connect and falls back to RESP2 automatically on servers that predate the HELLO command.

Install the Package

go get github.com/skyoo2003/acor/pkg/acor@latest

Verify Installation

Create a test file to verify ACOR is installed correctly:

package main

import (
    "fmt"
    "github.com/skyoo2003/acor/pkg/acor"
)

func main() {
    args := &acor.AhoCorasickArgs{
        Addr: "localhost:6379",
        Name: "test",
    }

    ac, err := acor.Create(args)
    if err != nil {
        panic(err)
    }
    defer ac.Close()

    fmt.Println("ACOR installed successfully!")
}

CLI Installation

Install the command-line tool:

go install github.com/skyoo2003/acor/cmd/acor@latest

Verify the CLI:

acor --help
acor version

acor version needs no Redis and prints the version stamped at release build time (dev for a locally built binary).

That is the whole of installing it. What the nineteen commands do — option ordering, batch modes, the four matching shapes, parallel chunking, and when the local cache earns its memory — is the CLI section.

Next Steps

• Quick Start - Build your first application
• Guides - Learn about batch operations and parallel matching