Skip to main content

Settings and customisation

In the bottom left of the interface you can find a settings button (⚙) to open the settings dialog. These settings allow you to further customise the behaviour and appearance of Surrealist, such as switching between light and dark mode, increasing or decreasing the editor font sizes, and configure default values for new connections.

Behaviour

In this section you can configure the behaviour of the interface, such as connection and editor related settings.

Appearance

The appearance section allows you to scale the fonts in the editor and also select your default query output view and set the behaviour for your Query and designer views.

Templates

You can configure connection templates to reuse connection details when creating new connections. This is especially useful when you find yourself connecting to similar databases frequently.

Database Serving

This section allows you to alter the behaviour of the database serving functionality found in Surrealist Desktop, such as altering the port and specifying the path to the database executable.

Feature flags

Feature flags allow you to enable or disable stable and experimental features in Surrealist to suit your needs best.

Some of these features need to be stable and may not work as expected or be removed in future versions. To access the feature flags, press Ctrl + K or Cmd + K on your keyboard to open the command palette, then type in "Manage Feature Flags" and hit enter. You'll be taken to the feature flags settings.

After enabling a feature flag, you can access it by clicking on the settings button in the bottom left of the interface and selecting the feature flags tab. Here, you can enable or disable features. Here is a list of the current feature flags:

OptionsDescription
feature_flags

Toggle feature flags.

models_view

Toggle the view for SurrealML models.

apidocs_view

Toggle the view for API documentation.

themes

Toggle between light and dark mode.

newsfeed

Toggle the newsfeed view.

database_version_check

Toggle the database version check in the Surrealist CLI

highlight_tool

Toggle the highlight tool.

surreal_compat

Toggle SurrealDB version between 1.x and 2.x.

changelog

Toggle the changelog view to see the latest changes, read all or unread all.