supercode_harness/
lib.rs

1//! # supercode
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 background;
63pub mod browser;
64pub mod catalog;
65pub mod channels;
66pub mod checkpoint;
67pub mod claude_compat;
68pub mod claude_peer;
69pub mod claude_runtime_state;
70pub mod codex_peer;
71mod config;
72pub mod config_schema;
73pub mod configfile;
74pub mod context_injection;
75mod error;
76mod event;
77pub mod fidelity;
78pub mod formatters;
79#[cfg(feature = "adapter-api")]
80pub mod frontend;
81#[cfg(not(feature = "adapter-api"))]
82#[allow(dead_code)]
83mod frontend;
84#[allow(missing_docs)]
85mod frontend_contract_generated;
86pub mod git_metadata;
87pub mod goals;
88pub mod harness_auth;
89pub mod harness_command;
90#[cfg(feature = "adapter-api")]
91pub mod harness_service;
92#[cfg(not(feature = "adapter-api"))]
93#[allow(dead_code)]
94mod harness_service;
95pub mod hermes_import;
96pub mod human_export;
97pub mod interop_settings;
98pub mod jobs;
99pub mod jobs_apply;
100pub mod jobs_control;
101pub mod jobs_notepad;
102pub mod live_runtime;
103pub mod lsp;
104pub mod mcp;
105pub mod mcp_oauth;
106pub mod memory;
107mod message;
108pub mod model_catalog;
109pub mod model_change;
110pub mod model_route;
111pub mod modules;
112pub mod orchestration_doors;
113pub mod orchestrator;
114pub mod orchestrator_door;
115pub mod output_style;
116pub mod parity;
117pub mod path_rules;
118pub mod permissions;
119pub mod plugins;
120pub mod presets;
121pub mod pricing;
122pub mod pricing_ref;
123pub mod profiles;
124pub mod profiles_control;
125mod provider;
126pub mod reduce;
127pub mod routes;
128pub mod runs;
129pub mod runtime;
130pub mod runtime_lease;
131#[cfg(feature = "adapter-api")]
132pub mod runtime_registry;
133mod safe_path;
134pub mod sandbox;
135pub mod schema;
136pub mod sdk;
137#[cfg(feature = "adapter-api")]
138pub mod server;
139#[cfg(not(feature = "adapter-api"))]
140#[allow(dead_code, unused_imports)]
141mod server;
142pub mod session;
143pub mod session_activity;
144pub mod session_index;
145pub mod session_journal;
146pub mod session_title;
147pub mod session_tree;
148pub mod sessions_control;
149pub mod sidecar;
150pub mod skills;
151pub mod skills_control;
152pub mod store;
153pub mod subagents;
154pub mod support;
155pub mod teams;
156pub mod tokens;
157pub mod tools;
158pub mod triggers;
159pub mod trust;
160pub mod tui;
161pub mod turn_record;
162pub mod usage_log;
163pub mod watch;
164pub mod workflow_doors;
165
166#[cfg(feature = "adapter-acp")]
167pub use acp_frontend::{AcpFrontendCheckpoint, AcpFrontendConnectOptions, AcpFrontendRuntime};
168pub use agent::{Agent, ContextUsage};
169pub use approvals::{
170    approval_harnesses, lists_approvals, plan_reply, ApprovalChoice, ApprovalDecision,
171    ApprovalDoor, ApprovalKind, ApprovalOption, ApprovalRegistry, ApprovalResolution,
172    ApprovalResolveError, ApprovalRow, ApprovalStatus, ApprovalsQuery, ApprovalsResolveParams,
173};
174pub use catalog::{
175    orchestrator_profile_dirs, DiscoveryPage, DiscoveryQuery, HarnessCatalog, HarnessHomes,
176    HarnessId, SessionDescriptor, SessionLocator, StorageLocator,
177};
178pub use channels::{
179    channel_status, list_channels, ChannelError, ChannelRow, ChannelStatus, CHANNELS_SCHEMA,
180    CHANNEL_HARNESSES,
181};
182pub use claude_peer::{
183    message_claude_peer, read_claude_peer_settings, read_registry as read_claude_peer_registry,
184    update_claude_peer_settings, user_settings_path as claude_user_settings_path,
185    write_claude_peer_settings, ClaudeCrossSessionInbound, ClaudePeerDelivery, ClaudePeerEndpoint,
186    ClaudePeerRefusal, ClaudePeerRefusalError, ClaudePeerSession, ClaudePeerSettings,
187    ClaudePeerSettingsError, ClaudePeerStatus, CourierRunner, ProcessCourierRunner,
188};
189pub use claude_runtime_state::{
190    ClaudeBackgroundChild, ClaudeBackgroundState, ClaudeCronJob, ClaudeQueueState,
191    ClaudeRuntimeManifest, ClaudeRuntimePosture, ClaudeRuntimeResidue, ClaudeWakeup,
192    CLAUDE_RUNTIME_MANIFEST_VERSION,
193};
194pub use config::{
195    project_root_for, ApprovalPolicy, CachePlan, Config, ConfigBuilder, ConfigFile, ConfigProfile,
196    ContextInjectionBlock, HookDecision, LifecycleEvent, LifecycleHook, PreToolOutcome,
197    SteeringMode, StopGateHook, ToolAdvertising, ToolOverride, ToolOverrideProfile,
198    DEFAULT_SYSTEM_PROMPT,
199};
200pub use configfile::HarnessConfig;
201pub use interop_settings::{
202    configure_harness_interop_settings, inspect_harness_interop_settings, HarnessAdvisorySeverity,
203    HarnessInteropAdvisory, HarnessInteropControl, HarnessInteropSettingsError,
204    HarnessInteropSettingsReport, HarnessSettingChange, HarnessSettingChoice,
205    HarnessSettingRecommendation, HarnessSettingScope, CLAUDE_CROSS_SESSION_INBOUND_KEY,
206    HARNESS_INTEROP_SETTINGS_SCHEMA,
207};
208pub use jobs::{
209    get_job, list_jobs, supports_jobs, JobDeliver, JobPayload, JobSchedule, JobScope, JobSource,
210    JobsListing, JobsQuery, ScheduledJob, CLAUDE_SESSION_SCAN_LIMIT, JOB_HARNESSES,
211};
212pub use jobs_apply::{AppliedJob, JobSpec, JobsApply, JobsApplyOutcome};
213pub use jobs_control::{
214    harness_program, mutate, supports_job_control, JobControlError, JobDeliverSpec, JobMutation,
215    JobMutationOutcome, JobPayloadSpec, JobScheduleSpec, JobVerb, CONTROLLED_JOB_HARNESSES,
216};
217pub use jobs_notepad::{JobNotepad, JobNotepadEntry, JobNotepadRequest};
218pub use live_runtime::{
219    discover_live_runtime, find_live_runtime, forget_live_runtime, list_live_runtimes,
220    register_live_runtime, register_live_runtime_with_metadata, resolve_live_runtime,
221    LiveRuntimeEndpoint, LiveRuntimeMetadata, LiveRuntimeReceiptError, LiveRuntimeRecord,
222    LiveRuntimeRegistration, LiveRuntimeSource, LiveRuntimeSupervisor, ResolvedLiveRuntime,
223};
224pub use memory::{
225    search_memory, show_memory, supports_memory, MemoryDocument, MemoryError, MemoryMatch,
226    MemoryQuery, MemoryScope, MemorySearchQuery, MEMORY_HARNESSES, MEMORY_SCHEMA,
227};
228pub use model_route::{ModelRouteApply, ModelRouteOutcome};
229pub use modules::{ModuleActivation, ModuleId};
230pub use orchestrator::{
231    clear_lease, daemon_entry, install_service, live_lease, lock_path, read_lease, service_status,
232    service_unit, uninstall_service, write_lease, write_unit, Lease, OrchestratorError,
233    ServiceState, ServiceUnit, DAEMON_ENTRY, LOCK_FILE, SERVICE_DIR, SERVICE_NAME,
234};
235pub use orchestrator_door::{
236    daemon_is_live, socket_path, Door, DoorAnswer, DoorError, NODE_BIN_ENV, SOCKET_FILE,
237};
238pub use profiles::{
239    get_profile, list_profiles, ProfileError, ProfileKind, ProfileRow, HERMES_DEFAULT_PROFILE,
240    PROFILES_SCHEMA, PROFILE_HARNESSES,
241};
242pub use profiles_control::{
243    supports_profile_control, ProfileControlError, ProfileMutation, ProfileMutationOutcome,
244    ProfileVerb, CONTROLLED_PROFILE_HARNESSES,
245};
246pub use routes::{list_routes, RouteError, RouteMatch, RouteRow, ROUTES_SCHEMA, ROUTE_HARNESSES};
247pub use runs::{
248    get_run, list_runs, supports_runs, HarnessRun, RunDelivery, RunSource, RunsListing, RunsQuery,
249    RUN_HARNESSES,
250};
251pub use sessions_control::{
252    controlled_verbs, supports_session_control, SessionControlError, SessionDoor, SessionMutation,
253    SessionMutationOutcome, SessionVerb, CONTROLLED_SESSION_HARNESSES,
254};
255pub use teams::{
256    install_service as install_teams_service, service_status as teams_service_status,
257    service_unit as teams_service_unit, teams_entry, teams_home,
258    uninstall_service as uninstall_teams_service, write_unit as write_teams_unit, TeamsError,
259    SERVICE_DIR as TEAMS_SERVICE_DIR, SERVICE_NAME as TEAMS_SERVICE_NAME, TEAMS_ENTRY,
260};
261pub use triggers::{
262    list_triggers, TriggerError, TriggerKind, TriggerRow, TRIGGERS_SCHEMA, TRIGGER_HARNESSES,
263};
264
265/// Format an agent's final reply for output. `json` wraps it as
266/// `{"result": "..."}`; otherwise the reply is returned as-is. The
267/// stream-json form is the live [`AgentEvent`] stream via an [`EventSink`].
268pub fn format_reply(reply: &str, json: bool) -> String {
269    if json {
270        serde_json::json!({ "result": reply }).to_string()
271    } else {
272        reply.to_string()
273    }
274}
275pub use error::{Error, Result};
276pub use event::{AgentEvent, EventSink};
277pub use fidelity::{
278    core_messages, measure_fidelity, messages_equal, messages_equal_multimodal, replay_eligible,
279    Fidelity, FidelityMetric, FidelityResidue,
280};
281#[cfg(feature = "adapter-api")]
282pub use frontend::HttpFrontendRuntime;
283pub use frontend::{
284    FrontendActions, FrontendApprovalDecision, FrontendAttachSnapshot, FrontendAttachment,
285    FrontendCommandDescriptor, FrontendConnectionState, FrontendDisplayCapabilities,
286    FrontendElicitationAction, FrontendEvent, FrontendOperationDescriptor,
287    FrontendOperationInvocation, FrontendOperationKind, FrontendOperationResult, FrontendRequest,
288    FrontendRequestKind, FrontendResponse, FrontendRuntime, FrontendRuntimeDescriptor,
289    FrontendRuntimeError, FrontendRuntimeMetadata, FrontendTurnState, FRONTEND_REPLAY_CAPACITY,
290    FRONTEND_RUNTIME_SCHEMA_VERSION,
291};
292pub use frontend_contract_generated::{
293    FrontendFacadeMethod, FrontendFacadeTransport, GeneratedFrontendClient,
294};
295pub use harness_auth::{
296    harness_authentication_methods, harness_authentication_plan, inspect_harness_authentication,
297    HarnessAuthenticationEnvironment, HarnessAuthenticationError, HarnessAuthenticationInteraction,
298    HarnessAuthenticationLaunch, HarnessAuthenticationMethod, HarnessAuthenticationMethodId,
299    HarnessAuthenticationPlan, HarnessAuthenticationReport, HarnessAuthenticationState,
300    HarnessBrowserBehavior, HARNESS_AUTHENTICATION_SCHEMA,
301};
302pub use harness_service::{
303    DetachedAnswer, DetachedCall, HarnessSessionService, OpenedRuntime, ReturnedRuntime,
304    RuntimeOpen, DETACHED_CALL_DEADLINE, DETACHED_METHODS, HARNESS_SERVICE_VERSION,
305    RUNTIME_CONTROL_DEADLINE, RUNTIME_EVENT_METHOD, RUNTIME_OPEN_DEADLINE, RUNTIME_OPEN_METHODS,
306    SESSION_ACTIVITY_EVENT_METHOD, SESSION_DISCOVER_DEADLINE, SESSION_EVENT_METHOD,
307    SESSION_INDEX_EVENT_METHOD,
308};
309pub use message::{
310    is_tool_error, mark_tool_error, mark_tool_outcome_unknown, tool_outcome, ChatMessage,
311    FunctionCall, Role, ToolCall, ToolOutcome, TOOL_ERROR_METADATA_KEY,
312    TOOL_OUTCOME_UNKNOWN_METADATA_KEY,
313};
314pub use provider::{
315    model_context_limit, ChatRequest, OpenAiProvider, PromptTokensDetails, Provider, RetryLog,
316    RetryNotice, ToolSchema, Usage, SERVED_MODEL_KEY, UNKNOWN_MODEL_CONTEXT_FLOOR,
317};
318#[cfg(feature = "adapter-api")]
319pub use runtime::SupercodeHttpRuntimeBackend;
320pub use runtime::{
321    AcpRuntimeBackend, BearerToken, ClaudeCodeRuntimeBackend, CodexRuntimeBackend, HarnessEvent,
322    McpServerLaunch, OpenCodeRuntimeBackend, PiRuntimeBackend, ResolvedRuntimeConnection,
323    RuntimeAttachRequest, RuntimeBackend, RuntimeCapabilities, RuntimeConnectLaunch,
324    RuntimeConnection, RuntimeEndpoint, RuntimeHandle, RuntimeInput, RuntimeLaunch,
325    RuntimeStartRequest,
326};
327pub use runtime_lease::{
328    CoordinatedRuntime, CoordinatedRuntimeClient, RuntimeAuthorization, RuntimeClientId,
329    RuntimeControllerLease, RuntimeLeaseCoordinator, RuntimeLeaseError, RuntimeLeaseSnapshot,
330    RuntimeObserverLease, RuntimePermission, DEFAULT_RUNTIME_LEASE_TTL_MS,
331};
332#[cfg(feature = "adapter-api")]
333pub use runtime_registry::{
334    LocalRuntimeRegistry, RuntimeRegistryEntry, RuntimeRegistryEvent, RuntimeRegistryOwner,
335    RuntimeRegistryQuery, RuntimeRegistryState, RuntimeRegistryWatch,
336};
337pub use sandbox::{landlock_available, netns_available, SandboxEnvPolicy, SandboxEscalation};
338pub use sdk::{
339    create_agent, discover_session_page, discover_sessions, load_session, load_session_path,
340    resume_agent, show_model_input, submit_agent, submit_agent_with_images, RuntimeSubmitError,
341    SdkAgent, SdkCapabilities, SdkError, SdkErrorCode, SdkEvent, SdkOperation, SdkPromptSource,
342    SdkRequest, SdkRuntime, SdkRuntimeEvent, SdkService, SDK_SCHEMA_VERSION,
343};
344pub use server::RpcEngine;
345pub use session::{
346    CrossSurface, OrchestrationNouns, Recurrence, Session, SessionFormat, SessionMeta,
347    SessionSource, SurfaceKey, Trigger, WorkspaceKind, WorkspaceRef,
348};
349pub use session_activity::{
350    SessionActivity, SessionActivityEvidence, SessionPresence, SessionTurnState,
351};
352pub use session_index::{SessionIndexChange, SessionIndexDelta, SessionIndexKey};
353pub use skills::{
354    declared_skill_name, list_skills, skill_roots, writable_skill_roots, SkillHomes, SkillRow,
355    SkillScope, SkillsQuery, SKILL_HARNESSES,
356};
357pub use skills_control::{
358    mutate_skill, supports_skill_control, SkillControlError, SkillMutation, SkillMutationOutcome,
359    SkillVerb, CONTROLLED_SKILL_HARNESSES,
360};
361pub use store::{SessionInfo, SessionStore};
362pub use support::{
363    harness_support, harness_support_registry, HarnessSupportDescriptor, ImplementationKind,
364    NativeSupport, RuntimeSupport, SupportRegistryReport, SUPPORT_REGISTRY_SCHEMA,
365};
366pub use tools::{
367    shell_sandbox_unenforceable, SandboxPolicy, SchemaTier, Tool, ToolContext, ToolRegistry,
368    WriteObserver,
369};
370pub use watch::{SessionFollower, SessionSnapshotReason, SessionWatchEvent};
supercode_harness/lib.rs

supercode_harness/
lib.rs
