kernl

Class: Kernl

Defined in: packages/kernl/src/kernl/kernl.ts:31

The kernl - manages agent processes, scheduling, and task lifecycle.

Orchestrates agent execution, including guardrails, tool calls, session persistence, and tracing.

Extends

  • KernlHooks

Constructors

Constructor

new Kernl(options: KernlOptions): Kernl;

Defined in: packages/kernl/src/kernl/kernl.ts:50

Parameters

ParameterType
optionsKernlOptions

Returns

Kernl

Overrides

KernlHooks.constructor

Properties

PropertyModifierTypeDefined in
agentsreadonlyRAgentspackages/kernl/src/kernl/kernl.ts:47
athreadspublicMap<string, Thread<any, any>>packages/kernl/src/kernl/kernl.ts:38
memoriesreadonlyMemorypackages/kernl/src/kernl/kernl.ts:48
storagereadonlyKernlStoragepackages/kernl/src/kernl/kernl.ts:37
threadsreadonlyRThreadspackages/kernl/src/kernl/kernl.ts:46

Methods

emit()

emit<K>(event: K, ...args: KernlHookEvents[K]): boolean;

Defined in: packages/shared/dist/emitter.d.ts:28

Type Parameters

Type Parameter
K extends keyof KernlHookEvents

Parameters

ParameterType
eventK
...argsKernlHookEvents[K]

Returns

boolean

Inherited from

KernlHooks.emit

off()

off<K>(event: K, listener: (...args: KernlHookEvents[K]) => void): this;

Defined in: packages/shared/dist/emitter.d.ts:26

Type Parameters

Type Parameter
K extends keyof KernlHookEvents

Parameters

ParameterType
eventK
listener(...args: KernlHookEvents[K]) => void

Returns

this

Inherited from

KernlHooks.off

on()

on<K>(event: K, listener: (...args: KernlHookEvents[K]) => void): this;

Defined in: packages/shared/dist/emitter.d.ts:25

Type Parameters

Type Parameter
K extends keyof KernlHookEvents

Parameters

ParameterType
eventK
listener(...args: KernlHookEvents[K]) => void

Returns

this

Inherited from

KernlHooks.on

once()

once<K>(event: K, listener: (...args: KernlHookEvents[K]) => void): this;

Defined in: packages/shared/dist/emitter.d.ts:27

Type Parameters

Type Parameter
K extends keyof KernlHookEvents

Parameters

ParameterType
eventK
listener(...args: KernlHookEvents[K]) => void

Returns

this

Inherited from

KernlHooks.once

register()

register(agent: BaseAgent<any>): void;

Defined in: packages/kernl/src/kernl/kernl.ts:68

Registers a new agent with the kernl instance.

Parameters

ParameterType
agentBaseAgent<any>

Returns

void


schedule()

schedule<TContext, TOutput>(thread: Thread<TContext, TOutput>): Promise<ThreadExecuteResult<ResolvedAgentResponse<TOutput>>>;

Defined in: packages/kernl/src/kernl/kernl.ts:117

Schedule an existing thread - blocking execution

NOTE: just blocks for now

Type Parameters

Type Parameter
TContext
TOutput extends AgentOutputType

Parameters

ParameterType
threadThread<TContext, TOutput>

Returns

Promise<ThreadExecuteResult<ResolvedAgentResponse<TOutput>>>


scheduleStream()

scheduleStream<TContext, TOutput>(thread: Thread<TContext, TOutput>): AsyncIterable<ThreadStreamEvent>;

Defined in: packages/kernl/src/kernl/kernl.ts:151

(TMP) - won't make sense with async scheduling contexts

Schedule an existing thread - streaming execution

Type Parameters

Type Parameter
TContext
TOutput extends AgentOutputType

Parameters

ParameterType
threadThread<TContext, TOutput>

Returns

AsyncIterable<ThreadStreamEvent>


spawn()

spawn<TContext, TOutput>(thread: Thread<TContext, TOutput>): Promise<ThreadExecuteResult<ResolvedAgentResponse<TOutput>>>;

Defined in: packages/kernl/src/kernl/kernl.ts:100

Spawn a new thread - blocking execution

Type Parameters

Type Parameter
TContext
TOutput extends AgentOutputType

Parameters

ParameterType
threadThread<TContext, TOutput>

Returns

Promise<ThreadExecuteResult<ResolvedAgentResponse<TOutput>>>


spawnStream()

spawnStream<TContext, TOutput>(thread: Thread<TContext, TOutput>): AsyncIterable<ThreadStreamEvent>;

Defined in: packages/kernl/src/kernl/kernl.ts:134

(TMP) - won't make sense in async scheduling contexts

Spawn a new thread - streaming execution

Type Parameters

Type Parameter
TContext
TOutput extends AgentOutputType

Parameters

ParameterType
threadThread<TContext, TOutput>

Returns

AsyncIterable<ThreadStreamEvent>

On this page