config

package
v0.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 4, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package config is the single inventory of environment variables the code-graph binary reads.

Every key the product honours is declared here once, with its default and a one-line description. Call sites read through Get/IsSet/Truthy so the name, the parsing convention, and the documentation stay together; a test in this package fails when a key is undocumented in README.md or CLAUDE.md, and another fails when production code reads a product key with os.Getenv directly.

Values are read live from the process environment on each call. That keeps the existing behaviour (tests flip variables with t.Setenv, and the embeddings mode is decided once at startup by mutating the environment) while still giving the process one place to log the resolved configuration.

Index

Constants

This section is empty.

Variables

View Source 
var (
	VoyageAPIKey = Key{Name: "VOYAGE_API_KEY", Default: "unset", Doc: "Enables the Voyage embedding provider (auto-selected when set)", Secret: true}
	VoyageModel  = Key{Name: "VOYAGE_EMBED_MODEL", Default: "built-in", Doc: "Voyage embedding model id"}

	// OpenAI-compatible embedding provider: OpenAI itself, Azure OpenAI,
	// Gemini's OpenAI surface, Ollama, vLLM, LM Studio, OpenRouter, or any
	// gateway that serves POST {base}/embeddings.
	EmbedProvider   = Key{Name: "CODE_GRAPH_EMBED_PROVIDER", Default: "auto", Doc: "Embedding provider: auto (voyage when VOYAGE_API_KEY is set, else openai when CODE_GRAPH_EMBED_BASE_URL is set, else off), voyage, openai, or off"}
	EmbedBaseURL    = Key{Name: "CODE_GRAPH_EMBED_BASE_URL", Default: "https://api.openai.com/v1 for openai", Doc: "Base URL of an OpenAI-compatible embeddings API; setting it auto-selects the openai provider"}
	EmbedAPIKey     = Key{Name: "CODE_GRAPH_EMBED_API_KEY", Default: "OPENAI_API_KEY", Doc: "Credential for the OpenAI-compatible provider; optional for self-hosted endpoints", Secret: true}
	OpenAIAPIKey    = Key{Name: "OPENAI_API_KEY", Default: "unset", Doc: "Fallback credential for the openai embedding provider when CODE_GRAPH_EMBED_API_KEY is unset", Secret: true}
	EmbedModel      = Key{Name: "CODE_GRAPH_EMBED_MODEL", Default: "unset", Doc: "Embedding model id sent to the OpenAI-compatible provider (required for openai)"}
	EmbedDimension  = Key{Name: "CODE_GRAPH_EMBED_DIMENSION", Default: "unset", Doc: "Expected vector width from the OpenAI-compatible provider; every returned vector must match"}
	EmbedAuthHeader = Key{Name: "CODE_GRAPH_EMBED_AUTH_HEADER", Default: "bearer", Doc: "How the credential is sent: bearer (Authorization: Bearer) or api-key (Azure OpenAI's api-key header)"}

	AnthropicAPIKey = Key{Name: "ANTHROPIC_API_KEY", Default: "unset", Doc: "Used only by code_localize_agent and rationale tools", Secret: true}
	AnthropicModel  = Key{Name: "ANTHROPIC_MODEL", Default: "built-in", Doc: "Anthropic model id for the localization agent"}
)

Cloud providers.

View Source 
var (
	SkipEmbeddings       = Key{Name: "CODE_GRAPH_SKIP_EMBEDDINGS", Default: "auto", Doc: "1 forces embedding passes off, 0 forces them on; auto follows the resolved embedding provider"}
	EmbeddingsTimeoutSec = Key{Name: "CODE_GRAPH_EMBEDDINGS_TIMEOUT_SEC", Default: "built-in", Doc: "Overall timeout for the embeddings pass"}
	CacheDir             = Key{Name: "CODE_GRAPH_CACHE_DIR", Default: "~/.cache/code-graph", Doc: "Directory holding per-project SQLite databases"}
	LogFile              = Key{Name: "CODE_GRAPH_LOG_FILE", Default: "unset", Doc: "Tee structured logs to this file"}
	LogFileOnly          = Key{Name: "CODE_GRAPH_LOG_FILE_ONLY", Default: "unset", Doc: "Redirect structured logs to this file instead of stderr"}
	HeapLimitMB          = Key{Name: "CODE_GRAPH_HEAP_LIMIT_MB", Default: "off", Doc: "Abort indexing when Go heap-in-use exceeds this many MB"}
	FullReindexEvery     = Key{Name: "CODE_GRAPH_FULL_REINDEX_EVERY", Default: "50", Doc: "Force a full reindex after this many incremental runs; 0 disables"}
	IncrementalCap       = Key{Name: "CODE_GRAPH_INCREMENTAL_CAP", Default: "10000", Doc: "Cap on dependent-set expansion during incremental indexing"}
	AutoRecovery         = Key{Name: "CODE_GRAPH_AUTO_RECOVERY", Default: "unset", Doc: "Set to enable automatic recovery of corrupted project databases"}
	MatchTrace           = Key{Name: "CODE_GRAPH_MATCH_TRACE", Default: "off", Doc: "Log HTTP route matches that scored below threshold"}
	ServiceMap           = Key{Name: "CODE_GRAPH_SERVICE_MAP", Default: "~/.config/code-graph/service_map.json", Doc: "JSON domain-to-pattern table used by service_map and diff_services"}
	NixServiceOptionPfx  = Key{Name: "CODE_GRAPH_NIX_SERVICE_OPTION_PREFIX", Default: "services", Doc: "Option-set prefix for Nix service extraction"}
	UpdateChannel        = Key{Name: "CODE_GRAPH_UPDATE_CHANNEL", Default: "stable", Doc: "stable follows GitHub's latest non-prerelease; rc also considers vX.Y.Z-rc.N prereleases"}
	Toolset              = Key{Name: "CODE_GRAPH_TOOLSET", Default: "core", Doc: "Which tools the MCP server advertises: core (the plugin, benchmark, and everyday set) or full (every registered tool)"}
	NixPkgsPrefix        = Key{Name: "CODE_GRAPH_NIX_PKGS_PREFIX", Default: "pkgs", Doc: "Package-set prefix for Nix RUNS_BINARY detection"}
)

Runtime and storage.

View Source 
var (
	SimilarityEdges    = Key{Name: "ENABLE_SIMILARITY_EDGES", Default: "off", Doc: "1/true/yes/on enables SEMANTICALLY_SIMILAR_TO edges after embeddings"}
	SimilarityThresh   = Key{Name: "CODE_GRAPH_SIMILARITY_THRESHOLD", Default: "built-in", Doc: "Minimum cosine similarity for a similarity edge (0-1]"}
	SimilarityTopK     = Key{Name: "CODE_GRAPH_SIMILARITY_TOPK", Default: "built-in", Doc: "Neighbours considered per node for similarity edges"}
	SimilaritySkipHops = Key{Name: "CODE_GRAPH_SIMILARITY_SKIP_HOPS", Default: "built-in", Doc: "Skip pairs already within this many structural hops"}
	SeedMinCosine      = Key{Name: "EMBEDDING_SEED_MIN_COSINE", Default: "0.0", Doc: "Minimum cosine similarity for embedding seeds in ranking"}
)

Semantic similarity edges (embedding-backed, opt-in).

View Source 
var (
	MaxFileBytes         = Key{Name: "CBM_MAX_FILE_BYTES", Default: "1048576", Doc: "Per-file size cutoff for discovery; 0 disables"}
	SCIPIndexPath        = Key{Name: "CBM_SCIP_INDEX_PATH", Default: "unset", Doc: "Legacy: path to a SCIP index to ingest"}
	SCIPAutoDiscover     = Key{Name: "CBM_SCIP_AUTO_DISCOVER", Default: "off", Doc: "Legacy: auto-discover a SCIP index in the repository"}
	GrammarBaselinesPath = Key{Name: "CBM_GRAMMAR_BASELINES_PATH", Default: "embedded", Doc: "Override the grammar version baseline file used by index_health"}

	ResolverTier2Debug          = Key{Name: "RESOLVER_TIER2_DEBUG", Default: "off", Doc: "Log one line per tier-2 resolver decision"}
	ResolverStaticDispatchDebug = Key{Name: "RESOLVER_STATIC_DISPATCH_DEBUG", Default: "off", Doc: "Log static-dispatch resolution decisions (Rust)"}
	ResolverDropFuzzyJanusian   = Key{Name: "RESOLVER_DROP_FUZZY_JANUSIAN_CHAINS", Default: "python-only", Doc: "1/true/yes forces dropping fuzzy chain resolutions for all languages; 0/false/no disables"}
	ResolverDropLooseCrossPkg   = Key{Name: "RESOLVER_DROP_LOOSE_CROSS_PACKAGE", Default: "emit", Doc: "Drop loose cross-package resolutions instead of emitting them"}
	ResolverRequireImports      = Key{Name: "RESOLVER_REQUIRE_IMPORTS_FOR_LOOSE_CROSS_PACKAGE", Default: "language-specific", Doc: "Require an import binding before emitting loose cross-package edges"}
	ResolverEnumVariantParent   = Key{Name: "RESOLVER_EMIT_ENUM_VARIANT_AS_PARENT", Default: "off", Doc: "Resolve unknown enum variants to the enum node"}
)

Extraction and resolution.

View Source 
var (
	LocAgentIterations    = Key{Name: "LOCAGENT_ITERATIONS", Default: "2", Doc: "Agent iterations aggregated by MRR (1-3)"}
	LocAgentParallel      = Key{Name: "LOCAGENT_PARALLEL", Default: "off", Doc: "1 runs iterations concurrently"}
	LocAgentPromptVariant = Key{Name: "LOCAGENT_PROMPT_VARIANT", Default: "open", Doc: "open or aggressive system prompt"}
	LocAgentMaxTurns      = Key{Name: "LOCAGENT_MAX_TURNS", Default: "20", Doc: "Hard cap on agent turns"}
	LocAgentRewrite       = Key{Name: "LOCAGENT_REWRITE", Default: "off", Doc: "1 enables the issue-rewrite pre-step"}
	LocAgentBFSDepth      = Key{Name: "LOCAGENT_BFS_DEPTH", Default: "4", Doc: "BFS depth for code_localize inside the agent loop"}
	LocAgentEpisodic      = Key{Name: "LOCAGENT_EPISODIC_MEMORY", Default: "off", Doc: "1 enables episodic-memory retrieval before localization"}
	LocAgentEpisodicProj  = Key{Name: "LOCAGENT_EPISODIC_PROJECT", Default: "built-in", Doc: "Project holding episodic memory"}
	LocAgentEpisodicTopK  = Key{Name: "LOCAGENT_EPISODIC_TOP_K", Default: "built-in", Doc: "Episodic hits retrieved per issue"}
)

Localization agent.

Functions

func Get 

func Get(k Key) string

Get returns the raw value of k from the process environment ("" when unset).

func IsSet 

func IsSet(k Key) bool

IsSet reports whether k is present with a non-empty value.

func LogResolved 

func LogResolved(logger *slog.Logger)

LogResolved emits one debug line per key that is set, so a support log shows the effective configuration without exposing secrets.

func Truthy 

func Truthy(k Key) bool

Truthy reports whether k is set to one of 1, true, yes, or on (case-insensitive, surrounding whitespace ignored).

Types

type Key 

type Key struct {
	// Name is the exact environment variable name.
	Name string
	// Default describes the effective value when the variable is unset. It is
	// documentation, not a value that Get returns.
	Default string
	// Doc is a one-line description used by Snapshot and the docs test.
	Doc string
	// Secret marks credentials whose values must never be logged.
	Secret bool
}

Key describes one environment variable.

func All 

func All() []Key

All returns every declared key, sorted by name.

type Resolved 

type Resolved struct {
	Name  string
	Value string
	Set   bool
}

Resolved is one key with its current value, redacted when secret.

func Snapshot 

func Snapshot() []Resolved

Snapshot returns the current value of every key, redacting secrets to "<set>". Unset keys report Set=false and Value="".

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.