API Reference

All functions are accessed through the flume module.

flume.version

The running Flume version as a string (e.g. "1.2.5"). Useful for gating script features on a minimum version. Lua:

flume.buffer.print("", "", "Running Flume " .. flume.version)

Python:

import flume
print(f"Running Flume {flume.version}")

flume.event

Subscribe to IRC events.

Function	Description
`flume.event.on(name, callback)`	Register an event handler
`flume.event.off(name)`	Remove your handlers for an event

The callback receives an event table/dict with fields specific to each event type. See Events for the full list.

Event Cancellation

Scripts can cancel events to suppress default processing: Lua:

flume.event.on("message", function(e)
    if e.text:find("spam") then
        e:cancel()  -- suppress this message
    end
end)

Python:

def on_message(e):
    if "spam" in e.get("text", ""):
        e["_cancel"] = True

flume.event.on("message", on_message)

flume.channel

Channel operations.

Function	Description
`flume.channel.say(server, target, text)`	Send a message
`flume.channel.join(server, channel, key?)`	Join a channel
`flume.channel.part(server, channel, message?)`	Leave a channel

flume.buffer

Buffer operations.

Function	Description
`flume.buffer.print(server, buffer, text)`	Print text to a buffer
`flume.buffer.switch(buffer_name)`	Switch active buffer

Use "" for server and buffer to target the currently active ones.

flume.command

Function	Description
`flume.command.register(name, callback, help_text)`	Register `/name` command
`flume.command.unregister(name)`	Remove a command

The help_text is shown when users type /help name.

flume.command.register("greet", function(args)
    flume.buffer.print("", "", "Hello " .. args .. "!")
end, "Greet someone by name")

flume.config

Per-script persistent configuration. Stored as TOML in ~/.config/flume/scripts/<scriptname>.toml.

Function	Description
`flume.config.get(key)`	Read a config value
`flume.config.set(key, value)`	Write a config value

Supports strings, integers, floats, and booleans.

flume.server

Server operations.

Function	Description
`flume.server.send_raw(server, line)`	Send a raw IRC line

flume.vault

Read-only access to encrypted vault secrets.

Function	Description
`flume.vault.get(name)`	Read a vault secret (returns nil/None if not found)

Store secrets with /secure set name value. Scripts can read but not modify vault values.

local api_key = flume.vault.get("my_api_key")
if not api_key then
    flume.buffer.print("", "", "Run: /secure set my_api_key <value>")
end

flume.ui

UI operations.

Function	Description
`flume.ui.notify(message, level?)`	Send a desktop notification

Getting Started

Configuration

Scripting

Commands

API Reference

flume.version

flume.event

Event Cancellation

flume.channel

flume.buffer

flume.command

flume.config

flume.server

flume.vault

flume.ui

​flume.version

​flume.event

​Event Cancellation

​flume.channel

​flume.buffer

​flume.command

​flume.config

​flume.server

​flume.vault

​flume.ui

flume.version

flume.event

Event Cancellation

flume.channel

flume.buffer

flume.command

flume.config

flume.server

flume.vault

flume.ui