funcfinder

module

v1.10.1 Latest Latest Go to latest Published: Jul 18, 2026 License: MIT

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ruslano69/funcfinder

Links

Open Source Insights

README ¶

funcfinder

Map codebases, extract functions, trace calls — 99% fewer tokens than reading files.

./build.sh && ./funcfinder --dir . --all --json > map.json

Why

Without funcfinder	With funcfinder
AI reads full files (expensive)	Map once, extract targeted
grep + ctags + manual work	One binary, 15 languages, zero setup
80% budget on exploration	99% token reduction

Installation

# Build from source
git clone https://github.com/ruslano69/funcfinder.git
cd funcfinder && ./build.sh

Produces 7 binaries: funcfinder, stat, deps, callgraph, complexity, docsearch, docsearch-server.

Tools

Tool	Purpose
`funcfinder`	Map functions & types, extract bodies, shard large codebases
`callgraph`	Forward/reverse call graph
`deps`	Import dependencies + inter-shard graph
`stat`	Call frequency & hotspots
`complexity`	Cognitive complexity per function
`docsearch`	Knowledge base: SQLite FTS5 + vector hybrid search
`docsearch-server`	Versioned truth server: releases/channels, hybrid search, MCP, TCP/HTTP read-servers

Languages

C, C++, Go, Rust, D, Java, Kotlin, Scala, JavaScript, TypeScript, PHP, Python, Ruby, Swift, C#

Quick Start

# Map entire codebase
./funcfinder --dir . --all --json > map.json

# Find function
./funcfinder --inp internal/finder.go --source go --func FindFunctions --extract

# Call graph
./callgraph --dir . -l go --reverse --func ProcessDirectory

# Large project: split into shards
./funcfinder --dir . --all --json --split        # creates .codemap/
cat .codemap/manifest.json                        # 2KB overview
./funcfinder --dir . --all --json --split --inc   # incremental update

Architecture

cmd/            CLI entrypoints (thin wrappers)
internal/       Parser engine: finders, sanitizer, formatter, shard logic
languages.json  15 language patterns (embedded)

Parser uses a state-machine sanitizer (not regex) to correctly handle Go raw strings, Python docstrings, C# verbatim literals, nested comments — at 763K lines/sec.

DOX — Agent Documentation

This project uses the DOX framework: a hierarchy of AGENTS.md files that gives AI agents precise, token-efficient context without loading the full repository.

How it works

AGENTS.md               ← root: tools overview, workflows, DOX rules
├── cmd/AGENTS.md       ← CLI entrypoints, flag conventions
├── internal/AGENTS.md  ← parser API, how to add languages
├── docs/AGENTS.md      ← documentation rules
├── examples/AGENTS.md  ← example scripts
├── skills/AGENTS.md    ← Claude Code skill definition
├── test_examples/AGENTS.md  ← test fixture rules
└── test_files/AGENTS.md     ← edge-case sanitizer fixtures

Rules for agents

Before editing any file, read the chain from root to the target directory:

AGENTS.md → <subdirectory>/AGENTS.md

After any meaningful change, update the nearest AGENTS.md that owns the changed path. Keep the Child DOX Index in each file accurate.

Adding documentation

When a folder gains its own stable purpose, contracts, or workflow — create <folder>/AGENTS.md with sections: Purpose · Ownership · Local Contracts · Work Guidance · Verification · Child DOX Index. Then add it to the parent's index.

Documentation

AGENTS.md — agent quick reference + DOX framework
docs/CI_CD.md — CI/CD pipeline
docs/WINDOWS.md — Windows build guide
CHANGELOG.md — version history

License

MIT — see LICENSE

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
analyze Package analyze is funcfinder's public API for programmatic code mapping: walk a source tree and get per-file function/type boundaries, using the same engine the funcfinder CLI runs.	Package analyze is funcfinder's public API for programmatic code mapping: walk a source tree and get per-file function/type boundaries, using the same engine the funcfinder CLI runs.
benchmarks
searchserver command searchserver — a real-async Go FTS5 search server + load harness.	searchserver — a real-async Go FTS5 search server + load harness.
cmd
astoracle command astoracle — ground-truth symbol extractor for Go, built on go/ast.	astoracle — ground-truth symbol extractor for Go, built on go/ast.
benchmark command
callgraph command callgraph - function call relationship analyzer	callgraph - function call relationship analyzer
complexity command complexity.go - Nesting Depth Complexity Analyzer Analyzes code complexity based on NESTING DEPTH, not decision point count Philosophy: Deep nesting is harder to understand than flat code with many branches	complexity.go - Nesting Depth Complexity Analyzer Analyzes code complexity based on NESTING DEPTH, not decision point count Philosophy: Deep nesting is harder to understand than flat code with many branches
deps command deps.go - Module dependency analyzer Uses shared configuration for multiple languages	deps.go - Module dependency analyzer Uses shared configuration for multiple languages
docsearch command
docsearch-server command docsearch-server — the release-aware truth server CLI (see docs/docsearch-server/TZ.md).	docsearch-server — the release-aware truth server CLI (see docs/docsearch-server/TZ.md).
funcfinder command
stat command stat.go - Unified function call counter for multiple languages Counts function calls in source files using shared configuration	stat.go - Unified function call counter for multiple languages Counts function calls in source files using shared configuration
internal config.go - Unified language configuration Loads and manages language patterns for funcfinder, stat, deps, complexity, and findstruct	config.go - Unified language configuration Loads and manages language patterns for funcfinder, stat, deps, complexity, and findstruct
codemap Package codemap implements TZ FR-22 ("funcfinder as a code → truth compiler"): baking a deterministic structural map of a source tree (functions and types per file) into a docsearch-server release at publish time.	Package codemap implements TZ FR-22 ("funcfinder as a code → truth compiler"): baking a deterministic structural map of a source tree (functions and types per file) into a docsearch-server release at publish time.
embed Package embed is an optional, provider-agnostic embedding client for docsearch-server.	Package embed is an optional, provider-agnostic embedding client for docsearch-server.
knowledge
truth Package truth implements the release/channel backbone of docsearch-server (see docs/docsearch-server/TZ.md §7.1, §7.3, §8).	Package truth implements the release/channel backbone of docsearch-server (see docs/docsearch-server/TZ.md §7.1, §7.3, §8).
test_files