--- helpers ---

outputRetryReportText groups noteworthy requests by review stage. It renders only stable classes and status codes; raw provider errors stay out.

outputSARIF writes a SARIF v2.1.0 document to the provided writer. The document always contains a single run with the 8 built-in category rules, one r

resolveKeyCmd runs a credential-fetching shell command and returns its trimmed, single-line stdout. label names the source (e.g. `api_key_cmd for prov

retryReportFixture is the report used by most rendering assertions: one request recovered after two errors, one request that never succeeded, and a to

setColor pins the resolved color decision for one test and restores the previous state afterwards. Tests capture stdout through a pipe, which is not a

writeTempFile writes content to a temporary file and returns its path.

CommentsForPath returns a copy of comments whose Path matches the given path.

LoadDefault parses the embedded system_rules.json and resolves rule file references.

--- Factory --- NewLLMClient creates the appropriate client based on the resolved endpoint protocol. protocol dispatch (canonical names from protocol.

NewManifestBuilder creates a builder for a run identified by runID (the canonical session ID) and operation ("review" or "scan").

NewProvider creates a Provider that enumerates the repository at repoDir. If paths is non-empty each element must be a repo-relative path (file or dir

ParseDiffText splits the unified diff text into per-file Diff structs. ref, if non-empty, is a git ref used to read new-file content via git show inst

RecordReviewItemFailed persists an incomplete file-level checkpoint.

SetRunFailure records why the whole run stopped. It rejects an invalid class (so an unclassifiable stop is never silently downgraded) and a change of

beginAPIKeyReplace switches from the fixed-length mask placeholder to edit mode so the next keystroke or paste fully replaces the saved key. While edi

Default config file location: ~/.opencodereview/config.json

gitCommitFile writes a file and commits it, returning after the commit lands.

loadCommonContext validates the working directory, loads the embedded template, raises MaxToolRequestTimes when maxTools exceeds the default, resolves

matchConsecutive scans sideLines for a consecutive run matching all targetLines.

newCompareSession records one session with the given findings and returns it.

newFakeLLM returns a server that succeeds on the first attempt for every file. rateLimitOnce and hardFail are set by the caller before use.

resolveUsage parses raw JSON bytes into a map and extracts token usage by probing configured paths sequentially. Returns nil if no total_tokens found.

retryTestRepo builds a repo with one reviewable commit range (HEAD~1..HEAD), each file carrying its own marker in the second commit only. The file se

silenceStdout redirects os.Stdout to /dev/null for the duration of fn so the delegate commands' Printf output does not clutter test logs.

startFakeLLM starts srv and points the OCR_LLM_* endpoint resolution at it, with HOME/XDG_CONFIG_HOME redirected so the developer's real config and se

whyExcluded applies the filter algorithm as shouldReview but returns the specific reason a file is excluded.

AnyToAttr converts an arbitrary value to an OTel attribute.KeyValue.

Dynamic creates a Tool with the given name for dynamically discovered tools (e.g. MCP).

Enumerate returns one ScanItem per reviewable file. Binaries are emitted with empty Content + IsBinary=true so previews can show them as excluded.

PromptTokenLimit returns tokenWarningThreshold (80%) of maxTokens. It is shared by the agent and scan pre-flight gates, their large-input filters, and

ResolveInput freezes this run's commit endpoints by asking git, following the input-mode matrix: - range: base = merge-base(from,to); head = the

Restore re-enables stdout. Safe to call multiple times.

SetFinalManifest stores the frozen manifest the agent produced. It is embedded into session_end by Finalize and returned to the CLI via FinalManifest.

ValidateProtocol accepts the four canonical protocol names and rejects everything else.

executeGroupReviewFilter runs the REVIEW_FILTER_TASK for a file group. When from is non-nil, only comments at indices >= from[path] for each path are

expandBraces turns "{a,b,c}" style patterns into individual strings. e.g. "*.go.{java,kotlin}" → ["*.go.java", "*.go.kotlin"]. If no braces exist, ret

groupingSkipTemplate is a template whose GROUPING_TASK is configured, so that a test asserting client.called == false proves the fast path skipped the

recordWarning adds a non-fatal warning to the agent's warning list.

resolveWorkingDir returns (absPath, isGitRepo, err). When requireGit is true, returns an error if the directory is not a git repo. When false, returns

runCompression performs three-zone memory compression on the given messages, summarizing the compress zone while preserving the active zone intact. Re

useCompareRepo points the compare command at repoDir and restores the shared command flags afterwards.

writeConfig writes an OCR config file to a temp dir and returns its path.

ApplyLanguage injects a language directive into all system-role messages across MAIN_TASK, PLAN_TASK (if set), and MEMORY_COMPRESSION_TASK.

CanonicalPath returns an absolute path with symlinks resolved.

IsUserIncluded reports whether the given path matches any user include pattern. The check is case-insensitive: both path and pattern are lowercased. R

LoadDefault parses the embedded task_template.json and resolves prompt file references.

LoadScanDefault parses the embedded scan_template.json.

NewDiffMap creates a frozen, read-only DiffMap from a plain map.

RecordAttempt appends one observed HTTP attempt for m. startedAt and endedAt bracket the real HTTP call: the observer takes them immediately before a

RecordLLMResult sets the outcome of an LLM request on the span.

RecordUsage adds the prompt/completion/cache tokens reported by an LLM response to the runner's aggregate counters. Used by callers (plan phase in age

RegisterAll registers tools from the MCP client into the tool registry. When allowedTools is non-empty, only tools whose names appear in the list are

RequestMetaFromContext returns the RequestMeta attached to ctx, if any. It is exported so the packages that stamp identity — internal/llmloop and int

SealSelected closes the selected set. After it returns, RegisterSelected fails and the coverage denominator is fixed; per-item Mark* calls continue to

SetPendingFailureCause records the classification Finalize must use when it sweeps items that never received a Mark*. It records no run_failure and tr

Tool returns which tool this provider implements.

ValidateScanOptions verifies that the previous session was a full-file scan.

WithinBase reports whether target is base itself or contained under base.

freezeOne freezes c and returns the single listed request.

isolateLLMConnectionTest keeps the "Testing connection..." step that ends every apply*Config call away from the developer's own machine. Without it re

mapResponsesResponse converts the SDK Response into the shared ChatResponse. Text output is read via the SDK's OutputText() helper (it walks all outpu

newQuietHandle routes [ocr] progress lines away from stdout so they cannot corrupt a structured output document. What it does depends on why stdout ne