Skip to content

wezterm-cli: add page; wezterm: update page #17224

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

Merged
merged 2 commits into from
Jul 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions pages/common/wezterm-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# wezterm cli

> Interact with a running Wezterm GUI or multiplexer.
> More information: <https://wezterm.org/cli/cli/index.html>.

- List windows, tabs, and panes:

`wezterm cli list`

- Split the current pane and print the new pane's ID to `stdout`:

`wezterm cli split-pane --{{left|right|top|bottom}} --{{cells|percent}} {{n}}`

- Activate (focus) a pane:

`wezterm cli activate-pane --pane-id {{id}}`

- Kill a pane:

`wezterm cli kill-pane --pane-id {{id}}`
7 changes: 4 additions & 3 deletions pages/common/wezterm.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# wezterm

> Wez's Terminal Emulator - a powerful cross-platform terminal emulator and multiplexer.
> Some subcommands such as `cli` have their own usage documentation.
> More information: <https://wezterm.org/cli/general>.

- Start a new Wezterm process and create a window:

`wezterm`

- Establish an `ssh` session:
- Establish an `ssh` session in a new Wezterm window:

`wezterm ssh {{user}}@{{host}}:{{port}}`

Expand All @@ -19,11 +20,11 @@

`wezterm imgcat {{path/to/image}}`

- Record a terminal session as an asciicat (by default recordings are found in `/tmp`):
- Record a terminal session as an asciicast (by default recordings are saved to `/tmp`):

`wezterm record`

- Replay an asciicat terminal session:
- Replay an asciicast terminal session:

`wezterm replay {{path/to/cast_file}}`

Expand Down