Command Sheet

Below is a chart outlining the different request commands you can give and the different arguments they require with an explanation in parentheses if needed.

Requestable Commands

Command	arguments
AUTOCOMPLETE	file: str, current_word: str (the portion of the word being typed), expected_keywords: list[str] (any special keywords for the language (optional))
REPLACEMENTS	file: str, current_word: str (the word needing to be replaced), expected_keywords: list[str] (any special keywords for the language (optional))
HIGHLIGHT	file: str, language: str, text_range: tuple[int, int] (the lower and upper line bounds (inclusively) of what text to highlight (optional))
EDITORCONFIG	file_path: pathlib.Path | str (the absolute path to the file you need the editorconfig data on),
DEFINITION	file: str, current_word: str (the word being searched for), definition_starters: list[tuple[str, str]] (list of regexes to search for and a string associated (see Simple Definitions Example))
LINKS_AND_CHARS	file: str, text_range: tuple[int, int] (the lower and upper line bounds (inclusively) of what text to highlight (optional))

To see how to use any given one of these in more detail, visit the Salve Examples page! Otherwise move on to the Special Classes page instead.