jdx ls

IDE equivalent: External library browser (packages/types)

List packages in the workspace ('com.google.*') with type counts; an exact package name ('com.google.gson') lists the types inside it. Exits 1 when nothing matches.

Usage#

jdx ls [<options>] [<packageglob>]

Example#

$ jdx ls com.google.gson.stream --coord com.google.code.gson:gson:2.14.0
types in package 'com.google.gson.stream'
  package com.google.gson.stream (7 types)
  class com.google.gson.stream.JsonReader  gson-2.14.0.jar
  class com.google.gson.stream.JsonReader$1  gson-2.14.0.jar
  class com.google.gson.stream.JsonScope  gson-2.14.0.jar
  enum com.google.gson.stream.JsonToken  gson-2.14.0.jar
  class com.google.gson.stream.JsonWriter  gson-2.14.0.jar
  class com.google.gson.stream.MalformedJsonException  gson-2.14.0.jar
  interface com.google.gson.stream.package-info  gson-2.14.0.jar
warning MULTI_RELEASE_VARIANT: multi-release gson-2.14.0.jar serves version-specific variants for this JDK (21)

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

Options#

Option	Description
`--limit=<int>`	Maximum rows shown (default 50); the rest become a truncation footer.
`--jars=<text>`	Binary roots: jar files, class directories or globs (repeatable). Merge in front of the selected workspace's roots.
`-w, --workspace=<text>`	Use a named workspace (see jdx ws). Explicit --jars merge in front of it.
`--no-jdk`	Do not include the running JDK's stdlib (included by default).
`--coord=<text>`	Maven coordinate root group:artifact:version (repeatable). Resolved from ~/.gradle/caches and ~/.m2 first; with --fetch, downloaded from Maven repositories into <cache-dir>/m2 with checksum verification. Merges in front of the workspace.
`--repo=<text>`	Maven repository base URL for --coord fetches (repeatable, e.g. --repo https://repo.example.com/maven2). Tried in flag order before Maven Central, which stays last as the fallback. Must be an http(s) URL.
`--fetch`	Allow downloading --coord artifacts (and their -sources.jar) from Maven repositories (Central by default, --repo to add mirrors). Without it, coordinates resolve from the local caches only.
`--json`	Emit machine-readable JSON instead of human-readable text (same information, D-007).
`--no-color`	Disable ANSI colors even on a TTY (piped output is always plain).
`--no-daemon`	Force in-process execution: do not forward this query to the background daemon even when its socket answers (PROPOSAL.md §14.1).
`-h, --help`	Show this message and exit

Arguments#

Argument	Description
`<packageglob>`	Package glob (default '*' — every package), or one exact package to list types for.

Full help text#

Show jdx ls --help

$ jdx ls --help
Usage: jdx ls [<options>] [<packageglob>]

  List packages in the workspace ('com.google.*') with type counts; an exact package name ('com.google.gson') lists the types inside it. Exits 1 when nothing matches.

Options:
  --limit=<int>           Maximum rows shown (default 50); the rest become a truncation footer.
  --jars=<text>           Binary roots: jar files, class directories or globs (repeatable). Merge in front of the selected workspace's roots.
  -w, --workspace=<text>  Use a named workspace (see jdx ws). Explicit --jars merge in front of it.
  --no-jdk                Do not include the running JDK's stdlib (included by default).
  --coord=<text>          Maven coordinate root group:artifact:version (repeatable). Resolved from ~/.gradle/caches and ~/.m2 first; with --fetch, downloaded from Maven repositories into <cache-dir>/m2 with checksum verification. Merges in front of the workspace.
  --repo=<text>           Maven repository base URL for --coord fetches (repeatable, e.g. --repo https://repo.example.com/maven2). Tried in flag order before Maven Central, which stays last as the fallback. Must be an http(s) URL.
  --fetch                 Allow downloading --coord artifacts (and their -sources.jar) from Maven repositories (Central by default, --repo to add mirrors). Without it, coordinates resolve from the local caches only.
  --json                  Emit machine-readable JSON instead of human-readable text (same information, D-007).
  --no-color              Disable ANSI colors even on a TTY (piped output is always plain).
  --no-daemon             Force in-process execution: do not forward this query to the background daemon even when its socket answers (PROPOSAL.md §14.1).
  -h, --help              Show this message and exit

Arguments:
  <packageglob>  Package glob (default '*' — every package), or one exact package to list types for.

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

Learn more#

Guide: Reading code · All commands