codeeagle

Files (1)

• SKILL.md

SKILL.md (first lines)

# CodeEagle — Codebase Intelligence

Use CodeEagle to understand the codebase without reading source files directly.
Pick the right command based on what you need:

## Decision Matrix

| Need | Command |
|------|---------|
| Function signatures, types in a file | `codeeagle query symbols --file <path>` |
| Interface definition + implementors | `codeeagle query interface --name <name>` |
| Function call graph (who calls what) | `codeeagle query edges --node <name> --type Calls` |
| What a function depends on | `codeeagle query edges --node <name> --type Calls --direction out` |
| Who calls a function | `codeeagle query edges --node <name> --type Calls --direction in` |
| Cross-service API dependencies | `codeeagle query edges --node <name> --type Consumes` |
| Import-to-manifest dep tracing | `codeeagle query edges --node <name> --type DependsOn` |
| Service endpoints | `codeeagle query edges --node <name> --type Exposes` |
| Test coverage for a file/function | `codeeagle query edges --node <name> --type Tests` |
| All relationships for a symbol | `codeeagle query edges --node <name>` |
| Search nodes by type/name/package | `codeeagle query --type X --name Y` |
| Find unused functions/methods | `codeeagle query unused` |
| Test coverage report by file/function | `codeeagle query coverage [--level function]` |
| Semantic search ("find code that does X") | `codeeagle rag "<query>"` |
| Find code by meaning, not exact name | `codeeagle rag "<query>" --type Function` |
| Impact analysis ("what breaks if I change X?") | `codeeagle agent plan "<question>"` |
| Design patterns, API consistency | `codeeagle agent design "<question>"` |
| General "how does X work?" questions | `codeeagle agent ask "<question>"` |

## Node Types

`File`, `TestFile`, `Package`, `Service`, `Function`, `TestFunction`, `Method`, `Struct`, `Class`,
`Interface`, `Enum`, `Variable`, `Constant`, `Type`, `Module`, `Dependency`, `APIEndpoint`,
`Document`, `Directory`, `Topic`, `Person`, `DTO`, `AIGuideline`, `DBModel`, `DomainModel`, `ViewModel`

## Edge Types

| Edge | Meaning | Example |
|------|---------|---------|
| `Calls` | Function/method calls another | `extract() -> extractImports()` |
| `Contains` | Parent contains child | `Service -> File -> Function` |
| `Imports` | File/package imports dependency | `parser.go -> go/ast` |
| `DependsOn` | Dependency relationship | import node -> manifest dep, service -> service |
| `Implements` | Type implements interface | `GoParser -> Parser` (Go structural, Java/TS/C# nominal, Python Protocol) |
| `Tests` | Test covers source | `parser_test.go -> parser.go`, `TestParseFile -> ParseFile` |
| `Exposes` | Service exposes endpoint | `backend -> GET /api/users` |
| `Consumes` | API call targets endpoint | `fetch /api/users -> GET /api/users` |
| `Documents` | Doc describes code entity | `README -> Service` |
| `HasTopic` | Document has extracted topic | `CHANGELOG.txt -> authentication` |
| `AppearsIn` | Person appears in image | `Dad -> photo.jpg` |

## Structured Queries (fast, machine-friendly)

### List symbols in a file
```
codeeagle query symbols --file <path>
```
Returns all functions, structs, interfaces, methods with signatures, line numbers,
and export status. **Use this instead of reading a source file.**

### Find interface definitions and implementors
```
codeeagle query interface --name <name>
codeeagle query interface --name "Store"
```
Returns the interface location, signature, and all types that implement it.

### Show edges for a symbol
```
codeeagle query edges --node <name-or-id>
codeeagle query edges --node "RunAll" --type Calls
codeeagle query edges --node "RunAll" --type Calls --direction out
```
Returns all incoming/outgoing relationships for a node. Filter by `--type` and `--direction`.

### Trace function call chains
```
codeeagle query edges --node "extractFunctionCalls" --type Calls --direction out
codeeagle query edges --node "extractFunctionCalls" --type Calls --direction in
```
Outgoing = what this function calls. Incoming = who calls this function.

### Trace import to manifest dependency
```
codeeagle query edges --node "github.com/dgraph-io/badger/v4" --type DependsOn
```
Shows import -> manifest dep links (kind=import_to_manifest).

### Find API endpoints and their callers
```
codeeagle query --type APIEndpoint
codeeagle query edges --node "GET /api/users" --type Consumes --direction in
```

### Find unused code
```
codeeagle query unused
codeeagle query unused --type Function --language go
codeeagle query unused --include-exported --package mypackage
```
Finds functions/methods with no incoming Calls edges. Test functions, `init()`, and `main()` are excluded.
By default excludes exported functions (they may be called externally). Use `--include-exported` to include them.

### Show test coverage
```
codeeagle query coverage
codeeagle query coverage --level function
codeeagle query coverage --language go --package parser
```
Reports which files (default) or functions have test coverage via EdgeTests edges.
Shows per-package coverage percentages.

### General node search
```
codeeagle query --type Function --name "New*" --package embedded
codeeagle query --type Struct --language go
codeeagle query --type Dependency --name "axios"
codeeagle query --type Service
codeeagle query --type TestFile
codeeagle query --type TestFunction --language rust

From imyousuf/CodeEagle, Apache-2.0.

More from imyousuf/CodeEagle