Struct RuntimeBuilder 

pub struct RuntimeBuilder { /* private fields */ }

Builder for constructing a Runtime with the desired configuration.

Implementations

impl RuntimeBuilder

pub fn new() -> Self

Create a new builder with default settings.

pub fn from_file(path: &str) -> Result<Self, KernexError>

Create a new builder pre-populated from a declarative agent definition file.

The file format is detected by extension: .yaml / .yml use YAML (requires the yaml feature on kernex-core); all other extensions use TOML. Missing files silently fall back to defaults.

Maps [runtime] fields (data_dir, system_prompt, channel, project) and [memory] → db_path into the builder. Provider selection is left to the caller.

Example (agent.toml)

[runtime]
name       = "my-agent"
data_dir   = "~/.my-agent"
channel    = "api"
project    = "acme"
system_prompt = "You are a helpful coding assistant."

[memory]
db_path = "~/.my-agent/memory.db"

pub fn from_config(config: &KernexConfig) -> Self

Populate a builder from a pre-parsed KernexConfig.

Maps runtime.{data_dir, system_prompt, channel, project} and memory.db_path into builder fields. Provider selection is left to the caller.

pub fn from_env() -> Self

Create a new builder configured from environment variables.

Recognizes:

• KERNEX_DATA_DIR
• KERNEX_DB_PATH (when sqlite-store feature is enabled)
• KERNEX_SYSTEM_PROMPT
• KERNEX_CHANNEL
• KERNEX_PROJECT

pub fn data_dir(self, path: &str) -> Self

Set the data directory (default: ~/.kernex).

pub fn db_path(self, path: &str) -> Self

Set a custom database path (default: {data_dir}/memory.db).

pub fn system_prompt(self, prompt: &str) -> Self

Set the base system prompt.

pub fn channel(self, channel: &str) -> Self

Set the channel identifier (default: "cli").

pub fn project(self, project: &str) -> Self

Set the active project for scoping memory.

pub fn hook_runner(self, runner: Arc<dyn HookRunner>) -> Self

Set a hook runner for tool lifecycle events.

pub fn permission_rules(self, rules: PermissionRules) -> Self

Set declarative allow/deny permission rules for tool calls.

pub fn guardrail_runner(self, runner: Arc<dyn GuardrailRunner>) -> Self

Set a guardrail runner that intercepts and filters input/output text.

pub fn auto_compact(self, enable: bool) -> Self

Enable automatic context compaction on long conversations.

When enabled, every call into the runtime that builds context (e.g. Runtime::complete, Runtime::complete_stream, Runtime::run) will, on overflow past max_context_messages, summarize the dropped rows via the active provider and prepend the summary to the system prompt under [Earlier conversation summary]. The summarization adds one extra provider round-trip per overflow event (not per turn), uses a fixed instruction prompt that never reveals the agent’s own system prompt, and falls back to the default Drop behavior if the provider call fails.

Default is off to preserve v0.4.0 behavior. Recommended for any long-running interactive session; the default exists only so existing callers do not silently change billing characteristics.

pub async fn build(self) -> Result<Runtime, KernexError>

Build and initialize the runtime.

Trait Implementations

impl Default for RuntimeBuilder

fn default() -> Self

Returns the “default value” for a type.