Menu
Knowledge pack for fastify-orama — a Fastify plugin that integrates Orama full-text search with persistence support.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | fastify-orama |
| description | Knowledge pack for fastify-orama — a Fastify plugin that integrates Orama full-text search with persistence support. |
| metadata | {"author":"mateonunez","version":"4.0.0","source":"https://github.com/mateonunez/fastify-orama","stack":"Fastify 5, Orama 3, fastify-plugin, JavaScript + TypeScript declarations"} |
Fastify plugin for Orama search engine. Provides a proxy API over all Orama functions via fastify.orama, with optional data persistence (in-memory or file-based) and TypeScript generics via withOrama<T>().
borp (TAP protocol) + c8 coverage + tstyche for type testsfastify-plugin wrapper with { fastify: '5.x', name: 'fastify-orama' }| Category | Reference | Description |
|---|---|---|
| Core | core-plugin-api | Plugin registration, decorator, Orama proxy pattern |
| Features | features-persistence | PersistenceInFile and PersistenceInMemory adapters |
| Best Practices | best-practices-types | TypeScript generics, module augmentation, withOrama<T>() |
# Development
npm test # lint + unit tests + type tests
npm run unit # borp -T --reporter spec (with c8 coverage)
npm run typescript # tstyche type checking
npm run lint # standard | snazzy
// Basic usage
const fastify = require('fastify')();
const { fastifyOrama } = require('fastify-orama');
await fastify.register(fastifyOrama, {
schema: { title: 'string', body: 'string', tag: 'enum' },
});
await fastify.orama.insert({ title: 'Hello', body: 'World', tag: 'news' });
const results = await fastify.orama.search({ term: 'hello' });
// TypeScript with generics
const app = fastify().withOrama<{ title: 'string'; body: 'string' }>();
// app.orama is now typed with OramaApi<{ title: 'string'; body: 'string' }>
Review a diff or PR against my conventions — Result not throw, vertical slices, AItError codes, node:test, Biome, entity normalisation, a11y. Findings are triaged by severity (correctness → conventions → polish), not piled in a flat list. Use when reviewing a diff, reviewing a PR before merge, self-reviewing before opening a PR, or when user says "review this", "review the diff", "code review", or invokes `/code-review`.
Ultra-compressed communication mode. Cuts token usage ~75% by dropping filler, articles, and pleasantries while keeping full technical accuracy. Use when user says "caveman mode", "talk like caveman", "use caveman", "less tokens", "be brief", or invokes /caveman.
Break a plan, spec, or PRD into independently-grabbable issues using vertical-slice tracer bullets. Use when user wants to convert a plan into issues, create implementation tickets, or break down work into issues.
Turn the current conversation context into a PRD and publish it to the issue tracker. Use when user wants to create a PRD from the current context.
Triage issues through a state machine driven by triage roles. Use when you want to create an issue, triage issues, review incoming bugs or feature requests, prepare issues for an AFK agent, or manage issue workflow.
Create new agent skills with proper structure, progressive disclosure, and bundled resources. Use when user wants to create, write, or build a new skill.