scripts

The scripts module is created by the script manager and lets you start, stop, configure, install and update darktable’s Lua scripts directly from the lighttable. See basic principles for an explanation of how the script manager loads scripts.

Since darktable 5.6 a collection of scripts is bundled with the program, so this module is available without any manual installation. Documentation for the individual bundled scripts is available in the lua docs.

Installing or updating scripts requires git to be installed and available on your path.

The module can be disabled in preferences > Lua options by disabling Lua scripts.

🔗module controls

The action dropdown at the top of the module switches between three views: start/stop scripts, configure and install/update scripts. The module remembers the last selected view.

🔗start/stop scripts

Lists the scripts contained in the selected folder, each preceded by an on/off button used to start or stop it.

folder: Select which group of scripts to display. The bundled scripts are grouped into contributed, examples, official and tools. Scripts placed in [configuration directory]/lua/FOLDER/file.lua can be selected here. See basic principles on how darktable loads added scripts.
page navigation: When a folder holds more scripts than fit on a single page, use the < and > buttons to move between pages. The current position is shown as “page x of y”. The number of scripts shown per page is set in the configure view.
script buttons: Each entry shows the script’s name preceded by an on/off button. Click it to start or stop that script. A started script stays active for the current session and is started again automatically the next time darktable runs.

🔗configure

scripts per page: Set how many lines are shown per page, between 5 and 20 (default 10).
change number of buttons: Apply the value selected above. The button list updates immediately; no restart is required.

🔗install/update scripts

This view is split into three sections.

update scripts

scripts to update: Select an installed script collection to update. The bundled scripts appear here as lua-scripts; any additional scripts you have added are listed by their folder name.
update scripts: Pull the latest version of the selected collection from its git repository.

add more scripts

URL to download additional scripts from: Enter the URL of a git repository that contains the scripts you want to add.
new folder to place scripts in: Enter a name for the folder the scripts will be cloned into (created under lua/ in your configuration directory).
install additional scripts: Clone the repository into the folder named above. Once installed, the scripts appear under that folder name in the start/stop scripts view.

disable scripts

enable “disable scripts” button: A safety check that must be ticked before the disable scripts button becomes active, to prevent it from being clicked by accident.
disable scripts: Renames the luarc file in your configuration directory to luarc.disabled. Note that in the bundled installation (5.6 onwards) this does not stop the bundled scripts from loading (see this issue). They are loaded independently of your luarc. To actually prevent the Lua scripts from running, use the disable Lua scripts option in preferences > lua options instead. (To undo the rename, manually rename change luarc.disabled back to luarc.)