`neighbors`

Show the one-hop neighbourhood of a node: every edge touching it, in both directions, across all edge kinds. The most general single-node view of the graph.

Source: src/commands/neighbors_command.ts · query: GraphQuery.neighborhood in src/query/graph_query.ts

Synopsis


npx codespine neighbors <id> [options]

Arguments

Argument	Required	Description
`<id>`	yes	Node id of the symbol to inspect. Obtain it from `find --json`.

Options

Option	Default	Description
`-o, --output-folder <dir>`	`./.codespine`	Output folder; the Kùzu database is read from `<dir>/graph.kuzu`.
`--json`	`false`	Emit raw JSON instead of the formatted table.

What it does

Runs two one-hop queries — outbound and inbound — across all edge kinds and concatenates them:


-- outgoing
MATCH (center:GraphNode {id: $id})-[e:Edge]->(other:GraphNode)
RETURN other.*, e.kind AS edgeKind
 
-- incoming
MATCH (center:GraphNode {id: $id})<-[e:Edge]-(other:GraphNode)
RETURN other.*, e.kind AS edgeKind

Unlike references, it does not filter by edge kind — it includes structural edges (CONTAINS, IMPORTS, EXPORTS) and the WRITES mutation edge alongside the reference edges. This makes it the right command for “what is this node connected to?” rather than “what depends on it?”.

Outgoing edges are listed first, then incoming. Within each group the order is whatever Kùzu returns (no explicit sort).

Output

Formatted (default) — each line shows direction (-> outgoing, <- incoming), the edge kind, and the neighbour:


-> CONTAINS     initSchema   src/store/kuzu_store.ts:30
-> CONTAINS     run          src/store/kuzu_store.ts:49
<- CALLS        main         src/cli.ts:16

3 edge(s)

JSON (--json) — an array of NeighborRef objects: a SymbolRef plus edgeKind and direction ("in" or "out"). No edges yields (no neighbours) / [].

Examples


# everything connected to a class, in and out
npx codespine neighbors 'ClassDeclaration:src/store/kuzu_store.ts#KuzuStore@11'
 
# machine-readable
npx codespine neighbors 'ClassDeclaration:src/store/kuzu_store.ts#KuzuStore@11' --json

`neighbors` vs related commands

Question	Command
All edges, both directions, every kind?	`neighbors`
Only inbound reference-kind edges?	`references`
Only inbound `CALLS`?	`who-calls`
Only outbound `CALLS`?	`calls`

Notes and caveats

Results are limited to a single hop. For transitive impact use blast-radius.
The breadth of edges depends on the extraction: a structural-only graph shows only CONTAINS/IMPORTS/EXPORTS; the type and behavioral edges appear only with --semantic.

neighbors