Lua API¶

Reference for every namespace exposed under the global smelt table. Signatures are derived from the Rust closure's argument tuple and return type, so the LuaCATS-style annotation always matches what mlua actually marshals.

Coverage: 84 namespace(s), 458 function(s), 85 class(es), 11 alias(es).

Functions and namespaces marked Internal are implementation details for bundled Lua. They are documented for transparency, but user config and plugins should prefer public APIs.

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.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)
• smelt.fuzzy - 2 function(s)
• smelt.grep - 1 function(s)
• smelt.html - 5 function(s)
• smelt.http - 3 function(s)
• smelt.http.cache - 2 function(s)
• smelt.image - 6 function(s)
• smelt.json - 2 function(s)
• smelt.layout - 17 function(s)
• smelt.lifecycle - 4 function(s)
• smelt.log - 3 function(s)
• smelt.lsp - 1 function(s)
• smelt.mcp - 4 function(s)
• smelt.messages - 6 function(s)
• smelt.os - 13 function(s)
• smelt.parse - 2 function(s)
• smelt.path - 13 function(s)
• smelt.perf - 1 function(s)
• 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)
• smelt.tick - 1 function(s)
• smelt.time - 5 function(s)
• smelt.timer - 2 function(s)
• smelt.tools - 9 function(s)
• smelt.transcript.defaults - 30 function(s)
• 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)
• smelt.config - 6 function(s)
• smelt.confirm - 1 function(s) - 1 internal function(s)
• smelt.dialog - 11 function(s)
• smelt.engine - 11 function(s)
• smelt.history - 2 function(s)
• smelt.input - 1 function(s)
• smelt.inspect - 1 function(s)
• smelt.keymap - 7 function(s)
• smelt.list - 1 function(s)
• smelt.metrics - 1 function(s)
• smelt.metrics.perf - 5 function(s)
• smelt.model - 11 function(s)
• smelt.notebook - 7 function(s) - 1 internal function(s)
• smelt.notify - 4 function(s)
• smelt.overlay - 1 function(s)
• smelt.paint - 1 function(s)
• smelt.permissions - 6 function(s)
• smelt.picker - 3 function(s)
• smelt.prompt - 12 function(s)
• smelt.render - 4 function(s)
• smelt.search - 1 function(s)
• smelt.session - 33 function(s) - 1 internal 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.text - 11 function(s)
• smelt.ui - 1 function(s)
• smelt.ui.layout - 5 function(s)
• smelt.vim - 2 function(s)
• smelt.win - 2 function(s)
• smelt.work - 4 function(s)

Mixed namespaces¶

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

• smelt - 6 function(s)
• smelt.cmd - 4 function(s)
• smelt.mode - 12 function(s)
• smelt.reasoning - 4 function(s)
• smelt.theme - 10 function(s)
• smelt.transcript - 19 function(s)

Types¶

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