Skip to main content

Local Scripts

/script load

Load a script by name (searches autoload and available dirs) or by full path. Supports .lua and .py files.

/script unload

Unload a script and remove its event handlers and commands.

/script reload

Reload a script from disk (useful during development).

/script autoload

Add a script to the autoload directory so it loads on every startup.

/script noautoload

Remove a script from autoload.

/script list

Show loaded scripts with their versions and source (registry or local), plus any custom commands they registered.

Script Registry

Flume has a built-in script registry client that connects to scripts.flumeirc.io — a community-maintained collection of scripts.
Search the registry by name, description, tags, or author.

/script install

Download a script from the registry, save it to the autoload directory, and load it immediately.
The script is version-checked against your Flume version. If external dependencies are required (e.g., Python packages), you’ll see a note.

/script update

Checks the registry for newer versions of installed scripts and downloads updates.

/script info

Show full details about a registry script: version, author, language, category, tags, dependencies, compatibility, and whether it’s installed.

/script registry refresh

Force-refresh the registry index cache. The cache is normally refreshed every 24 hours automatically.

Script Command Help

Scripts can register commands with help text:
Users can then type /help greet to see the help text.

Script Directories

Scripts autoload after the vault is unlocked, so scripts that read secrets via flume.vault.get() at module load time will work correctly.