Skip to main content

Token-saving Java file reader for Claude Code. Summarizes Java files compactly using tree-sitter, saving 70-80% of input tokens.

Project description

jskim

PyPI version Python License

Token-saving Java file reader for Claude Code, optimized for Spring Boot. Summarizes Java files compactly using tree-sitter, saving 70-80% of input tokens compared to reading files directly.

A human counted the tokens. An AI counted the getters. Both decided life's too short.

Installation

pip install jskim

Requires Python 3.10+.

Usage

jskim auto-detects the mode based on whether you pass a file or directory.

Summarize a Java file

jskim <file.java>
jskim <file.java> --grep <pattern>        # filter methods by name/signature
jskim <file.java> --annotation <@Ann>     # filter methods by annotation
jskim A.java B.java C.java                # multiple files

Project map

Generates a compact map of all Java files in a directory: packages, classes, annotations, field/method counts, Lombok usage, enum constants.

jskim <src_dir>
jskim <src_dir> --deps                 # import-based dependencies
jskim <src_dir> --endpoints             # REST endpoint map
jskim <src_dir> --beans                 # Spring bean DI graph + @Bean producers + config properties
jskim <src_dir> --package <prefix>      # filter by package
jskim <src_dir> --annotation <@Ann>     # filter by class annotation
jskim <src_dir> --extends <ClassName>   # filter by superclass
jskim <src_dir> --implements <Name>     # filter by implemented interface

Spring Boot flags:

  • --endpoints — lists all REST endpoints: HTTP method, full path (base + method), handler, line number
  • --beans — shows bean DI wiring (via @Autowired and @RequiredArgsConstructor + final fields), @Bean factory method producers, and @ConfigurationProperties with prefix + field details
  • --implements — filter classes by implemented interface name

Diff mode

Summarizes only the Java files and methods changed in a git diff. Ideal for PR reviews.

jskim --diff HEAD~1                    # changes since last commit
jskim --diff main                      # changes vs main branch
jskim --diff main...feature-branch     # merge-base comparison
jskim src/ --diff HEAD~1               # scoped to directory
git diff main | jskim --diff -         # read diff from stdin

Output marks methods as [NEW], [MODIFIED], or [DELETED]. Getters/setters/boilerplate changes are suppressed.

Extract methods

jskim <file.java> --list                          # list all methods
jskim <file.java> <method_name>                    # extract one method
jskim <file.java> <method1> <method2> <method3>    # extract multiple

Method calls ()

Each method in the skim output shows its direct method invocations:

// methods:
//     L45-L62 ( 18 lines): @PostMapping public Bill createBill(BillDTO dto)
//                → auditLogger.log, billingService.create, notifyStakeholders, validator.validate
//     L64-L80 ( 17 lines): @GetMapping("/{id}") public Bill getBill(Long id)
//                → billingService.findById

Cross-reference the calls with the fields: section to trace call flow across files — if a method calls billingService.create, the fields show BillingService billingService, so skim BillingService.java next. Chained/fluent calls (streams, builders) are excluded to keep output compact.

Usage as a Claude Code Skill

This project is designed to be used as a Claude Code skill. The SKILL.md file configures the skill behavior, auto-triggering when working with Java files.

Install from the Vercel Skills Registry:

npx skills add garvit-joshi/jskim

Once installed, invoke with /jskim:

/jskim <file.java>              # summarize a file
/jskim <src_dir>                # project map
/jskim <file.java> <method>     # extract a method

Workflow

  1. Explorejskim src/ to understand project structure
  2. Narrowjskim src/ --package com.example.billing to focus on a package
  3. Spring contextjskim src/ --endpoints --beans to see REST API + DI wiring
  4. Understandjskim File.java to see class structure, fields, methods, and calls
  5. Trace — Follow calls by matching field types to find the next class to skim
  6. Filterjskim File.java --grep billing for large classes
  7. Focusjskim File.java methodA methodB to read specific methods
  8. Edit — Use Read with offset/limit on only the lines that matter

Dependencies

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jskim-0.2.1.tar.gz (66.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jskim-0.2.1-py3-none-any.whl (29.2 kB view details)

Uploaded Python 3

File details

Details for the file jskim-0.2.1.tar.gz.

File metadata

  • Download URL: jskim-0.2.1.tar.gz
  • Upload date:
  • Size: 66.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for jskim-0.2.1.tar.gz
Algorithm Hash digest
SHA256 08b51b6bed97c60754b84a7c1806619dbca64714d07a95227aabb9ab5732448f
MD5 b6f6ff9c9bb9d2105b51ce47d1d0c33e
BLAKE2b-256 f4e4a1b61663d47440b65e0f14f8bafd237ead3b3b3a96c5ba079e73e16dd71b

See more details on using hashes here.

Provenance

The following attestation bundles were made for jskim-0.2.1.tar.gz:

Publisher: publish.yml on garvit-joshi/jskim

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file jskim-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: jskim-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 29.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for jskim-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 818a0d6147476bc57d496f53817d1671c1014de44e3b786ed6a32d6027dbf741
MD5 7c0529005bf32e2365caa40572f22232
BLAKE2b-256 b6651f7523767b94dd8dbfabcd84443bb70f8a09946d9de8e2f6c5b06df915e3

See more details on using hashes here.

Provenance

The following attestation bundles were made for jskim-0.2.1-py3-none-any.whl:

Publisher: publish.yml on garvit-joshi/jskim

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page