Skip to content

CLI Overview

The lucerna CLI lets you index, search, and inspect codebases directly from the terminal — no code required.

Use a package manager’s runner to execute Lucerna as a one-off command:

Terminal window
npx @upstart.gg/lucerna <command>
# or
pnpm dlx @upstart.gg/lucerna <command>
# or
bunx @upstart.gg/lucerna <command>

For repeated use, install Lucerna globally so the lucerna binary is always available:

Terminal window
npm install -g @upstart.gg/lucerna
# or
pnpm add -g @upstart.gg/lucerna
# or
bun add -g @upstart.gg/lucerna

Then use it directly:

Terminal window
lucerna <command>
CommandDescription
indexOne-shot indexing of a project
watchIndex and re-index on file changes
searchSearch an existing index
graphExplore knowledge graph relationships
statsShow index statistics
clearDelete the index
evalMeasure recall@k against a query set