dynamo-browse/_site/content/docs/user-guide/customising.md

50 lines
2 KiB
Markdown
Raw Normal View History

2025-11-15 00:34:07 +00:00
---
title: Customising Dynamo-Browse
weight: 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
2025-11-15 00:34:07 +00:00
tracked within the workspace file. To keep customisations across relaunches, these commands
can be added to an RC file.
2025-11-15 00:34:07 +00:00
## RC Files
2025-11-15 00:34:07 +00:00
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:
```
2025-11-15 00:34:07 +00:00
$HOME/.config/dynamo-browse/init.ucl
```
2025-11-15 00:34:07 +00:00
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](/docs/reference/commands#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](/docs/reference/key-bindings)
2025-11-15 00:34:07 +00:00
(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](/docs/reference/script-api).