ksrc
CLI for searching/reading Kotlin dependency sources from a Gradle project. Use when you need to locate/inspect 3rd-party Gradle libraries.
When & Why to Use This Skill
ksrc is a specialized CLI tool designed for Kotlin and Gradle developers to efficiently search, locate, and inspect 3rd-party dependency source code. By providing direct terminal access to library internals, it eliminates the friction of manual source downloads and IDE context switching, making it an essential utility for deep-dive debugging and architectural exploration within the JVM and Kotlin Multiplatform ecosystems.
Use Cases
- Debugging 3rd-Party Library Issues: Quickly search for specific error messages or class names within external dependencies to understand the root cause of bugs occurring outside your local codebase.
- Exploring Library Implementations: Use the 'cat' and 'search' commands to read the internal logic of Kotlin or Java libraries, helping developers understand undocumented APIs or complex implementation details.
- Kotlin Multiplatform (KMP) Development: Filter and inspect source code across different targets (e.g., JVM, Android, iOS) to verify platform-specific behavior and ensure cross-platform consistency.
- Dependency Auditing and Troubleshooting: Use 'ksrc doctor' and 'ksrc deps' to diagnose Gradle resolution failures, verify source availability, and audit the dependency tree of large-scale modular applications.
| name | ksrc |
|---|---|
| description | CLI for searching/reading Kotlin dependency sources from a Gradle project. Use when you need to locate/inspect 3rd-party Gradle libraries. |
How to use:
Note: Give this tool generous timeouts. It can take a few minutes to download sources if needed and set up gradle.
- Search dependencies to retrieve coordinates and matches:
ksrc search "class LocalDate"
If you want faster execution & less noise, consider adding:
--artifactto limit search to one artifact, (or--moduleto also limit by version)--subprojectto help discovery for monorepos/large modular apps--targetsto limit to specific KMP targets.
- Read a file by returned id:
ksrc cat org.jetbrains.kotlinx:kotlinx-datetime:0.6.1!/kotlinx/datetime/LocalDate.kt --lines 1,200
Common issues
- If, unexpectedly, no matches are found, try
cding into a relevant project (if in composite build), specifying a scope--scope(esp. for build-time deps), orksrc doctor. E_NO_SOURCES: dependency sources not available; tryksrc deps,ksrc fetch <coord>, specify a project and scope.- Gradle not found: run in a Gradle project or set
--projectto the root. - Gradle resolution failures:
ksrcfalls back to cache-only resolution and warns; re-run with-vto see Gradle output for debugging. - Gradle files with unresolved class version: User's Local java in env is resolved to something unsupported by gradle. Help them fix Gradle<>JDK incompatibility.
- Ambiguous modules: use
--module,--group, or--artifactto narrow scope.
Commands
ksrc search <pattern> [-- <rg-args>]
Search dependency sources.
Output format: <file-id> <line>:<col>:<match>
Common flags:
--allsearch across all resolved deps (default when no selector is provided)--project <path>project root (default.)--subproject <name>limit to a subproject (repeatable)--targets <list>limit KMP targets (comma‑separated:jvm,android,iosX64)--config <name>resolve specific configuration(s) (comma‑separated)--scope <compile|runtime|test|all>--module <glob>module filter (group:artifact[:version])--group <glob>/--artifact <glob>/--version <glob>--offlineonly use cached sources--refreshforce dependency refresh--context <n>shortcut forrg -C <n>(context lines emit column0)--rg-args <args>extra rg args (comma‑separated)-- <rg-args>pass through raw rg args--show-extracted-pathinclude temp extracted paths in output (off by default)
ksrc cat <file-id|path>
Print file contents.
Common flags:
--lines <start,end>1‑based inclusive range--module <glob>/--group/--artifact/--versionto disambiguate when using a path
ksrc open <file-id|path>
Open in $PAGER (defaults to less -R). Same flags as cat.
ksrc deps
List resolved dependencies and source availability.
ksrc resolve
Resolve and print source JARs: group:artifact:version|/path/to/sources.jar.
ksrc fetch <coord>
Ensure sources for a coordinate exist: group:artifact:version.
ksrc where <path|coord>
Locate cached source JAR or file.
ksrc doctor
Basic diagnostics for environment issues.
File-id format
group:artifact:version!/path/inside/jar.kt