Quickstart
Analyze a codebase and launch the visualizer in under 5 minutes.
2 min read
5-Minute Quickstart
Follow this guide to run your first architectural analysis and view the resulting dependency graph.
Step 1: Run an Analysis
Point Omnideps to any repository or source directory containing code in Rust, Java, Python, C, or C++:
omnideps analyze ./path-to-my-project --output dependencies.json Omnideps will:
- Discover all source files matching supported extensions.
- Parse the AST using multi-threaded Tree-sitter grammars.
- Extract entities (classes, structs, functions, modules) and statements.
- Execute type and name resolution to link callers with callees and types.
- Save the Cytoscape-formatted graph directly to
dependencies.json(or pass--rawto also exportraw_dependencies.json).
Step 2: Launch the Web Visualizer
To inspect the dependencies interactively in your browser:
omnideps serve This starts a local Axum server at http://127.0.0.1:3000 and automatically opens your default browser.
Tip: If port 3000 is occupied, supply a custom port with
omnideps serve --port 8080.Inside the UI you can:
- Load your freshly generated
dependencies.jsonor choose a folder to analyze on-the-fly. - Filter components by type (classes, functions, files, modules).
- Zoom, pan, and run force-directed layout simulations (fCoSE / CoSE).
- Inspect in-degree and out-degree relationships for any selected node.
Step 3: Export CSV Metrics
If you are performing architectural research or code smell detection, export a tabular CSV summary:
omnideps analyze ./path-to-my-project -o deps.json -c report.csv The CSV report contains summary metrics including total node counts, edge distributions, and reference resolution statistics.