rgctl Guides
Practical, step-by-step guides for every major rgctl feature.
Which fixture?
- In-tree quickstart:
rgctl-tests/ecommerce-java(ships with this repo — no extra clone). Best for firstdiscover/find/blast-radiusruns and the User Guide.- Full feature guides: CoolStore (
example/coolstoreor konveyor-ecosystem/coolstore) — larger Java EE app used in the how-tos below.
Guides
| Guide | Feature | Description |
|---|---|---|
| CLI Command Reference & Architecture Guide | All commands (Lifecycle, Query, Analysis, Security, Policy, Meta) | Complete command taxonomy, canonical vs alias map, and copy-pasteable CLI reference |
| Discovering and Indexing a Codebase | discover | Build the knowledge graph from source code |
| Structured graph queries | find / callers / relations / … | Agent-facing graph exploration verbs |
| Dependency Injection and Frameworks | ExposesRoute / Injects / semantic | HTTP routes, DI wiring, reflection & compiled frameworks.bin catalog (User + Developer guide) |
| Blast Radius Analysis | blast-radius | Measure upstream impact before changing a function |
| Semantic Search | semantic | Natural-language search over function symbols |
| Graph Metrics | metrics | FastPageRank, SampledBetweenness, Fast-Leiden communities, git churn |
| Community Detection | communities | Fast-Leiden clusters + HubStripPolicy; list and label |
| Program Slicing | slice | Extract the minimal set of statements affecting a variable |
| Hybrid CPG | cpg | Combined call-graph + per-function CFG/PDG analysis |
| Inspecting CFG, PDG, and Dominance | inspect | Examine low-level control flow, data dependence, and dominator trees |
| Exporting Graphs | export | Serialize graph data to JSON, GraphML, Graphviz, Mermaid, or Obsidian |
| Markdown Context Graph | discover -l markdown · export | Index docs, Obsidian/OKF export, fixture feature tour (k8s-website scale example) |
| CI Policy Checks | check, review check | PR temporal gates and local policy checks (pr-check alias) |
| Pull Request Review | review paths / check / export | Structural before/after call-path inspection and PR gates |
| HTTP Server and Dashboard | serve | Run an HTTP API and browser-based dashboard |
| Watch mode and incremental update | update, watch, serve --watch | Keep the graph fresh without full rediscover |
| Migration Planning | discover --export-migration-hints | Generate a dependency-aware migration roadmap |
| Clone Detection | clones | Detect exact (Type-1), bloom, and sub-function fragment clones |
| Vulnerability and OSV Supply-Chain Analysis | vuln, deps, taint, security | End-to-end OSV advisory triage, manifest scanning, call-path reachability, and OpenVEX generation |
| Agent pack | CoolStore install walkthrough | Use cases; NL → rgctl skill → CLI |
Prerequisites
All guides assume you have rgctl installed. See the Installation guide to get started.
To follow the examples, clone the repository and navigate to the example project:
git clone https://github.com/konveyor-ecosystem/coolstore.git
cd coolstore
Related Resources
- User Guide -- full CLI reference and tutorial
- JSON API Reference -- schema details for
-f jsonoutput - Agent pack -- install skills and route natural-language intents to
rgctl - Introduction -- definitions of key terms