Welcome to hlquery
Development Mode: hlquery is currently in active development. Behavior, APIs, and performance characteristics may change, and some features are still incomplete.
hlquery helps you add search that feels fast, useful, and easy to shape around your content. It is made for product catalogs, docs, support content, internal tools, and any place where people need to find the right thing without fighting the search box.
What is hlquery?
hlquery gives your users better ways to discover information. It can match exact words, understand related meaning, and let you tune what should show up first.
It is a good fit when you want:
- Search results that feel relevant instead of random
- Typo-friendly discovery for real user queries
- Filters, facets, and sorting that make browsing easier
- Simple ways to index content and keep it updated
- Room to grow from a small project into a larger search experience
Key Features
- Better keyword search - Help users find exact names, phrases, IDs, and important terms.
- Meaning-aware discovery - Find related results even when people do not type the exact words.
- Balanced results - Blend exact matches with broader discovery for a more helpful search experience.
- Organized content - Keep products, articles, records, or support docs in clear collections.
- Easy integration - Add, update, and search documents from the tools you already use.
- Friendly clients - Work with hlquery from popular languages and simple web requests.
Performance
hlquery is designed to feel quick in everyday use. Real performance depends on your content, traffic, and deployment, so test with your own data before relying on production numbers.
Documentation
- Features - See what you can build with hlquery
- Use Cases - Explore common search experiences
- Quick Start - Try your first collection quickly
- Installation - Set up hlquery locally
- Web Interface - Test and explore search interactively
- API Reference - Look up the details when you need them
Getting Started
- Quick Start - Create your first searchable collection
- Web Interface - Try searches and inspect results
- Examples - Learn from practical examples
- Installation - Set up your own server
- API Overview - Connect hlquery to your app
- Client Libraries - Pick the language you prefer
Community
- GitHub: View on GitHub
- Docs Site: Visit Website
- Issues: Report Issues
- Discussions: Join Discussions
License
BSD 3-Clause License. hlquery can be used in both open source and commercial projects.
Next Steps
First Time Here?
- Quick Start Guide - Build your first search flow
- Web Interface (hanalyzer) - Explore results visually
- Examples - Learn by example
- Use Cases - See where hlquery fits
Building Something?
- Installation Guide - Get hlquery running
- hanalyzer - Test searches interactively
- Configuration Guide - Shape search for your content
- Client Libraries - Choose your language
- API Reference - Look up exact options
Running It in Production?
- Configuration Guide - Production configuration
- Server Services - Service management
- Monitoring - JSON metrics endpoints
- Configure authentication and security