Description
Parse complete CSI erase-display/erase-line tokens with modes 0–2 or display-only mode 3; returns lexical evidence without terminal effects.
Terminal escape sequences can encode cursor commands, text styles and other controls inside ordinary text. SGR changes selected graphic attributes; CSI and OSC tokens have different framing. These tools operate on explicit strings and records, with a deliberately limited parser or style model rather than an emulated screen.1
Parse complete CSI erase-display/erase-line tokens with modes 0–2 or display-only mode 3; returns lexical evidence without terminal effects.
When to use this tool
Use this tool to parse complete CSI erase-display/erase-line tokens with modes 0–2 or display-only mode 3; returns lexical evidence without terminal effects.
How to use the tool and how it works
- Enter token using the field definitions below.
- Run the operation. Correct input errors before interpreting an output.
- Read result.kind, result.mode. Use the ordering, boundary rules and absence conditions described below.
Parse one complete CSI J or K erase token. Default an omitted mode to zero; reject mode 3 for K and return display or line with its numeric mode.2
| Input field | Meaning and units | Accepted input |
|---|---|---|
| token | One complete escape token in the supported syntax; JSON shows ESC as an escaped character. | Text, at most 8,192 UTF-16 code units; the operation’s grammar also applies. |
| Output field | Interpretation |
|---|---|
| result | Object containing the named fields below. |
| result.kind | Erase target: display for J or line for K. |
| result.mode | Numeric erase mode, with omitted mode interpreted as zero. |
{
"input": {
"token": "\u001b[2J"
},
"output": {
"result": {
"kind": "display",
"mode": 2
}
}
}Limitations and assumptions
- This describes an erase command without executing it or determining terminal-specific behavior.
- Source spans use zero-based UTF-16 offsets with exclusive ends; byte totals, where returned, use UTF-8. Escape tokens are represented as JSON escapes in the example and are not executed by this description.
- Every declared top-level input field is required and unexpected fields are rejected. Ordinary strings are limited to 8,192 UTF-16 code units and lists to 128 entries, with tighter operation-specific bounds where stated. JSON text has bounded nesting and node counts.
- Numeric outputs must be finite and no larger in absolute magnitude than the safe-integer limit; operations returning exact large integers use decimal text. Positions are zero-based and spans end exclusively unless the operation explicitly states a different convention.
Alternative or Complementary methods
Use token inspection for source offsets and style replay for the supported attributes. A real terminal emulator is needed to determine screen contents, terminal-specific rendering or device behavior.
References
-
ECMA-48: Control Functions for Coded Character Sets — Ecma International
-
Tool behavior and example: Terminal CSI Erase Mode Token Parser — tool.io
Similar or alternative tools
- Terminal CSI Cursor Move Formatter
Format a supported relative CSI cursor movement token with positive explicit count; directions are up/down/right/left only, no terminal execution.
- Terminal CSI Cursor Position Formatter
Format an explicit one-based CSI CUP row/column position token; does not move a cursor or inspect screen dimensions.