Expand description
Coding-workload primitives for governed agents.
This module is an SDK layer for applications that build coding agents on
top of the harness runtime. It provides root-relative workspace paths,
local workspace operations, typed effect payloads, command execution,
git inspection, repository search, project instruction resolution, and
context gathering. It is not a CLI product, and it does not bypass the
harness: production file, patch, command, git, or search side effects
should be represented as EffectRequest values
and executed through a Harness.
Structs§
- Agent
Change Tracker - Tracks files changed by the agent layer.
- Apply
Patch Payload - Typed payload for applying a structured patch.
- Apply
Patch Tool - Model-visible adapter that requests a governed structured patch.
- CliGit
Inspector - Git inspector implemented by invoking read-only git commands.
- Coding
Context Bundle - Context bundle returned by a
CodingContextProvider. - Coding
Context Include - Flags controlling which context sources are gathered.
- Coding
Context Request - Coding context request.
- Coding
Effect Executor - Effect executor that routes typed coding payloads to coding primitives.
- Coding
Executor Config - Configuration for
CodingEffectExecutor. - Coding
Policy Engine - Conservative coding policy wrapper around a host policy engine.
- Coding
Policy Input - Typed input produced for coding policy evaluation.
- Command
Executor Capabilities - Executor capability report.
- Command
Executor Identity - Executor identity included in capability and execution reports.
- Command
Output - Command output.
- Command
Output Limit - Per-stream output limit.
- Command
Pattern - Prefix pattern used by
CommandTaxonomyallowlists. - Command
Payload - Typed payload for command execution.
- Command
Request - Command execution request.
- Command
Taxonomy - Command taxonomy and host-provided allowlists for coding policy.
- Command
Test Runner - Test runner backed by a
CommandExecutor. - Content
Digest - Stable content digest used in file version preconditions.
- Context
Budget - Context budget for repository context gathering.
- Default
Coding Context Provider - Baseline context provider that combines workspace, search, git, and instruction primitives.
- Default
Instruction Resolver - Default resolver that searches for
AGENTS.md-style files from root to target parent directories. - Dependency
Metadata - Dependency manifest metadata discovered by context gathering.
- Diff
Request - Request to diff two snapshots.
- File
Content - File content returned by a workspace read.
- File
Patch - Patch for one file.
- File
Read Options - Options for workspace file reads.
- File
Version - File version used to detect stale writes and patch conflicts.
- File
Write Result - Result of a successful workspace write.
- GitChanged
File - Changed git file.
- GitChanged
Files Request - Changed-files request.
- GitDiff
Request - Git diff request.
- GitHead
- Current git head.
- GitPayload
- Typed payload for read-only git inspection.
- GitStatus
- Parsed git status.
- GitStatus
Request - Git status request.
- GitStatus
Tool - Model-visible adapter that requests read-only git status.
- Instruction
Bundle - Resolved project instructions.
- Instruction
File - One resolved instruction file.
- Instruction
File Spec - Instruction file candidate.
- Instruction
Request - Instruction resolution request.
- List
Files Payload - Typed payload for listing workspace files.
- List
Files Query - Query for deterministic workspace listing.
- List
Files Tool - Model-visible adapter that requests a governed workspace listing.
- Local
Command Executor - Local non-PTY, one-shot command executor backed by host process spawning.
- Local
Workspace - Local filesystem implementation of
Workspace. - Local
Workspace Config - Local filesystem workspace configuration.
- Output
Text - Text output with truncation metadata.
- Patch
- Structured patch containing one or more file patches.
- Patch
Conflict - Patch conflict with model-safe details.
- Patch
Hunk - Text hunk used by the local workspace patch applier.
- Patch
Request - Request to apply or dry-run a patch.
- Patch
Result - Result from applying or dry-running a patch.
- Policy
Enforcement Report - Report describing which policies were enforced by the command executor.
- Read
File Payload - Typed payload for reading a workspace file.
- Read
File Tool - Model-visible adapter that requests a governed workspace file read.
- Repo
Search Request - Repository search request.
- Repo
Search Results - Repository search results.
- Resolved
Path - Resolved workspace path with canonicalization metadata.
- Ripgrep
Searcher - Repository searcher that invokes
rgthrough aCommandExecutor. - RunCommand
Tool - Model-visible adapter that requests governed command execution.
- Search
Match - One repository search match.
- Search
Payload - Typed payload for repository search.
- Search
Repo Tool - Model-visible adapter that requests governed repository search.
- Snapshot
Request - Request for a lightweight workspace snapshot.
- Test
RunRequest - Test run request.
- Verification
Result - Structured verification result.
- Workspace
Diff - Workspace diff summary.
- Workspace
Entry - Workspace entry returned by listing.
- Workspace
Path - A root-relative path validated for workspace operations.
- Workspace
Root - Canonical root directory that bounds workspace filesystem access.
- Workspace
Searcher - In-process fallback searcher based on
Workspacereads. - Workspace
Snapshot - Lightweight snapshot of file versions.
- Write
File Payload - Typed payload for writing a workspace file.
- Write
File Request - Request to write a workspace file.
Enums§
- Coding
Context Error - Coding context errors.
- Coding
Error - Errors returned by typed coding payload adapters and executor routing.
- Coding
Policy Class - Coding-specific operation class used by conservative policy presets.
- Command
Error - Command execution errors.
- Command
Executor Backend - Command executor backend family.
- Command
Status - Terminal command status.
- EnvPolicy
- Environment variable handling for command execution.
- File
Body - File body with text and binary separated explicitly.
- File
Write Content - Content to write into a workspace file.
- GitError
- Git inspection errors.
- GitOperation
- Read-only git operation for typed git effects.
- Instruction
Error - Instruction resolver errors.
- Patch
Operation - File patch operation.
- Policy
Capability Mode - How strictly policy/capability mismatches are handled.
- Policy
Enforcement Status - Structured enforcement status for a policy dimension.
- PtyMode
- PTY mode requested for a command.
- Resolved
Path Kind - Filesystem kind observed when resolving a workspace path.
- Search
Error - Search errors.
- Search
Mode - Repository search mode.
- Symlink
Policy - Symlink behavior for local workspace operations.
- Test
RunError - Test run errors.
- Text
Encoding - Encoding of text file content.
- Workspace
Access - Requested workspace access mode.
- Workspace
Error - Workspace operation errors.
Traits§
- Coding
Context Provider - Provides repository context outside chat memory.
- Command
Executor - Executes approved command requests.
- GitInspector
- Read-only git inspector.
- Instruction
Resolver - Resolves project instruction files.
- Repo
Searcher - Search implementation for repositories.
- Test
Runner - Convenience adapter for test commands.
- Workspace
- Workspace abstraction for coding workloads.
Functions§
- validate_
command_ capabilities - Validates that executor capabilities can satisfy a command policy before execution starts.
- validate_
policy_ enforcement_ report - Validates that an executor’s post-run report matches requested policy and declared capabilities.