graph:get

Read the graph projection for navigation and topology workflows.

Reference for flywheel graph:get.

Command Group

Nodes & Graph Commands

Summary

Read the graph projection for navigation and topology workflows.

Usage

flywheel graph:get [FLAGS]

Required flags

None.

Optional flags

FlagValueDefaultChoicesDescription
--node_idstringScope to a root node.
--depthintegerMax depth.
--max_nodesintegerMax nodes in response.
--page_sizeintegerGraph page size.
--cursorstringCursor returned by the previous graph page.
--filterstringComma-separated node filter tokens, e.g. include:tag:tag-priority. Axes: owner, root_graph, tag, visibility, recency.
--excludestringComma-separated exclude shorthand tokens, e.g. owner:<user_uuid>. Axes: owner, root_graph, tag, visibility, recency.
--formatFORMATjson, tsv, csv, tableOutput format for command results.
--envPROFILEUse a configured CLI profile for this invocation.
--outPATHWrite output to a file path, or use - for stdout.
--openOpen browser-bound URLs when supported.
--no-retryDisable transient-error retries.
--retry-maxNMaximum transient-error retry attempts.
--waitBlock on async operations until a terminal state is reached.
--wait-timeoutSECONDS600Seconds to wait for --wait before timing out. Defaults to 600.
--allow-selfAllow mutating the currently active credential.
--timeoutSECONDSSet the per-request timeout budget in seconds.
--idempotency-keyKEYReuse an Idempotency-Key so ambiguous write failures can be retried with the same key.
--forceForce safety-gated operations where supported.
--yesSkip confirmation prompts for destructive operations.
--debugPrint structured request debugging with secrets masked.
--verbosePrint verbose progress for long-running operations.
-h, --helpShow this help.

Examples

Read the graph scoped to a root.

flywheel graph:get --node_id r_root --depth 3

Read the first graph page.

flywheel graph:get --page_size 10000

Read the next graph page.

flywheel graph:get --page_size 10000 --cursor <next_cursor>

Read a filtered graph page.

flywheel graph:get --filter include:tag:tag-priority --exclude owner:<user_uuid>