Complete Command Reference

Every command srcnav provides for AI code navigation.

index

Build or rebuild the index for a codebase.

Usage

srcnav index -p /path/to/project srcnav index -p . --force

Example Output

Building: Indexing /path/to/project...
Found 4435 files (max: 50000)
Parsed 61583 items in 4.13s
Parsed 7024 imports in 2.70s
Done: 61583 items, 7024 imports indexed in 7.97s

status

Show index status for a project.

Usage

srcnav status -p /path/to/project

Example Output

Status: Index found at "/path/.srcnav-cpp.db"
  Items: 27000

stats

Show codebase statistics. Available in human-readable or JSON format.

Usage

srcnav stats -p /path/to/project srcnav stats -p /path/to/project --json

Example Output

==================================================
Stats for: /path/to/project
==================================================
  3925 files, 61583 items

By Kind:
  constant             33992
  function             11916
  variable             6050
  method               5702
  class                1771
  arrowfunction        1578
  typealias            430
  interface            122
  enum                 22

By Visibility:
  private              56395
  export               5188

find

Find items by name pattern (regex supported). Filter by kind and visibility.

Usage

srcnav find "function_name" -p /path srcnav find "av.*open.*" -p /path srcnav find ".*" -p /path --kind function srcnav find ".*" -p /path --kind struct srcnav find ".*" -p /path --visibility public srcnav find "func" -p /path --limit 10 srcnav find "func" -p /path --json srcnav find "func" -p /path -c srcnav find "func" -p /path --brief

Example Output

private function createElement [/workspaces/DEVELOPMENT-2/3rdparty/react/packages/react/src/jsx/ReactJSXElement.js:610:8]
private function createElementsInspectPanel [/workspaces/DEVELOPMENT-2/3rdparty/react/packages/react-devtools-extensions/src/main/index.js:294:1]

5 items found (43ms)

query search

Search files by name pattern.

Usage

srcnav query search "avcodec" -p /path srcnav query search "avcodec" -p /path --summary srcnav query search "avcodec" -p /path --limit 1-20

Example Output

Found 23 files in 12ms
src/auth/login.ts
src/auth/middleware.ts
src/api/auth-guard.ts

query context

Get all symbols defined in a file.

Usage

srcnav query context "libavcodec/avcodec.h" -p /path srcnav query context "avcodec.h" -p /path --kind function srcnav query context "avcodec.h" -p /path --summary

Example Output

Total: 296 items
By Kind: 137 constant, 48 function, 46 struct, 41 enum...
By Visibility: 296 default

formatDate (function) — line 12
formatCurrency (function) — line 28

query imports-of

Find files that include/import a given file.

Usage

srcnav query imports-of "libavcodec/avcodec.h" -p /path srcnav query imports-of "avcodec.h" -p /path --limit 1-20

Example Output

Found 47 files that import avcodec.h
src decoder/decoder.cpp
src encoder/encoder.cpp
src utils/format.cpp

query dependencies-of

Find files that a given file includes/imports.

Usage

srcnav query dependencies-of "main.cpp" -p /path srcnav query dependencies-of "main.cpp" -p /path --limit 1-20

Example Output

15 files depend on this file
src/components/Price.tsx
src/services/billing.ts

query path

Find include/import path between two files.

Usage

srcnav query path "libavcodec/avcodec.h" "libavformat/avformat.h" -p /path srcnav query path "a.h" "b.h" -p /path --format mermaid srcnav query path "a.h" "b.h" -p /path --format dot

Example Output

Include path from avcodec.h to avformat.h:
avcodec.h -> common.h -> utils.h -> avformat.h

analyze context

Show symbol and surrounding context from the same file.

Usage

srcnav analyze context "avcodec_open2" -p /path

Example Output

Symbol: avcodec_open2 (function)
File: libavcodec/utils.c:234

Context:
int avcodec_open2(AVCodecContext *ctx, const AVCodec *codec, AVDictionary **options) {
    // function implementation...
}

analyze deps

Show type dependencies (upstream/downstream).

Usage

srcnav analyze deps "AVCodecContext" -p /path

Example Output

Type: AVCodecContext
Upstream dependencies:
  - AVCodec (type)
  - AVDictionary (type)
Downstream dependencies:
  - DecoderContext (type)
  - EncoderContext (type)
Most Powerful

analyze impact

Trace downstream impact of a symbol across multiple levels. This is critical for AI agents to know what will break before modifying code.

Usage

srcnav analyze impact "AVCodecContext" -p /path srcnav analyze impact "AVCodecContext" -p /path --summary srcnav analyze impact "AVCodecContext" -p /path -d 1 srcnav analyze impact "AVCodecContext" -p /path --kind function srcnav analyze impact "AVCodecContext" -p /path -d 1 --limit 1-20

Example Output

Total downstream: 375,443 items
Level 1: 334 items
Level 2: 332 items
Level 3: 14,937 items

Level 1 (direct users):
  decoder.c:45 - decode_frame (function)
  encoder.c:32 - encode_frame (function)
  ...

batch

Run multiple queries in parallel for efficiency.

Usage

srcnav batch find "func1" "func2" "func3" -p /path srcnav batch search "term1" "term2" -p /path

Example Output

[func1] Found 12 items in 23ms
[func2] Found 5 items in 18ms
[func3] Found 8 items in 21ms

Output Formats

All commands support multiple output formats for AI consumption.

--json
Structured JSON data for programmatic use
-c
Compact: fn:name@file:line
--brief
Brief: KIND name file:line
--names-only
Just symbol names
--format mermaid
Mermaid diagram for visualization
--format dot
Graphviz DOT format

Limit Range Syntax

The --limit flag accepts three formats:

Number
--limit 10
First 10 items (1-10)
Range
--limit 1-50
Items 1-50
Open range
--limit 51-
51 to end

Supported Languages

PythonPython
RustRust
GoGo
JavaJava
CC
C++C++
TypeScriptTypeScript
JavaScriptJavaScript

Get Started with srcnav

Open source CLI. Better code navigation for AI agents.

Request Access