1. Synopsis
The memory graph around one path, to a fixed depth of at most two hops.
memhtml neighbors <path> [options]2. Arguments
| Argument | Required | Description |
|---|---|---|
path |
yes | The center of the neighborhood. |
3. Flags
| Flag | Type | Default | Values | Description |
|---|---|---|---|---|
--depth |
integer | 1 |
no fixed set | 1 or 2. Never more. |
--limit |
integer | 200 |
no fixed set | Distinct nodes to return, clamped to 200. nodesDropped counts the paths the walk reached and this limit turned away, and scanSaturated says the walk stopped at its own 10000-row cap, which no limit recovers. |
--rel |
string, repeatable | no default | supersedes, contradicts, caused_by, leads_to, part_of, relates_to, example_of, supports, laterally_related |
Restrict to these rels. Repeatable. |
Every command also accepts the global flags.
4. Response
On success the command writes one JSON envelope to stdout, and its type is memory.neighbors.
On failure it writes the failure envelope, whose code comes from error codes.
The JSON envelope gives the fields both shapes carry. Response types lists every value type takes across the binary.
5. Further reading
The guide blocks that name this command:
6. Provenance
A loader generates this page from apps/cli/src/commands.ts while the site builds, so no file in the repository holds it: the COMMANDS array there is the one source of argument parsing, of memhtml manifest, and of AGENTS.md. Change the registry and this page changes with it.