graph:get
Read the graph projection for navigation and topology workflows.
Reference for flywheel graph:get.
Read a known graph with --node_id, which includes every readable access scope by default. An unanchored read defaults to your own nodes; request --access_scopes shared or --access_scopes public for discovery. A visibility filter only narrows those scopes, so a public filter needs the public scope too. See Add to a graph you don't own.
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
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--node_id | string | Scope to a root node. Without --access_scopes, reads that graph in every scope you can read: owned, shared and public. | ||
--access_scopes | string | Comma-separated scopes to read: owned (your nodes), shared (shared with you, including through a repository role), public. Default: owned, or every scope with --node_id. | ||
--depth | integer | Max depth. | ||
--max_nodes | integer | Max nodes in response. | ||
--page_size | integer | Graph page size. | ||
--cursor | string | Cursor returned by the previous graph page. | ||
--filter | string | Comma-separated node filter tokens, e.g. include:tag:tag-priority. Axes: owner, root_graph, tag, visibility, recency. | ||
--exclude | string | Comma-separated exclude shorthand tokens, e.g. owner:<user_uuid>. Axes: owner, root_graph, tag, visibility, recency. | ||
--format | FORMAT | json, tsv, csv, table | Output format for command results. | |
--env | PROFILE | Use a configured CLI profile for this invocation. | ||
--out | PATH | Write output to a file path, or use - for stdout. | ||
--open | Open browser-bound URLs when supported. | |||
--no-retry | Disable transient-error retries. | |||
--retry-max | N | Maximum transient-error retry attempts. | ||
--wait | Block on async operations until a terminal state is reached. | |||
--wait-timeout | SECONDS | 600 | Seconds to wait for --wait before timing out. Defaults to 600. | |
--allow-self | Allow mutating the currently active credential. | |||
--timeout | SECONDS | Set the per-request timeout budget in seconds. | ||
--idempotency-key | KEY | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | ||
--force | Force safety-gated operations where supported. | |||
--yes | Skip confirmation prompts for destructive operations. | |||
--debug | Print structured request debugging with secrets masked. | |||
--verbose | Print verbose progress for long-running operations. | |||
-h, --help | Show this help. |
Examples
Read a graph you can read, by its root, in every scope.
flywheel graph:get --node_id r_root --depth 3Read graphs shared with you.
flywheel graph:get --access_scopes sharedRead public graphs.
flywheel graph:get --access_scopes publicRead the first graph page.
flywheel graph:get --page_size 10000Read 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>