Installation

Code Search can be installed in several ways depending on your needs and infrastructure.

Prerequisites

Before installing, ensure you have:

• Docker (version 20.10+) and Docker Compose (v2)
• PostgreSQL 14+ or MySQL 8+ (or use the included Docker container)
• Redis 7+ (or use the included Docker container)
• At least 4GB RAM and 10GB disk space for small deployments

For development or building from source:

• Go 1.22+
• Node.js 20+

Installation Methods

Docker

The easiest way to get started. Run all services with a single command.

1. Download the docker-compose file:

   curl -O https://raw.githubusercontent.com/techquestsdev/code-search/main/docker-compose.yml

2. Create a configuration file:

   curl -O https://raw.githubusercontent.com/techquestsdev/code-search/main/config.example.yaml
   mv config.example.yaml config.yaml

3. Edit config.yaml with your settings (optional for basic usage)

4. Start all services:

   docker compose up -d

5. Verify everything is running:

   docker compose ps

Services will be available at:

• Web UI: http://localhost:3000
• API: http://localhost:8080
• API Docs: http://localhost:8080/docs

Source

Build from source for development or customization.

1. Clone the repository:

   git clone https://github.com/techquestsdev/code-search.git
   cd code-search

2. Install Go dependencies:

   go mod tidy

3. Build all binaries:

   make build

4. Build the web UI:

   cd web
   npm install
   npm run build
   cd ..

5. Start infrastructure (PostgreSQL, Redis, Zoekt):

   docker compose up -d postgres redis zoekt

6. Run database migrations:

   make migrate-up

7. Start the services:

   # Terminal 1: API Server
   ./bin/code-search-api
   
   # Terminal 2: Indexer
   ./bin/code-search-indexer
   
   # Terminal 3: Web UI (development)
   cd web && npm run dev

Kubernetes

Deploy to Kubernetes using Helm or raw manifests.

1. Install the chart from OCI registry:

   helm install code-search oci://ghcr.io/techquestsdev/charts/code-search \
     --namespace code-search \
     --create-namespace

2. Port-forward to access locally:

   kubectl port-forward svc/code-search-web 3000:3000 -n code-search

See Helm Deployment for detailed configuration options.

CLI Installation

The CLI can be installed separately for interacting with a Code Search server.

macOS

# Using Homebrew (recommended)
brew install techquestsdev/tap/code-search

# Or download binary
curl -L https://github.com/techquestsdev/code-search/releases/latest/download/code-search_Darwin_arm64.tar.gz | tar xz
sudo mv code-search /usr/local/bin/

Linux

# Download binary
curl -L https://github.com/techquestsdev/code-search/releases/latest/download/code-search_Linux_x86_64.tar.gz | tar xz
sudo mv code-search /usr/local/bin/

# Or use Go install
go install github.com/techquestsdev/code-search/cmd/cli@latest

Windows

Download the latest .zip from the releases page and extract code-search.exe to a directory in your PATH.

Verify Installation

After installation, verify everything is working:

# Check the API is responding
curl http://localhost:8080/health
# Expected: {"status":"ok"}

# Check all services are ready
curl http://localhost:8080/ready
# Expected: {"status":"ready","checks":{"database":"ok","redis":"ok","zoekt":"ok"}}

# Test the CLI
code-search --version

Next Steps

Now that Code Search is installed:

1. Quick Start - Add your first repository and start searching
2. Configuration - Customize your installation
3. Code Hosts - Connect to GitHub, GitLab, and more