User documents

Afterglow is a Linux terminal with GPU rendering, tabs, splits, shell integration and Luau scripts.

TaskDocument
Build or installBuild instructions
Set fonts, colors or themesAppearance
Find a setting or default bindingConfiguration reference
Use keybindings, the mouse, touchpads, touchscreens, selection, search or hintsInput
Move panes or save layoutsProjects
Keep terminal sessions running, and show them in windowsThe mux daemon
Control a running instanceCommand line and control socket
Run the commands of scripts from a shell with aglow runScript commands
Run script commands from a remote host in an afterglow ssh sessionRemote commands
Run a program such as fzf over a pane, or in a popupOverlays and afterglow ctl overlay
Save a picture of a pane as it shows on the screenScreenshots
Write scriptsLuau API
Install or write packagesPackages and state
Configure reactive effectsShaders
Write shader passesShader API
Use accessibility, input methods, file and text drops, Kitty file transfer and drag and drop, or the aglow clientDesktop integration
Use bidirectional textBidirectional text
Check protocol supportCompatibility
Read what Afterglow supportsRelease notes
Run testsTesting
Measure performancePerformance
Write documentationWriting rules

First configuration

The usual configuration path is ~/.config/afterglow/config.json. See the configuration file for its format and an example.

Afterglow reloads configuration changes automatically. Shell integration starts automatically for supported Bash, Zsh and Fish versions. The command palette contains prompt navigation, output, search and project actions.

Example files do not activate themselves. Copy a complete package directory into ~/.config/afterglow/scripts/ to install it. Keep the directory name, manifest ID and module filenames unchanged. Follow the package’s instructions for required settings. Reopen the palette after reload to see new commands.

afterglow --help lists launch options. afterglow ctl --help lists live control commands. afterglow mux --help lists the commands of afterglow mux, which create, list and end the sessions of the mux daemon. afterglow --config-reference prints the runtime schema without a window or user configuration. Use the option alone.

Mirrored from docs/README.md in the Afterglow repository.