topic inspect¶
The topic inspect command explores the structure of generated topic files without regenerating them. It auto-detects the file format and provides multiple views for navigating the hierarchy.
Basic Usage¶
The command auto-detects whether the file is a tree (JSONL) or graph (JSON) and displays a summary with format, total paths, max depth, and metadata.
Options¶
| Option | Short | Description |
|---|---|---|
--level N |
-l |
Show topics at a specific depth (0=root, 1=children, etc.) |
--expand [N] |
-e |
Show subtree from level. Use alone for all sublevels, or specify depth |
--all |
-a |
Show the complete tree structure |
--format FMT |
-f |
Output format: tree (default), table, or json |
--uuid |
-u |
Show UUID/topic_id for each node |
Exploring by Level¶
Browse the hierarchy one level at a time:
# Show root topic
deepfabric topic inspect topics.json --level 0
# Show first-level children
deepfabric topic inspect topics.json --level 1
# Show second-level topics
deepfabric topic inspect topics.json --level 2
Each level shows a simple bullet list of unique topics at that depth.
Expanding Subtrees¶
Combine --level with --expand to see the subtree from a given level:
# Show all sublevels from level 1
deepfabric topic inspect topics.json --level 1 --expand
# Show only 2 sublevels from level 1
deepfabric topic inspect topics.json --level 1 --expand 2
Expand Behavior
Without a depth argument, --expand shows all sublevels. With a number, it limits the subtree depth. This is useful for large topic structures where showing everything would be overwhelming.
Viewing the Full Structure¶
Display the complete topic hierarchy:
This renders the entire structure as an indented tree with all paths and depth levels.
Output Formats¶
Rich tree rendering with indentation and branch lines. Best for visual exploration in the terminal.
Tabular output with columns for path and depth. Useful for structured review of all paths.
Machine-readable output with metadata, paths, and statistics. Useful for scripting and automation.
UUID Discovery¶
The --uuid flag shows node identifiers alongside topic names:
# UUIDs for all nodes
deepfabric topic inspect topics.json --all --uuid
# UUIDs at a specific level
deepfabric topic inspect topics.json --level 2 --uuid
UUID Types
- Graph format: Shows the actual UUID stored in each node's metadata
- Tree format: Shows a 16-character hex hash derived from the full topic path
Use with Prune
UUIDs discovered here can be passed to deepfabric topic prune --uuid to remove specific branches. See topic prune.
Format Auto-Detection¶
The inspect command determines the file format automatically:
| File Content | Detected Format | Key Indicators |
|---|---|---|
JSONL with path arrays |
Tree | Line-delimited JSON objects with "path" field |
JSON with nodes and root_id |
Graph | Single JSON object with "nodes" and "root_id" |
Graph files display additional metadata including total node count and cycle detection status.
Use Cases¶
-
Structure Inspection
Review topic hierarchy after generation to verify coverage and depth
-
Level Exploration
Browse specific depth levels to understand topic distribution
-
Scripting
Use
--format jsonto extract metadata for automated workflows -
UUID Discovery
Find node UUIDs for targeted pruning with
topic prune