# Context Signalling (OSC 3008)

> Tell the terminal when a shell, a command, a container or a privileged session starts and ends.

- **Sequence:** `OSC 3008 ; start=id ; type=… ST`
- **ECMA-48:** [§8.3.89 OSC – Operating System Command, p. 51](https://archive.org/details/ecma-48-5th-edition-june-1991/page/n64/mode/1up)
- **Specification:** [UAPI.15 OSC 3008: Hierarchical Context Signalling](https://uapi-group.org/specifications/specs/osc_context/)

Control of a terminal passes from program to program: a shell runs a
command, `ssh` connects to another machine, `run0` acquires root, a
container manager starts a container. `OSC 3008` lets each say so, so that
the terminal can mark where each began and ended, tint the output of a
privileged session, or offer to open a new shell in the same place. Its
definition is the UAPI group's
[OSC 3008: Hierarchical Context Signalling](https://uapi-group.org/specifications/specs/osc_context/),
and systemd's tools send it.

| Sequence | Does |
| --- | --- |
| `OSC 3008 ; start=id ; field=value ; … ST` | opens the context `id`, or updates it, with metadata |
| `OSC 3008 ; end=id ; field=value ; … ST` | closes it, and every context opened inside it |

The `id` is chosen by whoever opens the context, up to 64 printable
characters, and should be unique, such as a UUID. The fields include
`type`, which is one of `boot`, `container`, `vm`, `elevate`, `chpriv`,
`subcontext`, `remote`, `shell`, `command`, `app`, `service` and `session`,
and others such as the user, the host name and the working directory.
Contexts nest: a new one becomes the active one, and the one before it its
parent.

A default xterm does not have it and ignores it
([the OSC numbers it knows](https://github.com/ThomasDickey/xterm-snapshots/blob/xterm-411a/misc.c#L3476-L3504)).
libghostty-vt parses it and does nothing more. What a case can see is that
nothing is printed or answered, and libghostty-vt passes.

## Support

| Terminal | Version | Support | Notes |
| --- | --- | --- | --- |
| VT220 | [manual](https://vt100.net/docs/vt220-rm/), 2nd ed., 1984 | No | OSC is not among the controls it recognizes ([§4.2](https://vt100.net/docs/vt220-rm/chapter4.html#S4.2)) |
| VT510 | [manual](https://vt100.net/docs/vt510-rm/), 1st ed., 1993 | No | ignores an OSC string ([chapter 4](https://vt100.net/docs/vt510-rm/chapter4.html)) |
| xterm | patch 412, [xterm-411a](https://github.com/ThomasDickey/xterm-snapshots/tree/xterm-411a) | No |  |
| libghostty-vt | [0f171f6](https://github.com/ghostty-org/ghostty/tree/0f171f650a1cbbd6df4a2573b6b0c7de57cc6d90) | No | parsed, then ignored |
| Konsole | 26.11.70, [a24c3d71](https://invent.kde.org/utilities/konsole/-/tree/a24c3d71be3684f24d030aa2dbe9bd723d985233) | No |  |
| ConEmu | build 230724, its [documentation](https://conemu.github.io/en/AnsiEscapeCodes.html) | No | not in ConEmu's list, [ANSI escape codes](https://conemu.github.io/en/AnsiEscapeCodes.html) |

## Validation

### OSC3008-1: Nothing on screen

Input, one step per line:

```text
A
\e]3008;start=5f1c;type=shell\e\\
\e]3008;start=9a2e;type=command\e\\
B
\e]3008;end=9a2e;exit=success\e\\
C
```

Expected screen:

```text
|ABC___|
cursor 1,4
reply none
```

---

This is the Markdown version of <https://control-codes.page/osc/context/>. On that page every validation case runs live in libghostty-vt, the terminal emulation core of Ghostty, compiled to WebAssembly.

The validation cases are written in the notation described in <https://control-codes.page/notation/index.html.md>.
