Page request: Ghostty Terminal 1.0 public release #15371
Labels
help wanted
You can help make tldr-pages better!
new command
Issues requesting creation of a new page.
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 thefont-family
key can be set withghostty --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.
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
iszig-out
if you're building from source (or the specified--prefix
flag). On macOS,$prefix
is the Contents/Resources subdirectory of the.app
bundle.There are man pages in the
$prefix/share/man
directory. This directory is created when you build or install Ghostty.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.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.
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
ghostty +list-themes
ghostty +list-fonts
The text was updated successfully, but these errors were encountered: