Nectar command reference
Every Nectar command, with a one-line purpose and the flags that matter. Grounded in the Nectar technical manual.
Nectar command reference
Every Nectar command, with a one-line purpose and the flags that matter. Grounded in the Nectar technical manual.
Related:
#Daemon and service
| Command | Purpose |
|---|---|
nectar daemon |
Start the daemon on 127.0.0.1:3854, serving /health. |
nectar install |
Register the OS service unit and the Doctor registry entry. |
nectar uninstall |
Deregister the OS service unit. |
nectar service-status |
Report the OS service unit's running state. |
#Scanning and describing
| Command | Purpose |
|---|---|
nectar brood --dry-run |
Preview the full scan's cost locally. No model calls, no writes. |
nectar brood |
Read and describe every file once, against the store. |
nectar brood --force |
Force a fresh description, ignoring existing ones. |
nectar brood --limit N |
Describe at most N files at a time, to pace cost. |
#Searching
| Command | Purpose |
|---|---|
nectar search "<query>" |
Hybrid recall over described files. |
nectar search "<query>" --limit N |
Limit the number of results. |
nectar search "<query>" --json |
Return machine-readable results. |
#Maintenance
| Command | Purpose |
|---|---|
nectar rebuild-projection |
Regenerate .honeycomb/nectars.json from Deep Lake. |
nectar review-matches |
Review low-confidence identity matches before they are claimed. |
nectar prune --confirm |
Prune long-missing identities from the durable store. |
nectar --help |
Show the full command list. |
#Environment and prerequisites
A real, writing scan needs credentials written by the login flow at ~/.deeplake/credentials.json, and the description gateway enabled through its environment variables. Without them the daemon still boots and serves /health, but scanning stays dormant and reports its reason, for example that credentials are missing or the gateway is disabled. A dry run and search do not need the gateway.
#Telemetry
Anonymous aggregate usage telemetry is on by default and never includes file contents or paths. Opt out with NECTAR_TELEMETRY=0 or the cross-tool DO_NOT_TRACK standard.
#Interfaces
- The daemon exposes hive-graph endpoints under
/api/hive-graph/*on loopback, which the Hive portal's hive-graph page reads. - A typed TypeScript SDK ships as
@legioncodeinc/nectar. - Nectar has no MCP server of its own; results surface through Honeycomb's recall tools.