codeye / docs

Configuration

codeye runs with sensible defaults, but now supports layered configuration:

  1. Built-in defaults
  2. ~/.codeye.toml
  3. The nearest project .codeye.toml
  4. CODEYE_* environment variables
  5. CLI flags

Example .codeye.toml

format = "table"
sort = "code"
top = 12
lang = ["Go", "TypeScript"]
exclude = ["testdata/**", "*.snap"]
no_vendor = true
no_generated = true
workers = 8
theme = "mono"

Project config files are discovered by walking upward from the target directory. Use --config path/to/.codeye.toml to force a specific file.

Supported keys

KeyTypeNotes
branchstringDefault ref for scans
formatstringOutput format
sortstringSort field
topintegerMax rows
langarray or CSV stringLanguage filter
excludearray or CSV stringExclusion globs
path_filterarray or CSV stringInclusion globs
no_vendorbooleanExclude vendor-like directories
no_generatedbooleanExclude generated files
no_testsbooleanExclude common test patterns
min_linesintegerMinimum lines per language
no_colorbooleanDisable ANSI color
no_headerbooleanHide table header and footer
compactbooleanForce compact rendering
pctbooleanShow percentage column
themestringdark, light, mono
history_intervalstringday, week, month, quarter, year
history_limitintegerCommit limit for history and hotspots
cache_dirstringOverride cache location
workersintegerWorker pool size
verbosebooleanDebug logging

Environment variables

Common overrides:

VariableDescription
CODEYE_CONFIGExplicit config file path
CODEYE_FORMATDefault output format
CODEYE_WORKERSWorker pool size
CODEYE_CACHE_DIRCache directory override
CODEYE_NERD_FONTSSet to 1 or true to enable Nerd Font glyphs
CODEYE_NO_COLORDisable color output
NO_COLORStandard no-color override

Environment variables are read after config files and before CLI flags.

.codeyeignore

If the repository root contains .codeyeignore, its patterns are passed to git ls-files --exclude-from=.codeyeignore during git-backed scans.

vendor/
dist/
*.pb.go
testdata/

This is useful for persistent exclusions that should not live in every command invocation.