Getting started
What is suo
A hosted site-search platform that gets English and CJK right, set up in under five minutes.
suo (索) indexes your site or app, answers typo-tolerant, search-as-you-type queries, and ranks results in an order you can explain. It handles English, Traditional Chinese, Simplified Chinese and Japanese properly — a half-typed 稍後閱 still finds 稍後閱讀 while your reader is typing it.
suo is three things:
- An engine on Cloudflare's edge. Reads answer from the replica nearest your reader; writes are ordered and versioned, so a read right after a write always sees it.
- A widget: a ⌘K modal, an inline search box and a mobile sheet, themed with CSS variables and safe with IME input.
- A dashboard for sources, indexing, relevance tuning, a playground that explains every ranking, analytics and API keys.
Three ways in
You do not have to pick one. Most sites use two.
| Way in | Best for | Quickstart |
|---|---|---|
| Paste a URL | Docs and marketing sites a crawler can read | Paste a URL |
npx @suo/cli init | fumadocs, Next and plain HTML projects | Run the CLI |
| Push with the API | App content no crawler can see: records behind a login, per-user libraries | Push with the API |
What you get
- A search key with your first index already live.
- A widget you drop in with one tag, or one line of React.
- A playground that shows why each result ranked where it did, tier by tier.
- Query analytics: what people searched, what came up empty, and a weekly fix list.
Before you start
You need a way to prove you own the domain you are indexing (a DNS TXT record or a meta tag — see Verify your domain), and five minutes.
Ready? Start with whichever quickstart matches how your content is built.