Status · OrbSearch docs

OrbSearch has not had its first public version. Here is what it does not do, so no limit surprises you.

Running it

No packages or images are published. Compose builds the images from the checkout, and @orbsearch/client and @orbsearch/react are TypeScript source inside the repository's pnpm workspace.
One installation is one shop, with one management key and one panel account, the owner's. There are no invitations or roles.
One machine. Compose runs one of each service, without replication.

The panel edits part of a release: synonyms, each type's searched fields and typos, each page's filters, sorting and grid, rules, banners, and how an import's columns are read.
The rest goes through the management API: channels, attributes, ranking, patterns, URLs, redirects, overlays, relations and search tests, as release files.
A rule the panel's form cannot express can only be renamed, switched on or off, or moved there.

Built-in language knowledge covers German and English. The shop's own words resolve in any language, but word endings, color words, price phrases and the import's defaults know only these two. Add what is missing to synonyms.json and patterns.json.
Search tests are not run. tests.json is checked with its release, but publishing does not run the tests.
A category's where is not applied. It is checked, but a category page lists only the products the catalog assigns to it.
Two settings are checked but never read: never in synonyms.json only refuses edits that would merge its words, and no search reads relations.json.
Suggested words are counted across channels, so a brand that one channel does not sell may still be suggested there.
Some counts are upper bounds where a product's variants differ. The answer marks them with upper_bound, and the trace says why.
Requests have limits: a page holds up to 100 hits, and pages reach the first 1,000 matches. A page counts its first 30 facets and those chosen or asked for; the others come without counts until asked for. Limits lists every limit.

Clicks and views only. A storefront reports clicks and views, not purchases or added carts, so there are no conversion numbers.
A query reaches the reports once two page views searched it on the same day.

Problems have no types of their own. Every type is about:blank; tell problems apart by status.
The OpenAPI document declares no security scheme. A generated client adds the Authorization header itself.
No MCP server. Agents use the HTTP APIs, and in the browser @orbsearch/client registers the WebMCP tools search, get_facets and set_filters (Agents).

OrbSearch is licensed under AGPL-3.0-or-later. The contract crate, @orbsearch/client and @orbsearch/react are MIT.