Skip to Content

Get started

Branding

Give an instance its own name, logo, accent colour, VS Code color theme and CSS, so it looks like your own tool.

Branding makes an instance look like its owner’s own tool, which is what a host wants when running Nexul for a client. It is an enterprise feature, so it needs an enterprise license key that includes Branding. Everything it changes is the look: how the app behaves is the same.

Open Settings → Instance. The Branding card sits under License. Only someone whose role holds the instance’s write permission, the instance Owner by default, can change it; anyone who can see the section sees what is set.

  • Product name replaces “Nexul” in the sidebar, on the sign-in page and the invitation page, in the browser tab and in the title of every phone notification the instance sends. It can be 40 characters.
  • Logo replaces the Nexul mark in the sidebar and on sign-in, and is the browser tab’s icon. Use a PNG, JPEG, WebP or SVG up to 512 KB; a square image fits best. A logo saves as soon as you choose it; one that isn’t close to square is shown at the size of the mark first, so you can see how small its lettering gets and choose another.

An instance with a product name drops Nexul’s own pitch from its signed-out home page and keeps one small Runs on Nexul line on the sign-in pages.

The phone app keeps its own name and icon, since they are fixed when the app is built.

Accent

The accent is the one colour for actions, the current page and selection. Pick it with the colour field and save. If it would be hard to read, as text or as a button label, Nexul moves its lightness a little and keeps its hue. The swatch after the arrow shows what light mode paints from it, since a bright colour is darkened there. Use the default goes back to Nexul’s; while an imported theme is in place, the field reads From theme and the theme’s own accent shows.

A person who has picked a colour theme of their own under Settings → Appearance keeps that theme’s accent.

A color theme for the whole instance

Under Dark theme and Light theme, Import a VS Code color theme file (a *-color-theme.json file; comments in it are fine). A theme file holds colours for one appearance, so a dark theme paints dark mode and a light theme paints light mode; the other mode keeps Nexul’s colours until you import a theme for it.

Nexul takes the theme’s background, text, secondary text, accent and error colours, and builds the panels, cards and borders between them the same way its own themes are built. Text must stay readable, so a colour that falls short of the contrast Nexul’s own themes keep is moved until it holds, and the card says which: for example “Moved to stay readable: text, accent”. The theme replaces every person’s own theme in that mode, and Settings → Appearance says so. Remove drops it and goes back to Nexul’s colours.

A theme file that includes another file is refused: upload one that holds its own colours.

Custom CSS

Custom CSS takes your own style rules, added after Nexul’s on every page for everyone, the sign-in page included. Save it with the card’s Save button, and every open page repaints at once. Leave the field empty to remove it.

Set colours through the theme’s tokens rather than element by element, so every component follows: :root.dark { --brand: #7c5cff !important; } changes the accent in dark mode, and :root:not(.dark) is light mode. A token without !important gives way to a person’s own theme. The rules can rely on a few selectors that stay put, such as [data-app-sidebar] for the sidebar, .app-frame for the panel each page sits in, .light-field for the backdrop behind it, and [data-slot="button"] for every button.

Nothing may load from another address, so the CSS can never send what is on screen elsewhere. url() takes only a data: address or an #id, and @import, image-set(), image(), src(), a backslash and < are refused with the reason. An image therefore goes inline as a base64 data: address, and the whole CSS is at most 20,000 characters, which suits a small or soft image but not a photo. Fonts are the ones the device already has.

Unlike an imported theme, Nexul does not check the contrast of custom CSS: what it paints is yours to keep readable. If a change goes wrong, empty the field, or click Remove branding.

Ask an agent

The quickest way to write custom CSS is to ask an agent connected to the instance’s MCP server, for example “make our instance look like our company site” or “tone down the borders in dark mode”. The agent reads the styling guide from instance_get, writes the rules with instance_update, and every open page repaints while you watch. The agent cannot see the page, so it changes a little at a time and asks you how it looks.

Without a key

When the key expires, is removed, or stops fitting the instance’s address, the instance shows Nexul’s own name, logo and colours again. What you saved stays, and shows again as soon as a key that includes Branding is in place. While the key is missing, the card keeps your settings but won’t change them; only Remove on the logo and Remove branding still work. Remove branding deletes everything for good.

From an agent

instance_get returns the branding with the rest of the instance’s state, and with styling_guide also the guide to writing custom CSS: its tokens, the selectors that stay, and what is refused. instance_update takes a branding object: product_name, accent (#rrggbb), logo (a base64 data URL), theme_file (the text of a theme file), remove_theme (light, dark or all), css and clear. An empty product_name, accent, logo or css removes that setting. It needs the same permissions as the web page, and every open page follows the change at once.

Edit this page