>_ RESTERM
v1.10.2
resterm.md

docs Reference

Configuration

Where Resterm keeps settings, history and themes, and editor diagnostics.

  • Config directory: $HOME/Library/Application Support/resterm (macOS), %APPDATA%\resterm (Windows), or $HOME/.config/resterm (Linux/Unix). Override with RESTERM_CONFIG_DIR.
  • History file: <config-dir>/history.db (no fixed entry limit).
  • Settings file: <config-dir>/settings.toml (created when you first change preferences such as the default theme).
  • Theme directory: <config-dir>/themes/ (override with RESTERM_THEMES_DIR). Drop .toml or .json files here to make them available in the selector.
  • Runtime globals and file captures are scoped per complete environment selection and document; they are released when you clear globals or switch environments.

Editor diagnostics

Diagnostics are enabled by default for .http, .rest, and unnamed request buffers. They show the parser's existing warnings and errors, such as unknown directives, mistyped option keys, missing values, conflicting options, and placeholders such as {{token} that never close. Diagnostics refresh when you leave insert mode, without saving the buffer or changing the active request. They do not refresh while you type, even if you pause. Existing markings stay until an edit invalidates their source ranges, then clear until you return to normal mode. Changes made in normal mode, such as undo or deletion, use a short debounce.

K (Shift+K) in normal mode opens a popup beside the cursor with diagnostics on that line. Findings under the cursor appear first; errors take priority over warnings. Enter opens related documentation when available, PgUp / PgDown scroll long messages, and Esc or cursor movement closes the popup. On a line without diagnostics, K opens contextual help as before. In insert mode, K types normally.

Use ] d / [ d or :diagnostics next / :diagnostics prev to visit diagnostic locations. Navigation wraps at the ends of the buffer. :diagnostics opens the full list. Empty-line and EOF findings use a line-number marker when there is no text to underline.

:diagnostics off and :diagnostics on change the setting for this session. To disable diagnostics at startup, put this in <config-dir>/settings.toml:

toml
[editor]
diagnostics = false

For settings.json, use {"editor":{"diagnostics":false}}. Omitting the setting enables diagnostics. Session overrides do not change the stored preference.

This feature reports request-file parsing findings. It does not evaluate scripts, resolve runtime variables, or perform network checks, and it does not add script-language diagnostics to .rts files. Existing execution validation and headless warning behavior remain unchanged.

Themes can customize [styles.editor_diagnostic_warning] and [styles.editor_diagnostic_error] using the usual style fields, including foreground and underline. Defaults use ordinary terminal underlines and distinct warning/error colors; no terminal-specific undercurl support is required.

Search

↑↓ moveEnter openEsc close

Help

These keys work like the ones in the TUI.

/
Search the docs (also Ctrl K)
j k
Scroll down and up
g g G
Jump to the top or the bottom
[ ]
Previous and next docs page
g d
Docs index
g h
Home page
t
Switch between dark and light
?
Show this help
Esc
Close a dialog