ghostty

package
v1.7.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 30, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ActionAlphaBlendings added in v1.6.0 

func ActionAlphaBlendings() carapace.Action

ActionAlphaBlendings completes alpha blendings 

native (Perform alpha blending in the native color space for the OS)
linear (Perform alpha blending in linear space)

func ActionAsyncBackends added in v1.6.0 

func ActionAsyncBackends() carapace.Action

ActionAsyncBackends completes async backends 

epoll (Use the `epoll` API)
io_uring (Use the `io_uring` API)

func ActionAutoUpdateModes 

func ActionAutoUpdateModes() carapace.Action

ActionAutoUpdateModes completes auto update modes 

off (Disable auto-updates)
check (Check for updates)

func ActionBackgroundBlurs added in v1.7.1 

func ActionBackgroundBlurs() carapace.Action

ActionBackgroundBlurs completes background blur modes 

false (equivalent to a blur intensity of 0)
true (equivalent to the default blur intensity of 20)

func ActionBackgroundImageFits added in v1.6.0 

func ActionBackgroundImageFits() carapace.Action

ActionBackgroundImageFits completes background image fits 

contain (scale to the largest size that can still be contained)
cover (scale to the smallest size that can completely cover the terminal)

func ActionBackgroundImagePositions added in v1.6.0 

func ActionBackgroundImagePositions() carapace.Action

ActionBackgroundImagePositions completes background image positions 

top-left
top-center

func ActionBellFeatures added in v1.6.0 

func ActionBellFeatures() carapace.Action

ActionBellFeatures completes bell features 

audio (Play a custom sound)
attention (Request the user's attention when Ghostty is unfocused)

func ActionClipboardPermissions added in v1.7.1 

func ActionClipboardPermissions() carapace.Action

ActionClipboardPermissions completes clipboard permissions 

ask (Ask the user for permission each time a program tries to access the clipboard)
allow (Allow clipboard access without prompting)

func ActionConfirmCloseSurfaces added in v1.7.1 

func ActionConfirmCloseSurfaces() carapace.Action

ActionConfirmCloseSurfaces completes confirm-close-surface modes 

true (Always confirm before closing)
false (Never confirm before closing)

func ActionCopyOnSelectModes 

func ActionCopyOnSelectModes() carapace.Action

ActionCopyOnSelectModes completes copy-on-select modes 

true (prefer to copy to the selection clipboard if supported by the OS)
clipboard (always copy text to the selection clipboard)

func ActionCursorStyleBlinks() carapace.Action

ActionCursorStyleBlinks completes cursor style blink modes 

true (The cursor blinks by default)
false (The cursor does not blink)

func ActionCursorStyles 

func ActionCursorStyles() carapace.Action

ActionCursorStyles completes cursor styles 

block
bar

func ActionFontFamilies added in v1.6.0 

func ActionFontFamilies() carapace.Action

ActionFontFamilies completes font families 

FreeMono
FreeSans

func ActionFontShapingBreaks added in v1.7.1 

func ActionFontShapingBreaks() carapace.Action

ActionFontShapingBreaks completes font shaping break modes 

cursor (Break runs under the cursor)

func ActionFontSyntheticStyles 

func ActionFontSyntheticStyles() carapace.Action

ActionFontSyntheticStyles completes font synthetic styles 

false (completely disable)
italic (apply a slant to the glyph)

func ActionFreetypeLoadFlags 

func ActionFreetypeLoadFlags() carapace.Action

ActionFreetypeLoadFlags completes freetype load flags 

hinting (Enable hinting)
force-autohint (Use the freetype auto-hinter)

func ActionFullscreens added in v1.7.1 

func ActionFullscreens() carapace.Action

ActionFullscreens completes fullscreen modes 

false (Do not start in fullscreen)
true (Start in native fullscreen)
non-native (Start in non-native fullscreen)
non-native-visible-menu (Start in non-native fullscreen, keep menu bar visible)
non-native-padded-notch (Start in non-native fullscreen, hide menu bar but pad for notch)

func ActionGraphemeWidthMethods 

func ActionGraphemeWidthMethods() carapace.Action

ActionGraphemeWidthMethods completes grapheme width methods 

legacy (Use a legacy method to determine grapheme width)
unicode (Use the Unicode standard to determine grapheme width)

func ActionGtkQuickTerminalLayers added in v1.7.1 

func ActionGtkQuickTerminalLayers() carapace.Action

ActionGtkQuickTerminalLayers completes gtk quick terminal layers 

overlay (appears in front of all windows)
top (appears in front of normal windows but behind fullscreen overlays)

func ActionGtkSingleInstances added in v1.7.1 

func ActionGtkSingleInstances() carapace.Action

ActionGtkSingleInstances completes gtk single instance modes 

true (Run in single-instance mode)
false (Do not run in single-instance mode)

func ActionGtkTabsLocations added in v1.7.1 

func ActionGtkTabsLocations() carapace.Action

ActionGtkTabsLocations completes gtk tabs locations 

top (Tab bar at the top of the window)
bottom (Tab bar at the bottom of the window)

func ActionGtkTitlebarStyles added in v1.7.1 

func ActionGtkTitlebarStyles() carapace.Action

ActionGtkTitlebarStyles completes gtk titlebar styles 

native (traditional titlebar with a title)
tabs (merges the tab bar and the traditional titlebar)

func ActionGtkToolbarStyles added in v1.6.0 

func ActionGtkToolbarStyles() carapace.Action

ActionGtkToolbarStyles completes adw toolbar styles 

flat (Top and bottom bars are flat with the terminal window)
raised (Top and bottom bars cast a shadow on the terminal area)

func ActionInputTypes added in v1.7.1 

func ActionInputTypes() carapace.Action

ActionInputTypes completes input types 

raw (Send raw text as-is)
path (Read a filepath and send the contents)

func ActionLinkPreviewses added in v1.7.1 

func ActionLinkPreviewses() carapace.Action

ActionLinkPreviewses completes link preview modes 

true (Show link previews for matched URLs)
false (Do not show link previews)

func ActionLinuxCgroups added in v1.7.1 

func ActionLinuxCgroups() carapace.Action

ActionLinuxCgroups completes linux cgroup modes 

never (Never use cgroups)
always (Always use cgroups)

func ActionMacFullscreenModes 

func ActionMacFullscreenModes() carapace.Action

ActionMacFullscreenModes completes mac fullscreen modes 

visible-menu (Use non-native macOS fullscreen, keep the menu bar visible)
true (Use non-native macOS fullscreen, hide the menu bar)

func ActionMacIconFrames 

func ActionMacIconFrames() carapace.Action

ActionMacIconFrames completes mac icon frames 

aluminum
beige

func ActionMacIcons 

func ActionMacIcons() carapace.Action

ActionMacIcons completes mac icons 

official (Use the official Ghostty icon)
custom-style (Use the official Ghostty icon but with custom styles)

func ActionMacTitlebarStyles 

func ActionMacTitlebarStyles() carapace.Action

ActionMacTitlebarStyles completes mac titlebar styles 

native (native macOS titlebar with zero customization)
transparent (same as "native" but the titlebar will be transparent)

func ActionMacosDockDropBehaviors added in v1.7.1 

func ActionMacosDockDropBehaviors() carapace.Action

ActionMacosDockDropBehaviors completes macos dock drop behaviors 

new-tab (Create a new tab in the current window)
new-window (Create a new window unconditionally)

func ActionMacosHiddenModes added in v1.7.1 

func ActionMacosHiddenModes() carapace.Action

ActionMacosHiddenModes completes macos hidden modes 

never (The macOS app is never hidden)
always (The macOS app is always hidden)

func ActionMacosOptionsAsAlt added in v1.7.1 

func ActionMacosOptionsAsAlt() carapace.Action

ActionMacosOptionsAsAlt completes macos option-as-alt modes 

false (Do not treat the Option key as Alt)
true (Treat both left and right Option keys as Alt)

func ActionMacosShortcuts added in v1.7.1 

func ActionMacosShortcuts() carapace.Action

ActionMacosShortcuts completes macos shortcuts modes 

ask (Ask the user for permission)
allow (Allow Shortcuts to control Ghostty without asking)

func ActionMacosTitlebarProxyIcons added in v1.7.1 

func ActionMacosTitlebarProxyIcons() carapace.Action

ActionMacosTitlebarProxyIcons completes macos titlebar proxy icon visibility 

visible (Show the proxy icon)
hidden (Hide the proxy icon)

func ActionMacosWindowButtons added in v1.7.1 

func ActionMacosWindowButtons() carapace.Action

ActionMacosWindowButtons completes macos window buttons visibility 

visible (Show the window buttons)
hidden (Hide the window buttons)

func ActionMouseShiftCaptureModes 

func ActionMouseShiftCaptureModes() carapace.Action

ActionMouseShiftCaptureModes completes mouse shift capture modes 

always (always capture)
never (never capture)

func ActionNotifications added in v1.6.0 

func ActionNotifications() carapace.Action

ActionNotifications completes app notifications 

clipboard-copy (Show a notification when text is copied to the clipboard)
config-reload (Show a notification when the configuration is reloaded)

func ActionNotifyOnCommandFinishActions added in v1.7.1 

func ActionNotifyOnCommandFinishActions() carapace.Action

ActionNotifyOnCommandFinishActions completes notify on command finish actions 

bell (enabled by default)
notify (disabled by default)

func ActionNotifyOnCommandFinishes added in v1.7.1 

func ActionNotifyOnCommandFinishes() carapace.Action

ActionNotifyOnCommandFinishes completes notify on command finish modes 

never (Never send notifications)
unfocused (Only send notifications if the surface is not focused)

func ActionOscColorReportFormats 

func ActionOscColorReportFormats() carapace.Action

ActionOscColorReportFormats completes osc color report formats 

none (OSC 4/10/11 queries receive no reply)
8-bit (Color components are return unscaled)

func ActionQuickTerminalKeyboardInteractivities added in v1.7.1 

func ActionQuickTerminalKeyboardInteractivities() carapace.Action

ActionQuickTerminalKeyboardInteractivities completes quick terminal keyboard interactivity modes 

none (The quick terminal will not receive any keyboard input)
on-demand (The quick terminal would only receive keyboard input when it is focused)

func ActionQuickTerminalPositions 

func ActionQuickTerminalPositions() carapace.Action

ActionQuickTerminalPositions completes quick terminal positions 

top (Terminal appears at the top of the screen)
bottom (Terminal appears at the bottom of the screen)

func ActionQuickTerminalScreens 

func ActionQuickTerminalScreens() carapace.Action

ActionQuickTerminalScreens completes quick terminal screens 

main (The screen that the operating system recommends as the main screen)
mouse (The screen that the mouse is currently hovered over)

func ActionQuickTerminalSpaceBehaviors added in v1.7.1 

func ActionQuickTerminalSpaceBehaviors() carapace.Action

ActionQuickTerminalSpaceBehaviors completes quick terminal space behaviors 

move (quick terminal moved to the current space)
remain (quick terminal stays in the original space)

func ActionReleaseChannels 

func ActionReleaseChannels() carapace.Action

ActionReleaseChannels completes release channels 

stable (Stable, tagged releases such as \"1.0.0\")
tip (Pre-release versions generated from each commit to the main branch)

func ActionResizeOverlayModes 

func ActionResizeOverlayModes() carapace.Action

ActionResizeOverlayModes completes resize overlay modes 

always (Always show resize overlays)
never (Never show resize overlays)

func ActionResizeOverlayPositions 

func ActionResizeOverlayPositions() carapace.Action

ActionResizeOverlayPositions completes resize overlay positions 

center
top-left

func ActionRightClickActions added in v1.7.1 

func ActionRightClickActions() carapace.Action

ActionRightClickActions completes right click actions 

context-menu (Show the context menu)
paste (Paste the contents of the clipboard)

func ActionScrollToBottoms added in v1.7.1 

func ActionScrollToBottoms() carapace.Action

ActionScrollToBottoms completes scroll-to-bottom modes 

keystroke (scroll the surface to the bottom when the user presses a key)
output (scroll the surface to the bottom if there is new data to display)

func ActionScrollbarModes added in v1.7.1 

func ActionScrollbarModes() carapace.Action

ActionScrollbarModes completes scrollbar modes 

system (Respect the system settings)
never (Never show a scrollbar)

func ActionShaderAnimationModes 

func ActionShaderAnimationModes() carapace.Action

ActionShaderAnimationModes completes shader animation modes 

true (run an animation loop when custom shaders are used)
false (only render when the terminal is updated)

func ActionShellIntegrationFeatures 

func ActionShellIntegrationFeatures() carapace.Action

ActionShellIntegrationFeatures completes shell integration features 

cursor (Set the cursor to a blinking bar at the prompt)
sudo (Set sudo wrapper to preserve terminfo)

func ActionShellIntegrationModes 

func ActionShellIntegrationModes() carapace.Action

ActionShellIntegrationModes completes shell integration modes 

none (Do not do any automatic injection)
detect (Detect the shell based on the filename)

func ActionSplitPreserveZooms added in v1.7.1 

func ActionSplitPreserveZooms() carapace.Action

ActionSplitPreserveZooms completes split preserve zoom modes 

navigation (preserve the zoomed split state when navigating)

func ActionTerms added in v1.7.1 

func ActionTerms() carapace.Action

ActionTerms completes TERM values 

xterm-ghostty
xterm-256color

func ActionThemes added in v1.6.0 

func ActionThemes() carapace.Action

ActionThemes completes themes 

Atom
Ayu

func ActionWindowColorspaces added in v1.7.1 

func ActionWindowColorspaces() carapace.Action

ActionWindowColorspaces completes window colorspaces 

srgb
display-p3

func ActionWindowDecorations added in v1.7.1 

func ActionWindowDecorations() carapace.Action

ActionWindowDecorations completes window decoration modes 

none (No window decorations)
auto (Automatically choose window decorations)

func ActionWindowNewTabPositions 

func ActionWindowNewTabPositions() carapace.Action

ActionWindowNewTabPositions completes window tab positions 

"current (Insert the new tab after the currently focused tab)
"end (Insert the new tab at the end of the tab list)

func ActionWindowPaddingColors 

func ActionWindowPaddingColors() carapace.Action

ActionWindowPaddingColors completes window padding colors 

background (The background color specified in `background`)
extend (Extend the background color of the nearest grid cell)

func ActionWindowSaveStates 

func ActionWindowSaveStates() carapace.Action

ActionWindowSaveStates completes window save states 

default (will use the default system behavior)
never (will never save window state)

func ActionWindowShowTabBars added in v1.7.1 

func ActionWindowShowTabBars() carapace.Action

ActionWindowShowTabBars completes window show tab bar modes 

always (Always display the tab bar)
auto (Automatically show and hide the tab bar)

func ActionWindowSubtitles added in v1.7.1 

func ActionWindowSubtitles() carapace.Action

ActionWindowSubtitles completes window subtitle modes 

false (Disable the subtitle)
working-directory (Set the subtitle to the working directory)

func ActionWindowThemes 

func ActionWindowThemes() carapace.Action

ActionWindowThemes completes window themes 

auto (Determine the theme based on the configured terminal background color)
system (Use the system theme)

func Uid added in v1.7.1 

func Uid(host string, opts ...string) func(s string, uc uid.Context) (*url.URL, error)

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.