Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Page request: Ghostty Terminal 1.0 public release #15371

Open
robbyrob42 opened this issue Dec 27, 2024 · 0 comments
Open

Page request: Ghostty Terminal 1.0 public release #15371

robbyrob42 opened this issue Dec 27, 2024 · 0 comments
Labels
help wanted You can help make tldr-pages better! new command Issues requesting creation of a new page.

Comments

@robbyrob42
Copy link

Command description

Ghostty, a new terminal emulator built with Zig has been public released 1.0 on 12/26/2024.

it has some nice features invokeable from the command line. The public release supports MacOS and Linux distributions.

from their docs:

Config Option Invocation:

Every configuration key is a valid CLI flag when launching Ghostty from the command-line. For example, the background key can be set with ghostty --background=282c34. Or the font-family key can be set with ghostty --font-family="JetBrains Mono".

Offline Reference Documentation

There are multiple places to find documentation on the configuration options besides the website. All locations are identical (they're all generated from the same source).

Tip

The online reference documentation is available here.

  1. There are HTML and Markdown formatted docs in the $prefix/share/ghostty/docs directory. This directory is created when you build or install Ghostty. The $prefix is zig-out if you're building from source (or the specified --prefix flag). On macOS, $prefix is the Contents/Resources subdirectory of the .app bundle.

  2. There are man pages in the $prefix/share/man directory. This directory is created when you build or install Ghostty.

  3. In the CLI, you can run ghostty +show-config --default --docs. Note that this will output the full default configuration with docs to stdout, so you may want to pipe that through a pager, an editor, etc.

  4. In the source code, you can find the configuration structure in the Config structure. The available keys are the keys verbatim, and their possible values are typically documented in the comments.

  5. Not documentation per se, but you can search for the public config files of many Ghostty users for examples and inspiration.

Note

You may see strange looking blank configurations like font-family =. This is a valid syntax to specify the default behavior (no value). The +show-config outputs it so it's clear that key is defaulting and also to have something to attach the doc comment to.

Command details

ghostty +list-fonts ; ghostty +list-themes ; ghostty +list-actions

Documentation

https://ghostty.org/docs/config/reference

Platform

Common

VCS repository link (e.g. GitHub, GitLab)

https://github.com/ghostty-org/ghostty

Additional information

ghostty +list-actions

ignore
unbind
csi
esc
cursor_key
reset
copy_to_clipboard
increase_font_size
reset_font_size
clear_screen
select_all
scroll_to_top
adjust_selection
jump_to_prompt
write_scrollback_file
write_screen_file
write_selection_file
new_window
new_tab
previous_tab
next_tab
last_tab
goto_tab
move_tab
toggle_tab_overview
new_split
goto_split
toggle_split_zoom
resize_split
equalize_splits
inspector
open_config
reload_config
close_surface
close_window
close_all_windows
toggle_fullscreen
toggle_window_decorations
toggle_secure_input
toggle_quick_terminal
toggle_visibility
quit
crash

ghostty +list-themes
Image

ghostty +list-fonts

Andale Mono
  Andale Mono

Courier New
  Courier New
  Courier New Bold
  Courier New Bold Italic
  Courier New Italic

Hack Nerd Font Mono
  Hack Nerd Font Mono Bold
  Hack Nerd Font Mono Bold Italic
  Hack Nerd Font Mono Italic
  Hack Nerd Font Mono Regular

Lantinghei TC
  Lantinghei TC Demibold
  Lantinghei TC Extralight
  Lantinghei TC Heavy

Menlo
  Menlo Bold
  Menlo Bold Italic
  Menlo Italic
  Menlo Regular

Monaco
  Monaco

Osaka
  Osaka-Mono

PCMyungjo
  PCMyungjo Regular

PT Mono
  PT Mono
  PT Mono Bold

SauceCodePro Nerd Font
  SauceCodePro NF
  SauceCodePro NF Black
  SauceCodePro NF Black Italic
  SauceCodePro NF Bold
  SauceCodePro NF Bold Italic
  SauceCodePro NF ExtraLight
  SauceCodePro NF ExtraLight Italic
  SauceCodePro NF Italic
  SauceCodePro NF Light
  SauceCodePro NF Light Italic
  SauceCodePro NF Medium
  SauceCodePro NF Medium Italic
  SauceCodePro NF SemiBold
  SauceCodePro NF SemiBold Italic

SauceCodePro Nerd Font Mono
  SauceCodePro NFM
  SauceCodePro NFM Black
  SauceCodePro NFM Black Italic
  SauceCodePro NFM Bold
  SauceCodePro NFM Bold Italic
  SauceCodePro NFM ExtraLight
  SauceCodePro NFM ExtraLight Italic
  SauceCodePro NFM Italic
  SauceCodePro NFM Light
  SauceCodePro NFM Light Italic
  SauceCodePro NFM Medium
  SauceCodePro NFM Medium Italic
  SauceCodePro NFM SemiBold
  SauceCodePro NFM SemiBold Italic

SpaceMono Nerd Font
  SpaceMono Nerd Font
  SpaceMono Nerd Font Bold
  SpaceMono Nerd Font Bold Italic
  SpaceMono Nerd Font Italic

SpaceMono Nerd Font Mono
  SpaceMono Nerd Font Mono
  SpaceMono Nerd Font Mono Bold
  SpaceMono Nerd Font Mono Bold Italic
  SpaceMono Nerd Font Mono Italic

@robbyrob42 robbyrob42 added help wanted You can help make tldr-pages better! new command Issues requesting creation of a new page. labels Dec 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted You can help make tldr-pages better! new command Issues requesting creation of a new page.
Projects
None yet
Development

No branches or pull requests

1 participant