Settings

Settings live in ~/.config/vanitty (%APPDATA%\Vanitty on Windows, or $XDG_CONFIG_HOME/vanitty). Open them with Settings > Open Settings or Ctrl+, (⌘+, on macOS).

settings.json takes the same options as Hyper’s config, as JSON with comments. A JSON schema sits next to it, so VS Code autocompletes and validates it. Changes apply as soon as you save.

{
  "$schema": "./settings.schema.json",
  "fontSize": 13,
  "cursorShape": "BLOCK",
  "padding": "12px 14px",
  "themes": ["hyper-snazzy"]
}

Profiles

A profile overrides any terminal option, such as the shell or colors. Pick one from the new-tab menu, or set defaultProfile.

"profiles": [
  { "name": "zsh", "config": { "shell": "/bin/zsh" } },
  { "name": "PowerShell", "config": { "shell": "pwsh.exe", "backgroundColor": "#012456" } }
]

Reference

Setting	Type	Default	Description
fontSize	number	13	Font size in pixels.
fontFamily	string		Font family, with fallbacks.
uiFontFamily	string		Font family for tabs and other UI.
fontWeight	string | number	"normal"	Font weight: normal, bold, or 100-900.
fontWeightBold	string | number	"bold"	Font weight for bold text.
lineHeight	number	1	Line height as a multiple of the font size.
letterSpacing	number	0	Extra space between letters, in pixels.
scrollback	integer	1000	Lines kept in the scrollback buffer.
cursorColor	color	"rgba(248,28,229,0.8)"	Cursor color.
cursorAccentColor	color	"#000"	Color of the text under a block cursor.
cursorShape	"BLOCK" | "BEAM" | "UNDERLINE"	"BLOCK"	Cursor shape.
cursorBlink	boolean	true	Blink the cursor.
foregroundColor	color	"#fff"	Text color.
backgroundColor	color	"#000"	Background color. Use an rgba() color for transparency.
selectionColor	color	"rgba(248,28,229,0.3)"	Selection color.
borderColor	color	"#333"	Window border and divider color.
padding	string	"12px 14px"	CSS padding around the terminal, e.g. "12px 14px".
colors	object		The 16 ANSI colors.
shell	string	""	Shell to run. Empty uses $SHELL (or COMSPEC on Windows).
shellArgs	array		Arguments passed to the shell.
env	object		Extra environment variables.
workingDirectory	string	""	Directory new sessions start in. Empty uses your home directory.
bell	"SOUND" | false	false	"SOUND" plays a sound on the terminal bell, false disables it.
bellSoundURL	string | null		URL of a custom bell sound.
copyOnSelect	boolean	false	Copy text to the clipboard when you select it.
quickEdit	boolean	true	Right-click copies the selection, or pastes when nothing is selected.
macOptionSelectionMode	"vertical" | "force"	"vertical"	"force" makes Option+click always select on macOS.
webGLRenderer	boolean	true	Render with WebGL. Turned off automatically for transparent backgrounds.
webLinksActivationKey	"" | "ctrl" | "alt" | "meta" | "shift"	""	Modifier needed to open links. Empty opens on click.
disableLigatures	boolean	false	Turn off font ligatures such as => and !=.
screenReaderMode	boolean	false	Expose terminal content to screen readers.
imageSupport	boolean	true	Show inline images (sixel and iTerm2 protocol).
modifierKeys	object
css	string	""	Extra CSS for the window. Uses Hyper's class names, so Hyper snippets work.
termCSS	string	""	Extra CSS for the terminals.
showHamburgerMenu	"" | true | false	""	Show the menu button (Linux and Windows). Empty uses the default.
showWindowControls	"" | true | false | "left"	""	Show window controls (Linux and Windows), optionally on the left.
borderRadius	number	10	Window corner radius in pixels (Linux and Windows; macOS uses the system corners).
preserveCWD	boolean	true	Open new tabs and splits in the current directory.
defaultProfile	string	"default"	Profile used for new tabs.
profiles	array		Named profiles. Each overrides any terminal option, such as shell or colors.
plugins	array	[]	Vanitty plugins from npm. They run sandboxed, without network or file access.
localPlugins	array	[]	Plugin folders inside the plugins/local folder of your config directory.
themes	array	[]	Hyper themes from npm, e.g. "hyper-snazzy" or "hyper-dracula@2". Applied in order.