Reference - Wakterm documentation

Skip to content

Wakterm

Search Wakterm documentation

Documentation

wakterm

Features
What is a Terminal?
Agent Harness Lifecycle
Agent Prompt Submission
Agent API v1 Contract
Experimental Agent Output
Scrollback
Quick Select Mode
Copy Mode
Hyperlinks
Escape Sequences
Shell Integration
iTerm Image Protocol
SSH
Serial Ports & Arduino
Multiplexing

Download

Windows
macOS
Linux
FreeBSD
NetBSD
Build from source

Configuration

Colors & Appearance
Color Schemes
Launching Programs
Fonts
Font Shaping
Keyboard Concepts
Key Binding
Key Tables
Default Key Assignments
Keyboard Encoding
Mouse Binding
Plugins
Recipes3 sub-pages

Configuration Reference

Config Options181 sub-pages
module: wakterm54 sub-pages
module: wakterm.color10 sub-pages
module: wakterm.gui7 sub-pages
module: wakterm.mux12 sub-pages
module: wakterm.plugin3 sub-pages
module: wakterm.procinfo4 sub-pages
module: wakterm.serde8 sub-pages
module: wakterm.time4 sub-pages
module: wakterm.url2 sub-pages
enum: KeyAssignment88 sub-pages
enum: CopyModeAssignment33 sub-pages
object: Color20 sub-pages
object: ExecDomain
object: LocalProcessInfo
object: MuxDomain8 sub-pages
object: MuxWindow11 sub-pages
object: MuxTab13 sub-pages
object: PaneInformation
object: TabInformation
object: SshDomain
object: SpawnCommand
object: Time3 sub-pages
object: TlsDomainClient
object: TlsDomainServer
object: Pane32 sub-pages
object: Window29 sub-pages
object: WslDomain
events: Gui2 sub-pages
events: Multiplexer2 sub-pages
events: Window12 sub-pages

CLI Reference

wakterm agent
wakterm cli19 sub-pages
wakterm connect
wakterm imgcat
wakterm ls-fonts
wakterm record
wakterm replay
wakterm serial
wakterm set-working-directory
wakterm show-keys
wakterm ssh
wakterm start

Get Help

Troubleshooting
F.A.Q.
Getting Help
Contributing

Pages

Config Options
Lua
Configuration Reference