Skip to content

INSTALLATION.md

Latest commit

 

History

History
107 lines (78 loc) · 2.63 KB

INSTALLATION.md

File metadata and controls

107 lines (78 loc) · 2.63 KB

Installation

Homebrew (macOS / Linux)

brew install lleontor705/tap/cortex

Update:

brew update && brew upgrade cortex

go install (Recommended for Windows)

go install github.com/lleontor705/cortex/cmd/cortex@latest

Binary goes to $GOPATH/bin/cortex (typically ~/go/bin/ or %USERPROFILE%\go\bin\).

Build from Source

git clone https://github.com/lleontor705/cortex.git
cd cortex
go build -ldflags="-s -w" -o cortex ./cmd/cortex

With version stamp:

go build -ldflags="-s -w -X main.version=local-$(git describe --tags --always)" -o cortex ./cmd/cortex

Pre-built Binaries

Download from Releases:

Platform File
Linux x86_64 cortex_<version>_linux_amd64.tar.gz
Linux ARM64 cortex_<version>_linux_arm64.tar.gz
macOS Intel cortex_<version>_darwin_amd64.tar.gz
macOS Apple Silicon cortex_<version>_darwin_arm64.tar.gz
Windows x86_64 cortex_<version>_windows_amd64.zip
Windows ARM64 cortex_<version>_windows_arm64.zip

All releases include checksums.txt (SHA256).

Linux / macOS

# Download (example: Linux x86_64)
curl -sSL https://github.com/lleontor705/cortex/releases/latest/download/cortex_linux_amd64.tar.gz | tar xz
chmod +x cortex
sudo mv cortex /usr/local/bin/

Windows (PowerShell)

Invoke-WebRequest -Uri https://github.com/lleontor705/cortex/releases/latest/download/cortex_windows_amd64.zip -OutFile cortex.zip
Expand-Archive cortex.zip -DestinationPath .
Move-Item cortex.exe C:\Users\$env:USERNAME\bin\

Docker

docker build -t cortex .
docker run -v cortex-data:/root/.cortex cortex mcp

Verify Installation

cortex version
cortex search "test"

Agent Setup

After installing, configure your AI coding agent:

cortex setup claude-code
cortex setup opencode
cortex setup gemini-cli
cortex setup codex

See AGENT-SETUP.md for detailed per-agent instructions.

Environment Variables

Variable Purpose Default
CORTEX_PORT HTTP server port 7438
CORTEX_DATABASE_PATH Database file location cortex.db
CORTEX_DATABASE_IN_MEMORY Use in-memory database false
CORTEX_LOGGING_LEVEL Log level (debug, info, warn, error) info

Windows Notes

  • go install is recommended to avoid antivirus false positives on unsigned binaries
  • If using prebuilt binaries, you may need to add an antivirus exclusion
  • Cortex uses pure Go SQLite (modernc.org/sqlite) — no C compiler or CGO needed