v0.23.0 d05d132

schema.go RawHistoryFolder

1package config
2
3// Config represents the complete configuration for dumber.
4type Config struct {
5	Database        DatabaseConfig            `mapstructure:"database" yaml:"database" toml:"database"`
6	History         HistoryConfig             `mapstructure:"history" yaml:"history" toml:"history"`
7	SearchShortcuts map[string]SearchShortcut `mapstructure:"search_shortcuts" yaml:"search_shortcuts" toml:"search_shortcuts"`
8	// DefaultSearchEngine is the URL template for the default search engine (must contain %s placeholder)
9	DefaultSearchEngine string           `mapstructure:"default_search_engine" yaml:"default_search_engine" toml:"default_search_engine"`
10	Dmenu               DmenuConfig      `mapstructure:"dmenu" yaml:"dmenu" toml:"dmenu"`
11	Logging             LoggingConfig    `mapstructure:"logging" yaml:"logging" toml:"logging"`
12	Appearance          AppearanceConfig `mapstructure:"appearance" yaml:"appearance" toml:"appearance"`
13	Debug               DebugConfig      `mapstructure:"debug" yaml:"debug" toml:"debug"`
14	// DefaultWebpageZoom sets the default zoom level for pages without saved zoom settings (1.0 = 100%, 1.2 = 120%)
15	DefaultWebpageZoom float64 `mapstructure:"default_webpage_zoom" yaml:"default_webpage_zoom" toml:"default_webpage_zoom"`
16	// DefaultUIScale sets the default UI scale for GTK widgets (1.0 = 100%, 2.0 = 200%)
17	DefaultUIScale float64 `mapstructure:"default_ui_scale" yaml:"default_ui_scale" toml:"default_ui_scale"`
18	// Workspace defines workspace, pane, and tab handling behavior.
19	Workspace WorkspaceConfig `mapstructure:"workspace" yaml:"workspace" toml:"workspace"`
20	// Session controls session persistence and restoration.
21	Session SessionConfig `mapstructure:"session" yaml:"session" toml:"session"`
22	// ContentFiltering controls ad blocking and content filtering
23	ContentFiltering ContentFilteringConfig `mapstructure:"content_filtering" yaml:"content_filtering" toml:"content_filtering"`
24	// Omnibox controls the omnibox behavior (initial history display)
25	Omnibox OmniboxConfig `mapstructure:"omnibox" yaml:"omnibox" toml:"omnibox"`
26	// Rendering controls WebKit, GTK and compositor behavior.
27	Rendering RenderingConfig `mapstructure:"rendering" yaml:"rendering" toml:"rendering"`
28	// Media controls video playback and hardware acceleration
29	Media MediaConfig `mapstructure:"media" yaml:"media" toml:"media"`
30	// Runtime configures optional runtime overrides (e.g., /opt prefix for WebKitGTK/GTK).
31	Runtime RuntimeConfig `mapstructure:"runtime" yaml:"runtime" toml:"runtime"`
32	// Performance holds internal performance tuning options (not exposed in UI).
33	Performance PerformanceConfig `mapstructure:"performance" yaml:"performance" toml:"performance"`
34	// Update controls automatic update checking and downloading.
35	Update UpdateConfig `mapstructure:"update" yaml:"update" toml:"update"`
36}
37
38// RenderingMode selects GPU vs CPU rendering.
39type RenderingMode string
40
41const (
42	RenderingModeAuto RenderingMode = "auto"
43	RenderingModeGPU  RenderingMode = "gpu"
44	RenderingModeCPU  RenderingMode = "cpu"
45)
46
47// GSKRendererMode controls the GTK Scene Kit renderer selection.
48type GSKRendererMode string
49
50const (
51	GSKRendererAuto   GSKRendererMode = "auto"
52	GSKRendererOpenGL GSKRendererMode = "opengl"
53	GSKRendererVulkan GSKRendererMode = "vulkan"
54	GSKRendererCairo  GSKRendererMode = "cairo"
55)
56
57// RenderingConfig controls WebKit and GTK/GSK rendering behavior.
58type RenderingConfig struct {
59	// Mode controls GPU/CPU rendering selection for WebKit (auto, gpu, cpu).
60	Mode RenderingMode `mapstructure:"mode" yaml:"mode" toml:"mode"`
61
62	// DisableDMABufRenderer disables DMA-BUF accelerated renderer.
63	// Env: WEBKIT_DISABLE_DMABUF_RENDERER
64	DisableDMABufRenderer bool `mapstructure:"disable_dmabuf_renderer" yaml:"disable_dmabuf_renderer" toml:"disable_dmabuf_renderer"`
65
66	// ForceCompositingMode forces accelerated compositing.
67	// Env: WEBKIT_FORCE_COMPOSITING_MODE
68	ForceCompositingMode bool `mapstructure:"force_compositing_mode" yaml:"force_compositing_mode" toml:"force_compositing_mode"`
69
70	// DisableCompositingMode disables accelerated compositing.
71	// Env: WEBKIT_DISABLE_COMPOSITING_MODE
72	DisableCompositingMode bool `mapstructure:"disable_compositing_mode" yaml:"disable_compositing_mode" toml:"disable_compositing_mode"`
73
74	// GSKRenderer overrides GTK Scene Kit renderer selection.
75	// Env: GSK_RENDERER
76	GSKRenderer GSKRendererMode `mapstructure:"gsk_renderer" yaml:"gsk_renderer" toml:"gsk_renderer"`
77
78	// DisableMipmaps disables mipmap generation.
79	// Env: GSK_GPU_DISABLE=mipmap
80	DisableMipmaps bool `mapstructure:"disable_mipmaps" yaml:"disable_mipmaps" toml:"disable_mipmaps"`
81
82	// PreferGL forces OpenGL over GLES.
83	// Env: GDK_DEBUG=gl-prefer-gl
84	PreferGL bool `mapstructure:"prefer_gl" yaml:"prefer_gl" toml:"prefer_gl"`
85
86	// DrawCompositingIndicators shows compositing layer borders and repaint counters.
87	DrawCompositingIndicators bool `mapstructure:"draw_compositing_indicators" yaml:"draw_compositing_indicators" toml:"draw_compositing_indicators"` //nolint:lll // struct tags exceed lll limit
88
89	// ShowFPS displays WebKit FPS counter.
90	// Env: WEBKIT_SHOW_FPS
91	ShowFPS bool `mapstructure:"show_fps" yaml:"show_fps" toml:"show_fps"`
92
93	// SampleMemory enables memory sampling.
94	// Env: WEBKIT_SAMPLE_MEMORY
95	SampleMemory bool `mapstructure:"sample_memory" yaml:"sample_memory" toml:"sample_memory"`
96
97	// DebugFrames enables frame timing debug output.
98	// Env: GDK_DEBUG=frames
99	DebugFrames bool `mapstructure:"debug_frames" yaml:"debug_frames" toml:"debug_frames"`
100}
101
102// HardwareDecodingMode controls video hardware acceleration.
103type HardwareDecodingMode string
104
105const (
106	// HardwareDecodingAuto lets GStreamer choose (hw preferred, sw fallback)
107	HardwareDecodingAuto HardwareDecodingMode = "auto"
108	// HardwareDecodingForce requires hardware decoding (fails if unavailable)
109	HardwareDecodingForce HardwareDecodingMode = "force"
110	// HardwareDecodingDisable uses software decoding only
111	HardwareDecodingDisable HardwareDecodingMode = "disable"
112)
113
114// GLRenderingMode controls OpenGL API selection for video rendering.
115type GLRenderingMode string
116
117const (
118	// GLRenderingModeAuto lets GStreamer choose the best GL API
119	GLRenderingModeAuto GLRenderingMode = "auto"
120	// GLRenderingModeGLES2 forces GLES2 (better for some mobile/embedded GPUs)
121	GLRenderingModeGLES2 GLRenderingMode = "gles2"
122	// GLRenderingModeGL3 forces OpenGL 3.x desktop
123	GLRenderingModeGL3 GLRenderingMode = "gl3"
124	// GLRenderingModeNone disables GL-based rendering
125	GLRenderingModeNone GLRenderingMode = "none"
126)
127
128// PerformanceProfile selects preset performance tuning settings.
129type PerformanceProfile string
130
131const (
132	// ProfileDefault uses WebKit defaults (no tuning applied).
133	ProfileDefault PerformanceProfile = "default"
134	// ProfileLite reduces resource usage for low-RAM systems.
135	ProfileLite PerformanceProfile = "lite"
136	// ProfileMax maximizes responsiveness for heavy pages (GitHub PRs, etc).
137	ProfileMax PerformanceProfile = "max"
138	// ProfileCustom allows full control over individual performance settings.
139	ProfileCustom PerformanceProfile = "custom"
140)
141
142// ThemeDefault is the default theme setting (follows system).
143const ThemeDefault = "default"
144
145const (
146	// ThemePreferDark explicitly selects dark theme.
147	ThemePreferDark = "prefer-dark"
148	// ThemePreferLight explicitly selects light theme.
149	ThemePreferLight = "prefer-light"
150)
151
152// MediaConfig holds video playback and hardware acceleration preferences.
153type MediaConfig struct {
154	// HardwareDecodingMode controls hardware vs software video decoding
155	// Values: "auto" (default), "force", "disable"
156	HardwareDecodingMode HardwareDecodingMode `mapstructure:"hardware_decoding" yaml:"hardware_decoding" toml:"hardware_decoding"`
157	// PreferAV1 prioritizes AV1 codec (most efficient) when available
158	PreferAV1 bool `mapstructure:"prefer_av1" yaml:"prefer_av1" toml:"prefer_av1"`
159	// ShowDiagnosticsOnStartup shows media capability warnings at startup
160	ShowDiagnosticsOnStartup bool `mapstructure:"show_diagnostics" yaml:"show_diagnostics" toml:"show_diagnostics"`
161	// ForceVSync forces vertical sync for video playback (may help with tearing)
162	ForceVSync bool `mapstructure:"force_vsync" yaml:"force_vsync" toml:"force_vsync"`
163	// GLRenderingMode controls OpenGL API selection for video rendering
164	// Values: "auto" (default), "gles2", "gl3", "none"
165	GLRenderingMode GLRenderingMode `mapstructure:"gl_rendering_mode" yaml:"gl_rendering_mode" toml:"gl_rendering_mode"`
166	// GStreamerDebugLevel sets GStreamer debug verbosity (0=off, 1-5=increasing verbosity)
167	GStreamerDebugLevel int `mapstructure:"gstreamer_debug_level" yaml:"gstreamer_debug_level" toml:"gstreamer_debug_level"`
168	// VideoBufferSizeMB sets the video buffer size in megabytes for smoother streaming
169	// Higher values reduce rebuffering but use more memory. Default: 64 MB
170	VideoBufferSizeMB int `mapstructure:"video_buffer_size_mb" yaml:"video_buffer_size_mb" toml:"video_buffer_size_mb"`
171	// QueueBufferTimeSec sets the queue buffer time in seconds
172	// Higher values allow more prebuffering for bursty streams. Default: 20 seconds
173	QueueBufferTimeSec int `mapstructure:"queue_buffer_time_sec" yaml:"queue_buffer_time_sec" toml:"queue_buffer_time_sec"`
174}
175
176// RuntimeConfig holds optional runtime overrides.
177type RuntimeConfig struct {
178	// Prefix points to a custom runtime prefix (e.g., /opt/webkitgtk).
179	// This is used to influence pkg-config lookup and dynamic library loading.
180	Prefix string `mapstructure:"prefix" yaml:"prefix" toml:"prefix"`
181}
182
183// DatabaseConfig holds database-related configuration.
184type DatabaseConfig struct {
185	Path string `mapstructure:"path" yaml:"path" toml:"path"`
186}
187
188// HistoryConfig holds history-related configuration.
189type HistoryConfig struct {
190	MaxEntries          int `mapstructure:"max_entries" yaml:"max_entries" toml:"max_entries"`
191	RetentionPeriodDays int `mapstructure:"retention_period_days" yaml:"retention_period_days" toml:"retention_period_days"`
192	CleanupIntervalDays int `mapstructure:"cleanup_interval_days" yaml:"cleanup_interval_days" toml:"cleanup_interval_days"`
193}
194
195// PerformanceConfig holds internal performance tuning options.
196// These are not exposed in dumb://config UI but can be set in config file.
197type PerformanceConfig struct {
198	// Profile selects a preset performance configuration.
199	// Values: "default" (no tuning), "lite" (low RAM), "max" (heavy pages), "custom" (manual control)
200	// When profile is not "custom", individual tuning fields below are ignored and computed from the profile.
201	// Default: "default"
202	Profile PerformanceProfile `mapstructure:"profile" yaml:"profile" toml:"profile"`
203
204	// ZoomCacheSize is the number of domain zoom levels to cache in memory.
205	// Higher values reduce database queries but use more memory.
206	// Default: 256 domains (~20KB memory)
207	ZoomCacheSize int `mapstructure:"zoom_cache_size" yaml:"zoom_cache_size" toml:"zoom_cache_size"`
208
209	// WebViewPoolPrewarmCount is the number of WebViews to pre-create at startup.
210	// Higher values speed up initial tab creation but use more memory.
211	// Default: 4 (custom mode), computed from profile otherwise
212	WebViewPoolPrewarmCount int `mapstructure:"webview_pool_prewarm_count" yaml:"webview_pool_prewarm_count" toml:"webview_pool_prewarm_count"` //nolint:lll // struct tags must stay on one line
213
214	// --- Skia rendering threads (env vars) ---
215	// NOTE: Fields below only apply when Profile is "custom".
216	// SkiaCPUPaintingThreads sets WEBKIT_SKIA_CPU_PAINTING_THREADS.
217	// Default: 0 (unset, uses WebKit default)
218	SkiaCPUPaintingThreads int `mapstructure:"skia_cpu_painting_threads" yaml:"skia_cpu_painting_threads" toml:"skia_cpu_painting_threads"` //nolint:lll // struct tags must stay on one line
219
220	// SkiaGPUPaintingThreads sets WEBKIT_SKIA_GPU_PAINTING_THREADS.
221	// Default: -1 (unset). Value 0 disables GPU tile painting.
222	SkiaGPUPaintingThreads int `mapstructure:"skia_gpu_painting_threads" yaml:"skia_gpu_painting_threads" toml:"skia_gpu_painting_threads"` //nolint:lll // struct tags must stay on one line
223
224	// SkiaEnableCPURendering forces CPU rendering via WEBKIT_SKIA_ENABLE_CPU_RENDERING=1.
225	// Default: false
226	SkiaEnableCPURendering bool `mapstructure:"skia_enable_cpu_rendering" yaml:"skia_enable_cpu_rendering" toml:"skia_enable_cpu_rendering"` //nolint:lll // struct tags must stay on one line
227
228	// --- Web process memory pressure ---
229	// WebProcessMemoryLimitMB sets memory limit in MB for web processes.
230	// Default: 0 (unset, uses WebKit default: system RAM capped at 3GB)
231	WebProcessMemoryLimitMB int `mapstructure:"web_process_memory_limit_mb" yaml:"web_process_memory_limit_mb" toml:"web_process_memory_limit_mb"` //nolint:lll // struct tags must stay on one line
232
233	// WebProcessMemoryPollIntervalSec sets poll interval for memory checks.
234	// Default: 0 (unset, uses WebKit default: 30 seconds)
235	WebProcessMemoryPollIntervalSec float64 `mapstructure:"web_process_memory_poll_interval_sec" yaml:"web_process_memory_poll_interval_sec" toml:"web_process_memory_poll_interval_sec"` //nolint:lll // struct tags must stay on one line
236
237	// WebProcessMemoryConservativeThreshold sets threshold for conservative memory release.
238	// Valid: (0, 1). Default: 0 (unset, uses WebKit default: 0.33)
239	WebProcessMemoryConservativeThreshold float64 `mapstructure:"web_process_memory_conservative_threshold" yaml:"web_process_memory_conservative_threshold" toml:"web_process_memory_conservative_threshold"` //nolint:lll // struct tags must stay on one line
240
241	// WebProcessMemoryStrictThreshold sets threshold for strict memory release.
242	// Valid: (0, 1). Default: 0 (unset, uses WebKit default: 0.5)
243	WebProcessMemoryStrictThreshold float64 `mapstructure:"web_process_memory_strict_threshold" yaml:"web_process_memory_strict_threshold" toml:"web_process_memory_strict_threshold"` //nolint:lll // struct tags must stay on one line
244
245	// --- Network process memory pressure ---
246	// NetworkProcessMemoryLimitMB sets memory limit in MB for network process.
247	// Default: 0 (unset)
248	NetworkProcessMemoryLimitMB int `mapstructure:"network_process_memory_limit_mb" yaml:"network_process_memory_limit_mb" toml:"network_process_memory_limit_mb"` //nolint:lll // struct tags must stay on one line
249
250	// NetworkProcessMemoryPollIntervalSec sets poll interval for memory checks.
251	// Default: 0 (unset)
252	NetworkProcessMemoryPollIntervalSec float64 `mapstructure:"network_process_memory_poll_interval_sec" yaml:"network_process_memory_poll_interval_sec" toml:"network_process_memory_poll_interval_sec"` //nolint:lll // struct tags must stay on one line
253
254	// NetworkProcessMemoryConservativeThreshold sets threshold for conservative memory release.
255	// Valid: (0, 1). Default: 0 (unset)
256	NetworkProcessMemoryConservativeThreshold float64 `mapstructure:"network_process_memory_conservative_threshold" yaml:"network_process_memory_conservative_threshold" toml:"network_process_memory_conservative_threshold"` //nolint:lll // struct tags must stay on one line
257
258	// NetworkProcessMemoryStrictThreshold sets threshold for strict memory release.
259	// Valid: (0, 1). Default: 0 (unset)
260	NetworkProcessMemoryStrictThreshold float64 `mapstructure:"network_process_memory_strict_threshold" yaml:"network_process_memory_strict_threshold" toml:"network_process_memory_strict_threshold"` //nolint:lll // struct tags must stay on one line
261}
262
263// SearchShortcut represents a search shortcut configuration.
264type SearchShortcut struct {
265	URL         string `mapstructure:"url" toml:"url" yaml:"url" json:"url"`
266	Description string `mapstructure:"description" toml:"description" yaml:"description" json:"description"`
267}
268
269// ShortcutURLs returns a simple map of shortcut keys to URL templates.
270// This is useful for passing to url.BuildSearchURL.
271func (c *Config) ShortcutURLs() map[string]string {
272	result := make(map[string]string, len(c.SearchShortcuts))
273	for key, shortcut := range c.SearchShortcuts {
274		result[key] = shortcut.URL
275	}
276	return result
277}
278
279// DmenuConfig holds dmenu/rofi integration configuration.
280type DmenuConfig struct {
281	MaxHistoryDays   int    `mapstructure:"max_history_days" yaml:"max_history_days" toml:"max_history_days"`
282	ShowVisitCount   bool   `mapstructure:"show_visit_count" yaml:"show_visit_count" toml:"show_visit_count"`
283	ShowLastVisited  bool   `mapstructure:"show_last_visited" yaml:"show_last_visited" toml:"show_last_visited"`
284	HistoryPrefix    string `mapstructure:"history_prefix" yaml:"history_prefix" toml:"history_prefix"`
285	ShortcutPrefix   string `mapstructure:"shortcut_prefix" yaml:"shortcut_prefix" toml:"shortcut_prefix"`
286	URLPrefix        string `mapstructure:"url_prefix" yaml:"url_prefix" toml:"url_prefix"`
287	DateFormat       string `mapstructure:"date_format" yaml:"date_format" toml:"date_format"`
288	SortByVisitCount bool   `mapstructure:"sort_by_visit_count" yaml:"sort_by_visit_count" toml:"sort_by_visit_count"`
289}
290
291// LoggingConfig holds logging configuration.
292type LoggingConfig struct {
293	Level  string `mapstructure:"level" yaml:"level" toml:"level"`
294	Format string `mapstructure:"format" yaml:"format" toml:"format"`
295	MaxAge int    `mapstructure:"max_age" yaml:"max_age" toml:"max_age"`
296
297	// File output configuration
298	LogDir        string `mapstructure:"log_dir" yaml:"log_dir" toml:"log_dir"`
299	EnableFileLog bool   `mapstructure:"enable_file_log" yaml:"enable_file_log" toml:"enable_file_log"`
300
301	// Capture browser console to logs
302	CaptureConsole bool `mapstructure:"capture_console" yaml:"capture_console" toml:"capture_console" json:"capture_console"`
303}
304
305// AppearanceConfig holds UI/rendering preferences.
306type AppearanceConfig struct {
307	// Default fonts for pages that do not specify fonts.
308	SansFont      string `mapstructure:"sans_font" yaml:"sans_font" toml:"sans_font"`
309	SerifFont     string `mapstructure:"serif_font" yaml:"serif_font" toml:"serif_font"`
310	MonospaceFont string `mapstructure:"monospace_font" yaml:"monospace_font" toml:"monospace_font"`
311	// Default font size in CSS pixels (approx).
312	DefaultFontSize int          `mapstructure:"default_font_size" yaml:"default_font_size" toml:"default_font_size"`
313	LightPalette    ColorPalette `mapstructure:"light_palette" yaml:"light_palette" toml:"light_palette"`
314	DarkPalette     ColorPalette `mapstructure:"dark_palette" yaml:"dark_palette" toml:"dark_palette"`
315	// ColorScheme controls the initial theme preference: "prefer-dark", "prefer-light", or "default" (follows system)
316	ColorScheme string `mapstructure:"color_scheme" yaml:"color_scheme" toml:"color_scheme"`
317}
318
319// ColorPalette contains semantic color tokens for light/dark themes.
320type ColorPalette struct {
321	Background     string `mapstructure:"background" yaml:"background" toml:"background" json:"background"`
322	Surface        string `mapstructure:"surface" yaml:"surface" toml:"surface" json:"surface"`
323	SurfaceVariant string `mapstructure:"surface_variant" yaml:"surface_variant" toml:"surface_variant" json:"surface_variant"`
324	Text           string `mapstructure:"text" yaml:"text" toml:"text" json:"text"`
325	Muted          string `mapstructure:"muted" yaml:"muted" toml:"muted" json:"muted"`
326	Accent         string `mapstructure:"accent" yaml:"accent" toml:"accent" json:"accent"`
327	Border         string `mapstructure:"border" yaml:"border" toml:"border" json:"border"`
328}
329
330// ContentFilteringConfig holds content filtering and ad blocking preferences
331type ContentFilteringConfig struct {
332	// Enabled controls whether ad blocking is active (default: true)
333	Enabled bool `mapstructure:"enabled" yaml:"enabled" toml:"enabled"`
334	// AutoUpdate controls whether filters are automatically updated (default: true)
335	AutoUpdate bool `mapstructure:"auto_update" yaml:"auto_update" toml:"auto_update"`
336	// Note: Filters are downloaded from bnema/ublock-webkit-filters GitHub releases
337	// Note: Whitelist is managed via database (content_whitelist table)
338}
339
340// OmniboxConfig holds omnibox behavior preferences
341type OmniboxConfig struct {
342	// InitialBehavior controls what to show when omnibox opens with empty input
343	// Values: "recent" (recent visits), "most_visited" (most visited sites), "none" (nothing)
344	InitialBehavior string `mapstructure:"initial_behavior" yaml:"initial_behavior" toml:"initial_behavior"`
345	// AutoOpenOnNewPane opens the omnibox automatically when a new pane is created.
346	// Default: false
347	AutoOpenOnNewPane bool `mapstructure:"auto_open_on_new_pane" yaml:"auto_open_on_new_pane" toml:"auto_open_on_new_pane"`
348}
349
350// DebugConfig holds debug and troubleshooting options
351type DebugConfig struct {
352	// Enable browser developer tools (F12, Inspect Element in context menu)
353	EnableDevTools bool `mapstructure:"enable_devtools" yaml:"enable_devtools" toml:"enable_devtools"`
354}
355
356// UpdateConfig holds automatic update settings.
357type UpdateConfig struct {
358	// EnableOnStartup enables checking for updates when the browser starts.
359	// Default: true
360	EnableOnStartup bool `mapstructure:"enable_on_startup" yaml:"enable_on_startup" toml:"enable_on_startup"`
361	// AutoDownload automatically downloads updates in the background.
362	// When enabled, updates are applied on browser exit.
363	// Default: false
364	AutoDownload bool `mapstructure:"auto_download" yaml:"auto_download" toml:"auto_download"`
365	// NotifyOnNewSettings shows a toast notification on startup when new config settings are available.
366	// Default: true
367	NotifyOnNewSettings bool `mapstructure:"notify_on_new_settings" yaml:"notify_on_new_settings" toml:"notify_on_new_settings"`
368}
369
370// WorkspaceConfig captures layout, pane, and tab behavior preferences.
371type WorkspaceConfig struct {
372	// NewPaneURL is the URL loaded when creating a new empty pane/tab.
373	// Default: "about:blank"
374	NewPaneURL string `mapstructure:"new_pane_url" yaml:"new_pane_url" toml:"new_pane_url"`
375	// PaneMode defines modal pane behavior and bindings.
376	PaneMode PaneModeConfig `mapstructure:"pane_mode" yaml:"pane_mode" toml:"pane_mode" json:"pane_mode"`
377	// TabMode defines modal tab behavior and bindings (Alt+T).
378	TabMode TabModeConfig `mapstructure:"tab_mode" yaml:"tab_mode" toml:"tab_mode" json:"tab_mode"`
379	// ResizeMode defines modal pane resizing behavior and bindings (Ctrl+N).
380	ResizeMode ResizeModeConfig `mapstructure:"resize_mode" yaml:"resize_mode" toml:"resize_mode" json:"resize_mode"`
381	// Shortcuts holds global (non-modal) keyboard shortcuts.
382	Shortcuts GlobalShortcutsConfig `mapstructure:"shortcuts" yaml:"shortcuts" toml:"shortcuts" json:"shortcuts"`
383	// TabBarPosition determines tab bar placement: "top" or "bottom".
384	TabBarPosition string `mapstructure:"tab_bar_position" yaml:"tab_bar_position" toml:"tab_bar_position" json:"tab_bar_position"`
385	// HideTabBarWhenSingleTab hides the tab bar when only one tab exists.
386	HideTabBarWhenSingleTab bool `mapstructure:"hide_tab_bar_when_single_tab" yaml:"hide_tab_bar_when_single_tab" toml:"hide_tab_bar_when_single_tab" json:"hide_tab_bar_when_single_tab"` //nolint:lll // struct tags must stay on one line
387	// SwitchToTabOnMove controls whether moving a pane to another tab switches focus to that tab.
388	// Default: true
389	SwitchToTabOnMove bool `mapstructure:"switch_to_tab_on_move" yaml:"switch_to_tab_on_move" toml:"switch_to_tab_on_move" json:"switch_to_tab_on_move"` //nolint:lll // struct tags must stay on one line
390	// Popups configures default popup placement rules.
391	Popups PopupBehaviorConfig `mapstructure:"popups" yaml:"popups" toml:"popups" json:"popups"`
392	// Styling configures workspace visual appearance.
393	Styling WorkspaceStylingConfig `mapstructure:"styling" yaml:"styling" toml:"styling" json:"styling"`
394}
395
396// PaneModeConfig defines modal behavior for pane management.
397type PaneModeConfig struct {
398	ActivationShortcut  string              `mapstructure:"activation_shortcut" yaml:"activation_shortcut" toml:"activation_shortcut" json:"activation_shortcut"` //nolint:lll // struct tags must stay on one line
399	TimeoutMilliseconds int                 `mapstructure:"timeout_ms" yaml:"timeout_ms" toml:"timeout_ms" json:"timeout_ms"`
400	Actions             map[string][]string `mapstructure:"actions" yaml:"actions" toml:"actions" json:"actions"`
401}
402
403// GetKeyBindings returns an inverted map for O(1) key→action lookup.
404// This is built from the action→keys structure in the config.
405func (p *PaneModeConfig) GetKeyBindings() map[string]string {
406	keyToAction := make(map[string]string)
407	for action, keys := range p.Actions {
408		for _, key := range keys {
409			keyToAction[key] = action
410		}
411	}
412	return keyToAction
413}
414
415// TabModeConfig defines modal behavior for tab management (Zellij-style).
416type TabModeConfig struct {
417	ActivationShortcut  string              `mapstructure:"activation_shortcut" yaml:"activation_shortcut" toml:"activation_shortcut" json:"activation_shortcut"` //nolint:lll // struct tags must stay on one line
418	TimeoutMilliseconds int                 `mapstructure:"timeout_ms" yaml:"timeout_ms" toml:"timeout_ms" json:"timeout_ms"`
419	Actions             map[string][]string `mapstructure:"actions" yaml:"actions" toml:"actions" json:"actions"`
420}
421
422// GetKeyBindings returns an inverted map for O(1) key→action lookup.
423// This is built from the action→keys structure in the config.
424func (t *TabModeConfig) GetKeyBindings() map[string]string {
425	keyToAction := make(map[string]string)
426	for action, keys := range t.Actions {
427		for _, key := range keys {
428			keyToAction[key] = action
429		}
430	}
431	return keyToAction
432}
433
434// ResizeModeConfig defines modal behavior for resizing panes (Zellij-style).
435type ResizeModeConfig struct {
436	ActivationShortcut  string              `mapstructure:"activation_shortcut" yaml:"activation_shortcut" toml:"activation_shortcut" json:"activation_shortcut"` //nolint:lll // struct tags must stay on one line
437	TimeoutMilliseconds int                 `mapstructure:"timeout_ms" yaml:"timeout_ms" toml:"timeout_ms" json:"timeout_ms"`
438	StepPercent         float64             `mapstructure:"step_percent" yaml:"step_percent" toml:"step_percent" json:"step_percent"`
439	MinPanePercent      float64             `mapstructure:"min_pane_percent" yaml:"min_pane_percent" toml:"min_pane_percent" json:"min_pane_percent"` //nolint:lll // struct tags must stay on one line
440	Actions             map[string][]string `mapstructure:"actions" yaml:"actions" toml:"actions" json:"actions"`
441}
442
443// GetKeyBindings returns an inverted map for O(1) key→action lookup.
444// This is built from the action→keys structure in the config.
445func (r *ResizeModeConfig) GetKeyBindings() map[string]string {
446	keyToAction := make(map[string]string)
447	for action, keys := range r.Actions {
448		for _, key := range keys {
449			keyToAction[key] = action
450		}
451	}
452	return keyToAction
453}
454
455// GlobalShortcutsConfig defines global shortcuts (always active, not modal).
456type GlobalShortcutsConfig struct {
457	ClosePane   string `mapstructure:"close_pane" yaml:"close_pane" toml:"close_pane" json:"close_pane"`
458	NextTab     string `mapstructure:"next_tab" yaml:"next_tab" toml:"next_tab" json:"next_tab"`
459	PreviousTab string `mapstructure:"previous_tab" yaml:"previous_tab" toml:"previous_tab" json:"previous_tab"`
460
461	ConsumeOrExpelLeft  string `mapstructure:"consume_or_expel_left" yaml:"consume_or_expel_left" toml:"consume_or_expel_left" json:"consume_or_expel_left"`     //nolint:lll // struct tags must stay on one line
462	ConsumeOrExpelRight string `mapstructure:"consume_or_expel_right" yaml:"consume_or_expel_right" toml:"consume_or_expel_right" json:"consume_or_expel_right"` //nolint:lll // struct tags must stay on one line
463	ConsumeOrExpelUp    string `mapstructure:"consume_or_expel_up" yaml:"consume_or_expel_up" toml:"consume_or_expel_up" json:"consume_or_expel_up"`             //nolint:lll // struct tags must stay on one line
464	ConsumeOrExpelDown  string `mapstructure:"consume_or_expel_down" yaml:"consume_or_expel_down" toml:"consume_or_expel_down" json:"consume_or_expel_down"`     //nolint:lll // struct tags must stay on one line
465}
466
467// PopupBehavior defines how popup windows should be opened
468type PopupBehavior string
469
470const (
471	// PopupBehaviorSplit opens popups in a split pane (default)
472	PopupBehaviorSplit PopupBehavior = "split"
473	// PopupBehaviorStacked opens popups in a stacked pane
474	PopupBehaviorStacked PopupBehavior = "stacked"
475	// PopupBehaviorTabbed opens popups as a new tab
476	PopupBehaviorTabbed PopupBehavior = "tabbed"
477	// PopupBehaviorWindowed opens popups in a new workspace window
478	PopupBehaviorWindowed PopupBehavior = "windowed"
479)
480
481// PopupBehaviorConfig defines handling for popup windows.
482type PopupBehaviorConfig struct {
483	// Behavior determines how popups are opened (split/stacked/tabbed/windowed)
484	Behavior PopupBehavior `mapstructure:"behavior" yaml:"behavior" toml:"behavior" json:"behavior"`
485
486	// Placement specifies direction for split behavior ("right", "left", "top", "bottom")
487	// Only used when Behavior is "split"
488	Placement string `mapstructure:"placement" yaml:"placement" toml:"placement" json:"placement"`
489
490	// OpenInNewPane controls whether popups are opened in workspace or blocked
491	OpenInNewPane bool `mapstructure:"open_in_new_pane" yaml:"open_in_new_pane" toml:"open_in_new_pane" json:"open_in_new_pane"`
492
493	// FollowPaneContext determines if popup placement follows parent pane context
494	FollowPaneContext bool `mapstructure:"follow_pane_context" yaml:"follow_pane_context" toml:"follow_pane_context" json:"follow_pane_context"` //nolint:lll // struct tags must stay on one line
495
496	// BlankTargetBehavior determines how target="_blank" links are opened
497	// Accepted values: "split", "stacked" (default), "tabbed"
498	// This is separate from Behavior which controls JavaScript popups
499	BlankTargetBehavior string `mapstructure:"blank_target_behavior" yaml:"blank_target_behavior" toml:"blank_target_behavior" json:"blank_target_behavior"` //nolint:lll // struct tags must stay on one line
500
501	// EnableSmartDetection uses WebKitWindowProperties to detect popup vs tab intents
502	EnableSmartDetection bool `mapstructure:"enable_smart_detection" yaml:"enable_smart_detection" toml:"enable_smart_detection" json:"enable_smart_detection"` //nolint:lll // struct tags must stay on one line
503
504	// OAuthAutoClose enables auto-closing OAuth popups after successful auth redirects
505	OAuthAutoClose bool `mapstructure:"oauth_auto_close" yaml:"oauth_auto_close" toml:"oauth_auto_close" json:"oauth_auto_close"`
506}
507
508// WorkspaceStylingConfig defines visual styling for workspace panes.
509type WorkspaceStylingConfig struct {
510	// BorderWidth in pixels for active pane borders (overlay)
511	BorderWidth int `mapstructure:"border_width" yaml:"border_width" toml:"border_width" json:"border_width"`
512	// BorderColor for focused panes (CSS color value or theme variable)
513	BorderColor string `mapstructure:"border_color" yaml:"border_color" toml:"border_color" json:"border_color"`
514
515	// ModeBorderWidth in pixels for all mode indicator borders (pane, tab, session, resize)
516	ModeBorderWidth int `mapstructure:"mode_border_width" yaml:"mode_border_width" toml:"mode_border_width" json:"mode_border_width"` //nolint:lll // struct tags must stay on one line
517
518	// PaneModeColor for pane mode indicator (border and toaster). Defaults to "#4A90E2" (blue)
519	PaneModeColor string `mapstructure:"pane_mode_color" yaml:"pane_mode_color" toml:"pane_mode_color" json:"pane_mode_color"` //nolint:lll // struct tags must stay on one line
520	// TabModeColor for tab mode indicator (border and toaster). Defaults to "#FFA500" (orange)
521	TabModeColor string `mapstructure:"tab_mode_color" yaml:"tab_mode_color" toml:"tab_mode_color" json:"tab_mode_color"` //nolint:lll // struct tags must stay on one line
522	// SessionModeColor for session mode indicator (border and toaster). Defaults to "#9B59B6" (purple)
523	SessionModeColor string `mapstructure:"session_mode_color" yaml:"session_mode_color" toml:"session_mode_color" json:"session_mode_color"` //nolint:lll // struct tags must stay on one line
524	// ResizeModeColor for resize mode indicator (border and toaster). Defaults to "#00D4AA" (teal)
525	ResizeModeColor string `mapstructure:"resize_mode_color" yaml:"resize_mode_color" toml:"resize_mode_color" json:"resize_mode_color"` //nolint:lll // struct tags must stay on one line
526
527	// ModeIndicatorToasterEnabled shows a toaster notification when modal modes are active.
528	// Default: true
529	ModeIndicatorToasterEnabled bool `mapstructure:"mode_indicator_toaster_enabled" yaml:"mode_indicator_toaster_enabled" toml:"mode_indicator_toaster_enabled" json:"mode_indicator_toaster_enabled"` //nolint:lll // struct tags must stay on one line
530
531	// TransitionDuration in milliseconds for border animations
532	TransitionDuration int `mapstructure:"transition_duration" yaml:"transition_duration" toml:"transition_duration" json:"transition_duration"` //nolint:lll // struct tags must stay on one line
533}
534
535// SessionConfig holds session persistence settings.
536type SessionConfig struct {
537	// AutoRestore automatically restores the last session on startup.
538	// Default: false
539	AutoRestore bool `mapstructure:"auto_restore" yaml:"auto_restore" toml:"auto_restore" json:"auto_restore"`
540
541	// SnapshotIntervalMs is the minimum interval between snapshots in milliseconds.
542	// Default: 5000
543	SnapshotIntervalMs int `mapstructure:"snapshot_interval_ms" yaml:"snapshot_interval_ms" toml:"snapshot_interval_ms" json:"snapshot_interval_ms"` //nolint:lll // struct tags must stay on one line
544
545	// MaxExitedSessions is the maximum number of exited sessions to keep.
546	// Default: 50
547	MaxExitedSessions int `mapstructure:"max_exited_sessions" yaml:"max_exited_sessions" toml:"max_exited_sessions" json:"max_exited_sessions"` //nolint:lll // struct tags must stay on one line
548
549	// MaxExitedSessionAgeDays is the maximum age in days for exited sessions.
550	// Sessions older than this will be automatically deleted on startup.
551	// Default: 7
552	MaxExitedSessionAgeDays int `mapstructure:"max_exited_session_age_days" yaml:"max_exited_session_age_days" toml:"max_exited_session_age_days" json:"max_exited_session_age_days"` //nolint:lll // struct tags must stay on one line
553
554	// SessionMode defines modal behavior for session management (Ctrl+O).
555	SessionMode SessionModeConfig `mapstructure:"session_mode" yaml:"session_mode" toml:"session_mode" json:"session_mode"`
556}
557
558// SessionModeConfig defines modal behavior for session management.
559type SessionModeConfig struct {
560	ActivationShortcut  string              `mapstructure:"activation_shortcut" yaml:"activation_shortcut" toml:"activation_shortcut" json:"activation_shortcut"` //nolint:lll // struct tags must stay on one line
561	TimeoutMilliseconds int                 `mapstructure:"timeout_ms" yaml:"timeout_ms" toml:"timeout_ms" json:"timeout_ms"`
562	Actions             map[string][]string `mapstructure:"actions" yaml:"actions" toml:"actions" json:"actions"`
563}
564
565// GetKeyBindings returns an inverted map for O(1) key→action lookup.
566// This is built from the action→keys structure in the config.
567func (s *SessionModeConfig) GetKeyBindings() map[string]string {
568	keyToAction := make(map[string]string)
569	for action, keys := range s.Actions {
570		for _, key := range keys {
571			keyToAction[key] = action
572		}
573	}
574	return keyToAction
575}

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 8

Tags 42

↑↓ moveenter openesc close