Quirl0.1 RC
Extensions

Lua SDK API reference

Generated function signatures, capabilities, and contracts for the Quirl Lua SDK.

Module: quirl

Version: 0.1.0

Schema version: 2

Runner ABI: 1

Runner ABI hash: fnv1a64:7f0b8bdb9bd2da63

quirl.cwd

quirl.cwd() -> string

Return the current working directory.

Returns: string

quirl.process.run

quirl.process.run(command: string) -> quirl.ProcessResult

Run a command through the composed bounded native process host.

ParameterType
commandstring

Returns: quirl.ProcessResult

Capability: process.spawn

quirl.config

quirl.config(value: quirl.Config) -> quirl.Config

Return configuration for Rust schema validation.

ParameterType
valuequirl.Config

Returns: quirl.Config

quirl.prompt.add_segment

quirl.prompt.add_segment(spec: quirl.PromptSegment) -> nil

Register a deadline-bounded prompt segment.

ParameterType
specquirl.PromptSegment

Returns: nil

Capability: prompt.register

quirl.completion.add_provider

quirl.completion.add_provider(spec: quirl.CompletionProvider) -> nil

Register a semantic completion provider.

ParameterType
specquirl.CompletionProvider

Returns: nil

Capability: completion.register

quirl.plugin.command

quirl.plugin.command(spec: quirl.PluginCommand) -> nil

Register a documented command with exact ABI-v1 value I/O; live streams are rejected.

ParameterType
specquirl.PluginCommand

Returns: nil

Capability: commands.register

quirl.events.subscribe

quirl.events.subscribe(spec: quirl.EventSubscription) -> nil

Observe immutable typed shell events and return declared actions.

ParameterType
specquirl.EventSubscription

Returns: nil

Capability: events.observe

quirl.extension.contribute

quirl.extension.contribute(spec: quirl.Contribution) -> nil

Register a typed catalog, completion, or panel contribution.

ParameterType
specquirl.Contribution

Returns: nil

Capability: extension.contribute

On this page