Skip to content
/ skimmer Public

Codebase orientation agent for Claude Code — powered by rskim

License

Notifications You must be signed in to change notification settings

dean0x/skimmer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Skimmer

Codebase orientation agent for Claude Code — powered by rskim.

License: MIT

What it does

Skimmer is a Claude Code plugin that orients you in unfamiliar codebases. It uses rskim (tree-sitter) to extract code structure without implementation noise, then searches for task-relevant files and patterns. The result is a structured orientation report: project type, directory layout, relevant files, key functions, integration points, and a suggested approach.

Install

/plugin marketplace add dean0x/skimmer

Usage

# Orient for a specific task
/skim add JWT authentication

# General codebase orientation
/skim

With a task description, Skimmer focuses its search on files, functions, and patterns relevant to that task and suggests where to integrate.

Without arguments, it produces a general orientation: project type, directory structure, key modules, and entry points.

What you get

Skimmer generates a structured report:

Section Content
Project Type Language, framework, dependencies
Token Statistics Original vs skimmed token counts
Directory Structure Source directories and their purpose
Relevant Files Files matching the task with key exports
Key Functions/Types Specific signatures related to the task
Integration Points Where new code connects to existing code
Patterns Observed Existing conventions to follow
Suggested Approach Recommendation based on codebase structure

How it works

  1. Detect project type from manifest files (package.json, Cargo.toml, etc.)
  2. Map source directories and skim them with rskim --mode structure
  3. Search for task-relevant code using Grep/Glob, then skim matches with --mode signatures
  4. Identify integration points — entry points, public exports, configuration patterns
  5. Generate the orientation report

If rskim isn't available, the agent falls back to manual exploration using Glob, Grep, and Read.

Requirements

rskim is invoked via npx rskim (auto-downloads if not installed). Alternatives:

  • npm (global): npm install -g rskim
  • Cargo: cargo install rskim

No configuration needed — the agent handles tool detection and fallback automatically.

Links

License

MIT

Releases

No releases published

Packages

No packages published