Documentation menu

Agent cheat sheet

Paste this into your agent's instructions (CLAUDE.md, AGENTS.md, .cursorrules, a system prompt) so it reaches for jdx instead of unzip, javap and grep. It is the verbatim output of jdx help --agent, regenerated from the current build.

jdx help --agent
jdx agent cheat sheet (paste into CLAUDE.md / system prompt):
jdx show <type> — Go to declaration
jdx members <type> --inherited — Code completion after `.`
jdx outline <type> — File structure
jdx signature <member> — Parameter info
jdx doc <symbol> — Quick documentation
jdx body <member> — Open the method
jdx source <type> — Open the file / decompile
jdx search <pattern> — Search everywhere
jdx resolve <name> — What is this symbol?
jdx ls [package] — External library browser (packages/types)
jdx tree [artifact] — External library browser (artifacts)
jdx usages <symbol> — Find usages
jdx hierarchy <type> — Type hierarchy
jdx implementors <type> — Who implements this?
jdx callers <member> — Call hierarchy (in)
jdx calls <member> — Call hierarchy (out)
jdx samples <symbol> — Real call sites as usage examples
jdx diff <old> <new> — Public-API diff + binary-compat warnings (upgrades)
jdx version — Print the jdx version
jdx upgrade [--check] — Self-update from GitHub Releases
jdx doctor — Self-diagnosis (JDK, index, AppCDS, daemon, workspace)
jdx ws create|list|info|remove|add|use — Project and library configuration
jdx cache info|gc|clear — Index and cache maintenance
jdx kotlin install — Fetch the Kotlin PSI sidecar (Kotlin sources)
jdx daemon start|stop|status|restart — Warm background JVM (5-min idle shutdown)
jdx serve [--port 7070] — Local HTTP/JSON API
jdx setup --agent opencode|claude-code|cursor|kilo|cline|codex|copilot|antigravity --scope project|system — Wire jdx into an agent (OpenCode, Claude Code, Cursor, Kilo Code, Cline, Codex CLI, GitHub Copilot CLI, Antigravity)
jdx mcp — MCP stdio server (typed jdx_* tools)
jdx batch — Many queries, one process (NDJSON in/out)
jdx bench [--iterations 3] — Benchmark the read path (timings + §15 targets)
jdx help [--agent] — This cheat sheet
refs: com.example.Outer#method(Type), Outer#method, 'Owner#m(Object)' (quote: # and () are shell-hostile)
exit codes: 0 ok · 1 not found · 2 ambiguous (retry with a listed candidate) · 3 usage · 4 no workspace · 5 artifact error · 6 internal
add --json to any command for the structured envelope (same information)

Real output — this example ran against the current jdx when the page was built.

Prefer typed tools? Run jdx mcp instead — see MCP tools.

View as Markdown · Updated