pane:get_current_working_dir()

Since: Version 20201031-154415-9614e117

The functionality described in this section requires version 20201031-154415-9614e117 of wezterm, or a more recent version.

Returns the current working directory of the pane, if known. The current directory can be specified by an application sending OSC 7.

If OSC 7 was never sent to a pane, and the pane represents a locally spawned process, then wezterm will:

• On Unix systems, determie the process group leader attached to the PTY
• On Windows systems, use heuristics to infer an equivalent to the foreground process

With the process identified, wezterm will then try to determine the current working directory using operating system dependent code:

OS	Supported?
macOS	Yes, (Since: Version 20201031-154415-9614e117)
Linux	Yes, (Since: Version 20201031-154415-9614e117)
Windows	Yes, (Since: Version 20220101-133340-7edc5b5a)

If the current working directory is not known then this method returns nil. Otherwise, it returns the current working directory as a URI string.

Note that while the current working directory is usually a file path, it is possible for an application to set it to an FTP URL or some other kind of URL, which is why this method doesn't simply return a file path string.

Since: Version 20240127-113634-bbcac864

The functionality described in this section requires version 20240127-113634-bbcac864 of wezterm, or a more recent version.

This method now returns a Url object which provides a convenient way to decode and operate on the URL.