rune.command

Slash commands add /name verbs to the input line. For a task-oriented introduction, see Slash Commands.

Quick reference

rune.command.add(name, handler, description?, opts?)  -- register /name
rune.command.remove(name)                             -- unregister; true if it existed
rune.command.get(name)                                -- the command's handle, or nil
rune.command.enable(name)                             -- re-enable (also recovers from quarantine)
rune.command.disable(name)                            -- disable without unregistering
rune.command.list()                                   -- array of {name, description, enabled, group, source}

add returns a handle; opts accepts group from the common options. The command is its own name, so a name in opts is ignored with a notice.

To wrap a built-in, capture its action before replacing it:

local quit = assert(rune.command.get("quit")):action()
rune.command.add("quit", function(args)
    rune.send("save")
    quit(args)
end, "Save, then exit")

rune.command.add

rune.command.add(name, handler, description?, opts?) -> handle

name (string) — a non-empty, single-word command name without the slash. Re-adding the same name replaces the old handler (upsert).
handler (function) — function(args); args is everything after /name as a single string ("" when there are no arguments).
description (string, optional) — shown in /help and the / command picker.
opts (table, optional) — {group = "..."}.

rune.command.add("greet", function(args)
    rune.send("say Hello, " .. (args ~= "" and args or "everyone") .. "!")
end, "Greet someone")

/help and the / picker are generated from the registry, so user-added commands appear in both automatically.

Each command is quarantined individually — a command that throws three times in a row is disabled with a notice, and input handling keeps working. Fix the error and rune.command.enable(name) (or /reload) to recover.

Managing

Standard registry management applies: rune.command.get/enable/disable/remove(name), .list(). See Registries. /help lists everything.