A unified, compact version for local, private search

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • macOS
   • Ubuntu / Debian
   • RHEL / CentOS / Fedora
   • Direct Binary Download
   • From Source
3. Usage
4. Development
5. Contributing
6. License

About The Project

Sercha CLI is a powerful, privacy-focused search tool designed for local environments. Built with performance and security in mind, it provides fast, efficient search capabilities without relying on external services or compromising your data privacy.

Why Sercha?

• Privacy First: All searches happen locally on your machine - your data never leaves your control
• Fast & Efficient: Optimized for speed with CGO-enabled performance
• Cross-Platform: Native builds for macOS (Apple Silicon) and Linux (x86_64 & ARM64)
• Easy Installation: Multiple installation methods including Homebrew, apt, yum, and direct binaries

(back to top)

Built With

• - Go 1.24+
• CGO Enabled - For enhanced performance with C/C++ integration
• GoReleaser Pro - Enterprise-grade release automation
• GitHub Actions - Automated CI/CD pipeline

(back to top)

Getting Started

Choose your preferred installation method below based on your operating system.

macOS

Homebrew (Recommended)

brew tap custodia-labs/sercha
brew install sercha

Note: On first run, macOS may block the binary. If you see "killed", run:

xattr -d com.apple.quarantine $(which sercha)

(back to top)

Ubuntu / Debian

Ubuntu 24.04 (Noble) and 22.04 (Jammy)

curl -1sLf 'https://dl.cloudsmith.io/public/custodia-labs/sercha/setup.deb.sh' | sudo bash
sudo apt-get install -y sercha

(back to top)

RHEL / CentOS / Fedora

curl -1sLf 'https://dl.cloudsmith.io/public/custodia-labs/sercha/setup.rpm.sh' | sudo bash
sudo yum install -y sercha

(back to top)

Direct Binary Download

Download the latest release for your platform from GitHub Releases:

• macOS (Apple Silicon): sercha_*_darwin_arm64.tar.gz
• Linux (x86_64): sercha_*_linux_amd64.tar.gz
• Linux (ARM64): sercha_*_linux_arm64.tar.gz

Note: Binary downloads require Xapian to be installed manually:

• macOS: brew install xapian
• Ubuntu/Debian: sudo apt install libxapian30
• RHEL/CentOS: sudo yum install xapian-core-libs

Extract and move to your PATH:

tar -xzf sercha_*.tar.gz
sudo mv sercha /usr/local/bin/

(back to top)

From Source

Requires Go 1.24 or later:

go install github.com/custodia-labs/sercha-cli/cmd/sercha@latest

(back to top)

Usage

Quick Start

# 1. Add a local folder as a source
sercha source add filesystem -c path=~/Documents

# 2. Sync documents from the source
sercha sync

# 3. Search your documents
sercha search "meeting notes"

# 4. Or launch the interactive TUI
sercha tui

Documentation

For detailed guides and configuration options, visit the Sercha Documentation:

• Quickstart Guide - Get up and running in 5 minutes
• Supported Connectors - GitHub, Google Drive, Gmail, and more
• AI Models - Text, hybrid, and AI-assisted search
• TUI Guide - Interactive terminal interface
• MCP Server - AI tool integration

(back to top)

Development

Prerequisites

• Go 1.24 or later
• CGO enabled

Build

go build -o sercha ./cmd/sercha/main.go

Test

go test ./...

Run Locally

go run ./cmd/sercha/main.go

For more detailed development instructions, see CONTRIBUTING.md.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Please read:

• Contributing Guide - How to contribute, development workflow, and governance
• Code of Conduct - Community standards

Quick Links

• PR Templates - Use these when opening PRs
• Issue Templates - Use these when reporting bugs or requesting features

(back to top)

License

Distributed under the Apache 2.0 License. See LICENSE for details.

(back to top)