User documents
Afterglow is a Linux terminal with GPU rendering, tabs, splits, shell integration and Luau scripts.
| Task | Document |
|---|---|
| Build or install | Build instructions |
| Set fonts, colors or themes | Appearance |
| Find a setting or default binding | Configuration reference |
| Use keybindings, the mouse, touchpads, touchscreens, selection, search or hints | Input |
| Move panes or save layouts | Projects |
| Keep terminal sessions running, and show them in windows | The mux daemon |
| Control a running instance | Command line and control socket |
Run the commands of scripts from a shell with aglow run | Script commands |
Run script commands from a remote host in an afterglow ssh session | Remote commands |
| Run a program such as fzf over a pane, or in a popup | Overlays and afterglow ctl overlay |
| Save a picture of a pane as it shows on the screen | Screenshots |
| Write scripts | Luau API |
| Install or write packages | Packages and state |
| Configure reactive effects | Shaders |
| Write shader passes | Shader API |
Use accessibility, input methods, file and text drops, Kitty file transfer and drag and drop, or the aglow client | Desktop integration |
| Use bidirectional text | Bidirectional text |
| Check protocol support | Compatibility |
| Read what Afterglow supports | Release notes |
| Run tests | Testing |
| Measure performance | Performance |
| Write documentation | Writing 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.