supercode_harness/
lib.rs

1//! # Volter Harness
2//!
3//! A lightweight, fully-customizable AI coding-agent SDK in Rust.
4//!
5//! `supercode` is a native agent loop — it talks directly to any model through
6//! [OpenRouter](https://openrouter.ai) (or any other OpenAI-compatible endpoint),
7//! drives a configurable set of tools, and is designed to be a superset of what
8//! tools like Claude Code and Codex can do: every prompt, every tool description,
9//! and every tool's on/off state is yours to control.
10//!
11//! ## Quick start
12//!
13//! ```no_run
14//! use supercode_harness::{Agent, Config};
15//!
16//! # async fn run() -> supercode_harness::Result<()> {
17//! // Reads OPENROUTER_API_KEY from the environment by default.
18//! let config = Config::builder()
19//!     .model("anthropic/claude-opus-4-8")
20//!     .system_prompt("You are a terse, expert pair programmer.")
21//!     .build();
22//!
23//! let mut agent = Agent::new(config)?;
24//! let reply = agent.send("List the files in the current directory.").await?;
25//! println!("{reply}");
26//! # Ok(())
27//! # }
28//! ```
29//!
30//! ## Design
31//!
32//! - [`Config`] — the single knob box: model, endpoint, credentials, sampling,
33//!   the system prompt, and per-tool overrides (enable/disable + custom
34//!   descriptions).
35//! - [`Provider`] — the model transport. [`OpenAiProvider`] speaks the
36//!   OpenAI chat-completions wire format and defaults to OpenRouter, so it
37//!   reaches Claude, GPT, Gemini, Llama, and anything else OpenRouter exposes.
38//! - [`Tool`] / [`ToolRegistry`] — the capability surface. Built-ins cover
39//!   file read/write/edit, directory listing, glob, content search, and shell
40//!   execution. Register your own to extend it.
41//! - [`Agent`] — the loop that ties it together: it streams a turn, runs any
42//!   tool calls the model requests, feeds results back, and repeats until the
43//!   model produces a final answer.
44
45#![warn(missing_docs)]
46
47#[cfg(feature = "adapter-acp")]
48/// The supercode ontology (`docs/ONTOLOGY.md`): the one model under sessions and the
49/// orchestration.
50pub use supercode_interchange::ontology;
51/// The orchestration piece of the ontology: a harness's operational home as one typed value.
52pub use supercode_interchange::orchestration;
53
54#[cfg(feature = "adapter-acp")]
55pub mod acp_frontend;
56#[cfg(feature = "adapter-acp")]
57pub mod acp_server;
58mod agent;
59pub mod agent_package;
60pub mod approvals;
61pub mod audit;
62pub mod channels;
63pub mod checkpoint;
64pub mod claude_compat;
65pub mod claude_peer;
66pub mod claude_relay;
67pub mod claude_runtime_state;
68pub mod codex_peer;
69mod config;
70pub mod config_schema;
71pub mod configfile;
72pub mod context_injection;
73mod error;
74pub mod formatters;
75#[cfg(feature = "adapter-api")]
76pub mod frontend;
77#[cfg(not(feature = "adapter-api"))]
78#[allow(dead_code)]
79mod frontend;
80#[allow(missing_docs)]
81mod frontend_contract_generated;
82pub mod git_metadata;
83pub mod goals;
84pub mod harness_auth;
85pub mod harness_command;
86#[cfg(feature = "adapter-api")]
87pub mod harness_service;
88#[cfg(not(feature = "adapter-api"))]
89#[allow(dead_code)]
90mod harness_service;
91pub mod hermes_import;
92pub mod human_export;
93pub mod interop_settings;
94pub mod jobs;
95pub mod jobs_control;
96pub mod jobs_notepad;
97pub mod launch_agent;
98pub mod live_runtime;
99pub mod lsp;
100#[cfg(feature = "adapter-api")]
101pub mod mail_agent;
102#[cfg(feature = "adapter-api")]
103pub mod mail_file;
104#[cfg(feature = "adapter-api")]
105pub mod mail_mcp;
106pub mod mail_question;
107#[cfg(feature = "adapter-api")]
108pub mod mail_route;
109#[cfg(feature = "adapter-api")]
110pub mod mail_send;
111pub mod mail_transcript;
112#[cfg(feature = "adapter-api")]
113pub mod mail_watch;
114pub mod mailbox;
115pub mod mcp;
116pub mod mcp_oauth;
117pub mod memory;
118pub mod model_catalog;
119pub mod model_change;
120pub mod modules;
121mod native_materialize;
122pub mod orchestration_doors;
123pub mod orchestrator;
124pub mod orchestrator_door;
125pub mod output_style;
126pub mod parity;
127pub mod path_rules;
128pub mod permissions;
129pub mod plugins;
130pub mod presets;
131pub mod pricing;
132pub mod pricing_ref;
133pub mod profiles;
134pub mod profiles_control;
135mod provider;
136pub mod reduce;
137#[cfg(feature = "adapter-api")]
138pub mod relay_endpoint;
139mod residue_store;
140pub mod routes;
141pub mod runs;
142pub mod runtime;
143pub mod runtime_lease;
144#[cfg(feature = "adapter-api")]
145pub mod runtime_mail;
146#[cfg(feature = "adapter-api")]
147pub mod runtime_registry;
148mod safe_path;
149pub mod sandbox;
150pub mod schema;
151pub mod sdk;
152#[cfg(feature = "adapter-api")]
153pub mod server;
154#[cfg(not(feature = "adapter-api"))]
155#[allow(dead_code, unused_imports)]
156mod server;
157pub mod session_activity;
158pub mod session_index;
159pub mod session_journal;
160pub mod session_title;
161pub mod sessions_control;
162pub mod skills;
163pub mod skills_control;
164pub mod slow_log;
165pub mod startup_prompts;
166pub mod store;
167pub mod subagents;
168pub mod support;
169pub mod teams;
170pub mod tools;
171pub mod triggers;
172pub mod trust;
173pub mod tui;
174pub mod turn_record;
175pub mod usage_log;
176pub mod workflow_doors;
177
178#[cfg(feature = "adapter-acp")]
179pub use acp_frontend::{AcpFrontendCheckpoint, AcpFrontendConnectOptions, AcpFrontendRuntime};
180pub use agent::{Agent, ContextUsage};
181pub use approvals::{
182    approval_harnesses, lists_approvals, plan_reply, ApprovalChoice, ApprovalDecision,
183    ApprovalDoor, ApprovalKind, ApprovalOption, ApprovalRegistry, ApprovalResolution,
184    ApprovalResolveError, ApprovalRow, ApprovalStatus, ApprovalsQuery, ApprovalsResolveParams,
185};
186pub use channels::{
187    channel_status, list_channels, ChannelError, ChannelRow, ChannelStatus, CHANNELS_SCHEMA,
188    CHANNEL_HARNESSES,
189};
190pub use claude_peer::{
191    read_claude_peer_settings, read_registry as read_claude_peer_registry, resolve_live_session,
192    update_claude_peer_settings, user_settings_path as claude_user_settings_path,
193    write_claude_peer_settings, ClaudeCrossSessionInbound, ClaudePeerRefusal,
194    ClaudePeerRefusalError, ClaudePeerSession, ClaudePeerSettings, ClaudePeerSettingsError,
195    ClaudePeerStatus,
196};
197pub use claude_runtime_state::{
198    ClaudeBackgroundChild, ClaudeBackgroundState, ClaudeCronJob, ClaudeQueueState,
199    ClaudeRuntimeManifest, ClaudeRuntimePosture, ClaudeRuntimeResidue, ClaudeWakeup,
200    CLAUDE_RUNTIME_MANIFEST_VERSION,
201};
202pub use config::{
203    project_root_for, ApprovalPolicy, CachePlan, Config, ConfigBuilder, ConfigFile, ConfigProfile,
204    ContextInjectionBlock, HookDecision, LifecycleEvent, LifecycleHook, PreToolOutcome,
205    SteeringMode, StopGateHook, ToolAdvertising, ToolOverride, ToolOverrideProfile,
206    DEFAULT_SYSTEM_PROMPT,
207};
208pub use configfile::HarnessConfig;
209pub use interop_settings::{
210    configure_harness_interop_settings, inspect_harness_interop_settings, HarnessAdvisorySeverity,
211    HarnessInteropAdvisory, HarnessInteropControl, HarnessInteropSettingsError,
212    HarnessInteropSettingsReport, HarnessSettingChange, HarnessSettingChoice,
213    HarnessSettingRecommendation, HarnessSettingScope, CLAUDE_CROSS_SESSION_INBOUND_KEY,
214    HARNESS_INTEROP_SETTINGS_SCHEMA,
215};
216pub use jobs::{
217    get_job, list_jobs, supports_jobs, JobDeliver, JobPayload, JobSchedule, JobScope, JobSource,
218    JobsListing, JobsQuery, ScheduledJob, CLAUDE_SESSION_SCAN_LIMIT, JOB_HARNESSES,
219};
220pub use jobs_control::{
221    harness_program, mutate, supports_job_control, JobControlError, JobDeliverSpec, JobMutation,
222    JobMutationOutcome, JobPayloadSpec, JobScheduleSpec, JobVerb, CONTROLLED_JOB_HARNESSES,
223};
224pub use jobs_notepad::{JobNotepad, JobNotepadEntry, JobNotepadRequest};
225pub use live_runtime::{
226    discover_live_runtime, find_live_runtime, forget_live_runtime, list_live_runtimes,
227    register_live_runtime, register_live_runtime_with_metadata, resolve_live_runtime,
228    LiveRuntimeEndpoint, LiveRuntimeMetadata, LiveRuntimeReceiptError, LiveRuntimeRecord,
229    LiveRuntimeRegistration, LiveRuntimeSource, LiveRuntimeSupervisor, ResolvedLiveRuntime,
230};
231pub use memory::{
232    search_memory, show_memory, supports_memory, MemoryDocument, MemoryError, MemoryMatch,
233    MemoryQuery, MemoryScope, MemorySearchQuery, MEMORY_HARNESSES, MEMORY_SCHEMA,
234};
235pub use modules::{ModuleActivation, ModuleId};
236pub use orchestrator::{
237    clear_lease, daemon_entry, install_service, live_lease, lock_path, read_lease, resolve_program,
238    service_name, service_status, service_unit, uninstall_service, write_lease, write_unit, Lease,
239    OrchestratorError, ServiceState, ServiceUnit, DAEMON_ENTRY, LOCK_FILE, SERVICE_DIR,
240    SERVICE_NAME,
241};
242pub use orchestrator_door::{
243    daemon_is_live, socket_path, Door, DoorAnswer, DoorError, NODE_BIN_ENV, SOCKET_FILE,
244};
245pub use profiles::{
246    get_profile, list_profiles, ProfileError, ProfileKind, ProfileRow, HERMES_DEFAULT_PROFILE,
247    PROFILES_SCHEMA, PROFILE_HARNESSES,
248};
249pub use profiles_control::{
250    supports_profile_control, ProfileControlError, ProfileMutation, ProfileMutationOutcome,
251    ProfileVerb, CONTROLLED_PROFILE_HARNESSES,
252};
253pub use routes::{list_routes, RouteError, RouteMatch, RouteRow, ROUTES_SCHEMA, ROUTE_HARNESSES};
254pub use runs::{
255    get_run, list_runs, supports_runs, HarnessRun, RunDelivery, RunSource, RunsListing, RunsQuery,
256    RUN_HARNESSES,
257};
258pub use sessions_control::{
259    controlled_verbs, supports_session_control, SessionControlError, SessionDoor, SessionMutation,
260    SessionMutationOutcome, SessionVerb, CONTROLLED_SESSION_HARNESSES,
261};
262pub use supercode_interchange::catalog::{
263    orchestrator_profile_dirs, DiscoveryPage, DiscoveryQuery, HarnessCatalog, HarnessHomes,
264    HarnessId, SessionDescriptor, SessionLocator, StorageLocator,
265};
266pub use teams::{
267    connector_service_binary as teams_connector_service_binary,
268    connector_service_name as teams_connector_service_name,
269    connector_service_status as teams_connector_service_status,
270    connector_service_unit as teams_connector_service_unit,
271    install_connector_service as install_teams_connector_service,
272    install_service as install_teams_service, service_status as teams_service_status,
273    service_unit as teams_service_unit, teams_entry, teams_home,
274    uninstall_connector_service as uninstall_teams_connector_service,
275    uninstall_service as uninstall_teams_service, write_unit as write_teams_unit, TeamsError,
276    SERVICE_DIR as TEAMS_SERVICE_DIR, SERVICE_NAME as TEAMS_SERVICE_NAME, TEAMS_ENTRY,
277    TEAMS_PACKAGE,
278};
279pub use triggers::{
280    list_triggers, TriggerError, TriggerKind, TriggerRow, TRIGGERS_SCHEMA, TRIGGER_HARNESSES,
281};
282
283/// Format an agent's final reply for output. `json` wraps it as
284/// `{"result": "..."}`; otherwise the reply is returned as-is. The
285/// stream-json form is the live [`AgentEvent`] stream via an [`EventSink`].
286pub fn format_reply(reply: &str, json: bool) -> String {
287    if json {
288        serde_json::json!({ "result": reply }).to_string()
289    } else {
290        reply.to_string()
291    }
292}
293pub use error::{Error, Result};
294#[cfg(feature = "adapter-api")]
295pub use frontend::HttpFrontendRuntime;
296pub use frontend::{
297    FrontendActions, FrontendApprovalDecision, FrontendAttachSnapshot, FrontendAttachment,
298    FrontendCommandDescriptor, FrontendConnectionState, FrontendDisplayCapabilities,
299    FrontendElicitationAction, FrontendEvent, FrontendOperationDescriptor,
300    FrontendOperationInvocation, FrontendOperationKind, FrontendOperationResult, FrontendRequest,
301    FrontendRequestKind, FrontendResponse, FrontendRuntime, FrontendRuntimeDescriptor,
302    FrontendRuntimeError, FrontendRuntimeMetadata, FrontendTurnState, FRONTEND_REPLAY_CAPACITY,
303    FRONTEND_RUNTIME_SCHEMA_VERSION,
304};
305pub use frontend_contract_generated::{
306    FrontendFacadeMethod, FrontendFacadeTransport, GeneratedFrontendClient,
307};
308pub use harness_auth::{
309    harness_authentication_methods, harness_authentication_plan, inspect_harness_authentication,
310    HarnessAuthenticationEnvironment, HarnessAuthenticationError, HarnessAuthenticationInteraction,
311    HarnessAuthenticationLaunch, HarnessAuthenticationMethod, HarnessAuthenticationMethodId,
312    HarnessAuthenticationPlan, HarnessAuthenticationReport, HarnessAuthenticationState,
313    HarnessBrowserBehavior, HARNESS_AUTHENTICATION_SCHEMA,
314};
315pub use harness_service::{
316    DetachedAnswer, DetachedCall, HarnessSessionService, OpenedRuntime, ReturnedRuntime,
317    RuntimeOpen, DETACHED_CALL_DEADLINE, DETACHED_METHODS, HARNESS_SERVICE_VERSION,
318    RUNTIME_CONTROL_DEADLINE, RUNTIME_EVENT_METHOD, RUNTIME_OPEN_DEADLINE, RUNTIME_OPEN_METHODS,
319    SESSION_ACTIVITY_EVENT_METHOD, SESSION_DISCOVER_DEADLINE, SESSION_EVENT_METHOD,
320    SESSION_INDEX_EVENT_METHOD,
321};
322pub use provider::{
323    model_context_limit, ChatRequest, OpenAiProvider, PromptTokensDetails, Provider, RetryLog,
324    RetryNotice, ToolSchema, Usage, SERVED_MODEL_KEY, UNKNOWN_MODEL_CONTEXT_FLOOR,
325};
326#[cfg(feature = "adapter-api")]
327pub use runtime::SupercodeHttpRuntimeBackend;
328pub use runtime::{
329    AcpRuntimeBackend, BearerToken, ClaudeCodeRuntimeBackend, CodexRuntimeBackend, HarnessEvent,
330    McpServerLaunch, OpenCodeRuntimeBackend, PiRuntimeBackend, ResolvedRuntimeConnection,
331    RuntimeAttachRequest, RuntimeBackend, RuntimeCapabilities, RuntimeConnectLaunch,
332    RuntimeConnection, RuntimeEndpoint, RuntimeHandle, RuntimeInput, RuntimeLaunch,
333    RuntimeStartRequest,
334};
335pub use runtime_lease::{
336    CoordinatedRuntime, CoordinatedRuntimeClient, RuntimeAuthorization, RuntimeClientId,
337    RuntimeControllerLease, RuntimeLeaseCoordinator, RuntimeLeaseError, RuntimeLeaseSnapshot,
338    RuntimeObserverLease, RuntimePermission, DEFAULT_RUNTIME_LEASE_TTL_MS,
339};
340#[cfg(feature = "adapter-api")]
341pub use runtime_registry::{
342    LocalRuntimeRegistry, RuntimeRegistryEntry, RuntimeRegistryEvent, RuntimeRegistryOwner,
343    RuntimeRegistryQuery, RuntimeRegistryState, RuntimeRegistryWatch,
344};
345pub use sandbox::{landlock_available, netns_available, SandboxEnvPolicy, SandboxEscalation};
346pub use sdk::{
347    create_agent, discover_session_page, discover_sessions, load_session, load_session_path,
348    resume_agent, show_model_input, submit_agent, submit_agent_with_images, RuntimeSubmitError,
349    SdkAgent, SdkCapabilities, SdkError, SdkErrorCode, SdkEvent, SdkOperation, SdkPromptSource,
350    SdkRequest, SdkRuntime, SdkRuntimeEvent, SdkService, SDK_SCHEMA_VERSION,
351};
352pub use server::RpcEngine;
353pub use session_activity::{
354    SessionActivity, SessionActivityEvidence, SessionPresence, SessionTurnState,
355};
356pub use session_index::{SessionIndexChange, SessionIndexDelta, SessionIndexKey};
357pub use skills::{
358    declared_skill_name, list_skills, skill_roots, writable_skill_roots, SkillHomes, SkillRow,
359    SkillScope, SkillsQuery, SKILL_HARNESSES,
360};
361pub use skills_control::{
362    mutate_skill, supports_skill_control, SkillControlError, SkillMutation, SkillMutationOutcome,
363    SkillVerb, CONTROLLED_SKILL_HARNESSES,
364};
365pub use store::{SessionInfo, SessionStore};
366pub use supercode_interchange::session::{
367    CrossSurface, OrchestrationNouns, Recurrence, Session, SessionFormat, SessionMeta,
368    SessionSource, SurfaceKey, Trigger, WorkspaceKind, WorkspaceRef,
369};
370pub use supercode_interchange::watch::{SessionFollower, SessionSnapshotReason, SessionWatchEvent};
371pub use supercode_interchange::{
372    core_messages, measure_fidelity, messages_equal, messages_equal_multimodal, replay_eligible,
373    Fidelity, FidelityMetric, FidelityResidue,
374};
375pub use supercode_interchange::{
376    is_tool_error, mark_tool_error, mark_tool_outcome_unknown, tool_outcome, ChatMessage,
377    FunctionCall, Role, ToolCall, ToolOutcome, TOOL_ERROR_METADATA_KEY,
378    TOOL_OUTCOME_UNKNOWN_METADATA_KEY,
379};
380pub use supercode_runtime::{AgentEvent, EventSink};
381pub use support::{
382    harness_support, harness_support_registry, HarnessSupportDescriptor, ImplementationKind,
383    NativeSupport, RuntimeSupport, SupportRegistryReport, SUPPORT_REGISTRY_SCHEMA,
384};
385pub use tools::{
386    shell_sandbox_unenforceable, SandboxPolicy, SchemaTier, Tool, ToolContext, ToolRegistry,
387    WriteObserver,
388};
389
390/// The checkout this binary was built from, when it runs as a build of it. An installed binary (one inside a
391/// `node_modules`, where npm and a local install place it) never reads it: on the machine that built it the checkout
392/// still exists, and its source tree would resolve its packages against whatever `node_modules` sits above it.
393pub fn build_checkout() -> Option<std::path::PathBuf> {
394    let exe = std::env::current_exe().ok()?;
395    if exe
396        .ancestors()
397        .any(|dir| dir.file_name().is_some_and(|name| name == "node_modules"))
398    {
399        return None;
400    }
401    std::path::Path::new(env!("CARGO_MANIFEST_DIR"))
402        .ancestors()
403        .nth(2)
404        .map(std::path::Path::to_path_buf)
405}
supercode_harness/lib.rs

supercode_harness/
lib.rs
