![\"SemiLayer\"](\"https://semilayer.com/logo.svg\"){kind=logo}
\n \n @semilayer/cli\n
\n \n
\n @semilayer/cli\n
\nBolt semantic search, similarity, and smart feeds onto any database — from your terminal.\n
\n\n---\n\n`semilayer` is the primary interface to [SemiLayer](https://semilayer.com). It scaffolds config, pushes schema, indexes data, generates a typed client, streams rows live, and lets you compose searches with the same muscle memory as `curl | jq`.\n\nOne config file. One push. Indexing, access rules, and a typed client — handled.\n\n## Install\n\n```bash\nnpm i -g @semilayer/cli # global\npnpm add -D @semilayer/cli # per-project\n```\n\nRequires Node 22+.\n\n## Zero to search in four commands\n\n```bash\nsemilayer login # browser-based OIDC\nsemilayer init # pick org/project/env, scaffold sl.config.ts, mint a key\nsemilayer push --resume-ingest # validate + upload config, kick off indexing\nsemilayer run search articles -q \"postmortems about cascading failure\"\n```\n\nThat's the whole loop. Everything below is how to go further.\n\n## Define your data\n\n`sl.config.ts` is the source of truth. A lens is a semantic view over a table — fields, mapping, operations, access rules.\n\n```ts\nimport { defineConfig } from '@semilayer/core'\n\nexport default defineConfig({\n stack: 'my-app',\n sources: {\n main: { bridge: '@semilayer/bridge-postgres' },\n },\n lenses: {\n articles: {\n source: 'main',\n table: 'articles',\n fields: {\n id: { type: 'number', primaryKey: true },\n title: { type: 'text', searchable: true },\n body: { type: 'text', searchable: true },\n author_id: { type: 'number' },\n },\n grants: {\n search: 'public',\n similar: 'public',\n },\n },\n },\n})\n```\n\nPush it:\n\n```bash\nsemilayer push --resume-ingest\n```\n\n`push` validates the config, diffs against remote, refuses to clobber drift (use `--force` if you mean it), and starts ingest. Every push is content-hashed — idempotent by default.\n\n## Run queries from the shell\n\n`semilayer run` is three subcommands: `search` (semantic), `query` (filter + order), `similar` (nearest-neighbor). They auto-format for TTY and spit NDJSON when piped.\n\n```bash\n# semantic search\nsemilayer run search articles -q \"how we scaled Postgres\" --limit 20\n\n# structured query with filter + ordering\nsemilayer run query articles --where '{\"author_id\":42}' --order-by -created_at -l 50\n\n# similar to a known record\nsemilayer run similar articles --id 1337 --min-score 0.8\n```\n\n### Compose like unix\n\n`run` reads stdin. Pipe one lens into another with `--join`:\n\n```bash\n# top 10 semantic hits for \"auth bugs\" → pull their authors\nsemilayer run search issues -q \"auth bugs\" -o json \\\n | semilayer run query users --join stdin:author_id=id\n```\n\n### Include related lenses\n\n```bash\n# CSV shorthand\nsemilayer run search articles -q \"cache invalidation\" -i \"comments(limit:3),author\"\n\n# or full JSON when you need where/select/orderBy on the include\nsemilayer run query articles -i '{\"comments\":{\"where\":{\"approved\":true},\"limit\":5}}'\n```\n\n### Use a scoped API key directly\n\nNo `.semilayerrc`? No problem. Skip the JWT entirely:\n\n```bash\nsemilayer run search articles -q \"...\" --api-key sk_live_xxx\n```\n\n## Keep data fresh\n\nThree shapes of ingest depending on how dangerous you want to be:\n\n```bash\nsemilayer sync articles # smart: full scan, hash dedup, tombstone deletes\nsemilayer sync articles --rebuild # nuke the partition, re-embed everything\nsemilayer push --rebuild # same, but for ALL lenses (confirms first)\n```\n\n`sync` is the workhorse — it catches deletes and only re-embeds rows whose mapped content actually changed. Use it when your source doesn't have reliable `updated_at`.\n\nPause and resume are instant (ingest checks between pages and saves its cursor):\n\n```bash\nsemilayer pause articles\nsemilayer resume articles\n```\n\n## Stream live\n\n`stream` opens a WebSocket and yields rows as they land. `observe` watches a single record.\n\n```bash\n# live tail of new \"errors\" rows\nsemilayer stream errors --api-key sk_live_xxx\n\n# follow a single order's state\nsemilayer observe orders ord_9f2 --api-key sk_live_xxx\n```\n\nBoth auto-switch to NDJSON when piping — perfect for feeding Sentry, Slack, whatever.\n\n## Drive feeds from the shell\n\nThe `feed` command group hits the [feed operation](https://semilayer.dev/feeds) — list, view, tail, and explain named feeds without going through Beam codegen.\n\nThe lens-feed identifier is `