rgctl documentation
Agent-first docs: index once, query with -f json, deepen in the User Guide when a human needs the full walkthrough.
Primary (start here)
| Goal | Canon |
|---|---|
| Install rgctl + choose operating mode | Installation |
| Step-by-step feature how-tos (CoolStore) | Guides |
| LLM / agent workflows | AGENTS.md · Agent recipes |
JSON shapes (schema_version, fields) | JSON API |
| CLI walkthrough (ecommerce-java) | User Guide |
| Concepts (what / why) | Introduction |
Agent loop: AGENTS.md → discover once → gql / blast-radius / cpg with -f json.
First hour (human): Install → User Guide §1–4 on ecommerce-java, then a Guide for the feature you need.
Upgrading from v0.4.8: v0.4.9 release notes (daemon/MCP removed; Kantra; in-repo .rgctl/ only).
Secondary
| Goal | Doc |
|---|---|
| Supported languages | Languages |
| Markdown / doc context graph | Guide (step-by-step) · Reference — .md / .mdx, GQL, Obsidian export, doc semantic index |
| FAQ / glossary | FAQ · Glossary |
HTTP serve query API | HTTP API |
| CI blast-radius policy | Policy format |
| Monolith migration (how-to) | Building a migration plan |
| Research map | Further reading |
Optional browser UI (nice-to-have, not required for agents): Dashboard user guide after discover --with-dashboard.
For contributors
Internals and contribution bars — not the default agent reading path.
| Document | Topic |
|---|---|
| Contributor checklist | End-to-end workflow: add language, update feature, tests, PR |
| Feature designs | Per-capability engineering notes |
| Tier 1 language support | Layer A–F bar for Tier 1 languages |
| Code structure | Crate layout |
| Analysis architecture | CFG / PDG / taint |
| Graph storage architecture | Snapshots, blast cache |
| CLI I/O sanity QE | Golden-path test contract |
| Integration test matrix | Tier A/B/C — in-repo artifacts, HTTP serve, CLI subprocess |
| Dashboard design | WASM export pipeline |
| Migration planner design · Migration algorithms · Harmonic centrality | Migration internals |
| Releasing | Versioned binaries |
| CONTRIBUTING.md | Dev setup |
Terminology
| Term | Meaning |
|---|---|
| Tier 1 languages | Nine always-linked plugins (see languages.md) |
--with-cfg | CFG/PDG archive (prefer over legacy --cfg) |
| Communities | Label propagation (Raghavan 2007); louvain_community_id is historical |
| Dashboard / migration JSON | Opt-in (--with-dashboard / --export-migration-hints) |
| First-hour fixture | In-tree ecommerce-java |
Redirects
- cli-getting-started.md → Installation / User Guide
- cli-output-schemas.md → JSON API
- LANGUAGE_GUIDE.md → languages.md
Docs match the CLI in this repository — verify with rgctl --version.
Maintainer scratch: internal/ (not public).