dynamo-browse/_site/content/docs/user-guide/customising.md
Leon Mika b4cee0e2e5
Some checks failed
ci / Build (push) Failing after 3m41s
Release / Build (push) Failing after 3m41s
Release / Site (push) Has been skipped
Release / Release (push) Has been skipped
Updated the documentation
2025-11-15 11:34:07 +11:00

2 KiB

title weight
Customising Dynamo-Browse 50

Customising Dynamo-Browse

Some commands can be used to customise Dynamo-Browse, such as modify key bindings. The effect of these commands will only be applied for the duration of the session: they are currently not tracked within the workspace file. To keep customisations across relaunches, these commands can be added to an RC file.

RC Files

RC files are text files containing commands that will be executed by Dynamo-Browse upon launch. By default, RC files are located in $HOME/.config/dynamo-browse/ and have the suffix .ucl. For example:

$HOME/.config/dynamo-browse/init.ucl

Any number of RC files can be present in this directory, and they are executed in lexicographical order.

Rebinding Keys

The default key bindings of Dynamo-Browse can be changed using the rebind command. This takes a binding name corresponding to the particular action to invoke, and the key to which it should be mapped to.

Putting these commands in the RC file will effectively change the default bindings of Dynamo-Browse.

# Rebind T to prompt for a table
rebind "view.prompt-for-table" "T"

# Rebind escape to prompt for a command
rebind "view.prompt-for-command" "esc"

At the moment each binding name can only be mapped to a single key. It's also currently not possible to setup bindings for commands. These may be supported in the future.

A list of available binding names can be found the the reference (check the "Show binding names" checkbox). Note that some bindings may not have default key bindings.

Extensions

The RC files are primarily intended for commands that customise Dynamo-Browse in a particular way, but any command can be entered here, including those for defining new commands or running predefined queries. These are generally known as extensions, although act as any other RC file located within that directory. More information on extensions can be found in the reference.