Lua API¶

Reference for every namespace exposed under the global smelt table. Rust-registered signatures come from the closure's argument and return types; bundled Lua signatures come from LuaCATS annotations beside the implementation.

Coverage: 85 namespace(s), 430 function(s), 100 class(es), 14 alias(es).

Supported identifies the primary alpha plugin facade. Advanced identifies lower-level composition primitives that may evolve more freely. These labels guide API design and documentation; the alpha surface is not compatibility-frozen. Internal runtime machinery is excluded from this reference and IDE completion.

IDE completion¶

Stubs land in runtime/lua/smelt/_meta/ (one file per namespace, plus _types.lua for shared records and aliases). Point lua-language-server at that directory - see runtime/.luarc.json for a working config.

Host namespaces¶

Available in every runtime, including headless mode.

• smelt.agent - 1 function(s)
• smelt.auth - 2 function(s)
• smelt.build - 0 function(s)
• smelt.builtins - 4 function(s)
• smelt.cli - 3 function(s)
• smelt.clipboard - 2 function(s)
• smelt.defaults - 1 function(s)
• smelt.events - 3 function(s)
• smelt.files - 4 function(s)
• smelt.frontend - 2 function(s)
• smelt.fs - 23 function(s)
• smelt.fs.file_state - 7 function(s) - Advanced namespace
• smelt.fuzzy - 2 function(s)
• smelt.grep - 1 function(s)
• smelt.html - 5 function(s)
• smelt.http - 2 function(s)
• smelt.http.cache - 2 function(s)
• smelt.image - 7 function(s)
• smelt.json - 3 function(s)
• smelt.keymap - 7 function(s)
• smelt.layout - 20 function(s) - Advanced namespace
• smelt.lifecycle - 4 function(s)
• smelt.log - 3 function(s)
• smelt.lsp - 1 function(s) - Advanced namespace
• smelt.mcp - 4 function(s)
• smelt.messages - 6 function(s)
• smelt.notebook - 6 function(s) - Advanced namespace
• smelt.os - 12 function(s)
• smelt.parse - 2 function(s)
• smelt.path - 14 function(s)
• smelt.perf - 1 function(s) - Advanced namespace
• smelt.process - 11 function(s)
• smelt.provider - 8 function(s)
• smelt.reg - 2 function(s)
• smelt.remember - 1 function(s)
• smelt.shell - 6 function(s)
• smelt.signal - 5 function(s)
• smelt.skills - 3 function(s)
• smelt.state - 2 function(s)
• smelt.task - 8 function(s) - Advanced namespace
• smelt.text - 11 function(s) - Advanced namespace
• smelt.tick - 1 function(s)
• smelt.time - 6 function(s)
• smelt.timer - 2 function(s)
• smelt.tools - 7 function(s)
• smelt.transcript.defaults - 2 function(s) - Advanced namespace
• smelt.transcript.groups - 4 function(s)
• smelt.trust - 2 function(s)

UiHost namespaces¶

Requires a terminal UI; calling these from headless mode raises.

• smelt.buf - 1 function(s) - Advanced namespace
• smelt.config - 6 function(s)
• smelt.confirm - 1 function(s) - 1 advanced function(s)
• smelt.dialog - 11 function(s)
• smelt.history - 2 function(s)
• smelt.input - 1 function(s)
• smelt.inspect - 1 function(s) - Advanced namespace
• smelt.list - 1 function(s)
• smelt.metrics - 1 function(s)
• smelt.metrics.perf - 5 function(s) - Advanced namespace
• smelt.overlay - 1 function(s) - Advanced namespace
• smelt.paint - 1 function(s) - Advanced namespace
• smelt.picker - 2 function(s) - 1 advanced function(s)
• smelt.render - 4 function(s) - Advanced namespace
• smelt.search - 1 function(s)
• smelt.session - 34 function(s) - 9 advanced function(s)
• smelt.session.messages - 1 function(s)
• smelt.session.slug - 1 function(s)
• smelt.session.title - 2 function(s)
• smelt.settings - 1 function(s)
• smelt.terminal - 7 function(s)
• smelt.ui - 1 function(s)
• smelt.ui.layout - 6 function(s) - Advanced namespace
• smelt.vim - 2 function(s)
• smelt.win - 2 function(s) - Advanced namespace
• smelt.work - 4 function(s)

Mixed namespaces¶

Contains both Host and UiHost functions; per-function pages list the exact tier.

• smelt - 6 function(s) - 1 advanced function(s)
• smelt.cmd - 4 function(s)
• smelt.engine - 12 function(s)
• smelt.mode - 7 function(s)
• smelt.model - 8 function(s)
• smelt.notify - 4 function(s)
• smelt.permissions - 7 function(s)
• smelt.prompt - 11 function(s)
• smelt.reasoning - 4 function(s)
• smelt.theme - 10 function(s)
• smelt.transcript - 22 function(s)

Types¶

• Classes & aliases - typed opts records and string-literal unions referenced from the namespace pages.