Skip to main content

AgentOsConfig

Struct AgentOsConfig 

Source
pub struct AgentOsConfig {
Show 17 fields pub database: Option<VmSqliteDescriptor>, pub user: Option<VmUserConfig>, pub software: Vec<SoftwareInput>, pub packages: Vec<PackageRef>, pub packages_mount_at: Option<String>, pub loopback_exempt_ports: Vec<u16>, pub allowed_node_builtins: Option<Vec<String>>, pub root_filesystem: RootFilesystemConfig, pub mounts: Vec<MountConfig>, pub additional_instructions: Option<String>, pub schedule_driver: Option<Arc<dyn ScheduleDriver>>, pub bindings: Vec<Bindings>, pub sidecar_js_bridge_callback: Option<SidecarJsBridgeCallback>, pub permissions: Option<Permissions>, pub limits: Option<AgentOsLimits>, pub sidecar: Option<AgentOsSidecarConfig>, pub sidecar_binary_path: Option<String>,
}
Expand description

Resolved client options (= TS AgentOsOptions). All fields optional with documented defaults.

Keep this Rust mirror in sync with packages/core/src/agent-os.ts::AgentOsOptions and packages/core/src/options-schema.ts::agentOsOptionsSchema.

Fields§

§database: Option<VmSqliteDescriptor>

VM-scoped SQLite backend shared by VFS metadata/storage and AgentOS durable state. Actor deployments inject ActorUds; standalone clients normally provide a SqliteFile descriptor.

§user: Option<VmUserConfig>

Initial virtual Linux credentials and account record. Defaults to 1000:1000 (agentos).

§software: Vec<SoftwareInput>

Software packages to install (flattened). Default [].

§packages: Vec<PackageRef>

Package directories to project into the VM’s /opt/agentos tree (the agentos package projection). Each entry is a host dir containing an agentos-package.json manifest + the package payload. Default [].

§packages_mount_at: Option<String>

Guest mount point for the package projection. Default /opt/agentos (agentos’s OPT_AGENTOS_ROOT) when None.

§loopback_exempt_ports: Vec<u16>

Loopback ports exempt from the default outbound-to-host block.

§allowed_node_builtins: Option<Vec<String>>

Allowed Node.js builtins. Default: the hardened native-bridge set.

§root_filesystem: RootFilesystemConfig

Root filesystem configuration. Default: overlay + bundled base snapshot.

§mounts: Vec<MountConfig>

Additional mounts.

§additional_instructions: Option<String>

Extra OS instructions appended to agent sessions.

§schedule_driver: Option<Arc<dyn ScheduleDriver>>

Schedule driver used by the cron manager. Default: TimerScheduleDriver.

§bindings: Vec<Bindings>

Binding collections to register.

§sidecar_js_bridge_callback: Option<SidecarJsBridgeCallback>

Rust-only sidecar callback handler for js_bridge-style plugin requests.

§permissions: Option<Permissions>

Permission policy. Default: allow-all.

§limits: Option<AgentOsLimits>

Operator-tunable VM limits. Default: sidecar/kernel built-ins.

§sidecar: Option<AgentOsSidecarConfig>

Sidecar placement/config. Default: shared default pool.

§sidecar_binary_path: Option<String>

Absolute path to the agentos-sidecar binary, resolved from the npm package on the TypeScript side. Threaded to SidecarProcess::spawn (mirroring rivetkit’s engine_binary_path) instead of relying on the AGENTOS_SIDECAR_BIN env var. None falls back to env, then PATH.

Trait Implementations§

Source§

impl Default for AgentOsConfig

Source§

fn default() -> AgentOsConfig

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoMaybeUndefined<T> for T

Source§

fn into_maybe_undefined(self) -> MaybeUndefined<T>

Converts this value into a three-state builder argument.
Source§

impl<T> IntoOption<T> for T

Source§

fn into_option(self) -> Option<T>

Converts this value into an optional builder argument.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more