| Purpose: | Configure or test the external Starship prompt renderer. |
| Format: | STARSHIP [ /AUTO | /DISABLE | /ENABLE | /SETEXE="file" | /STATUS | /TEST ] |
Usage:
Install Starship separately. With no executable override, TCC searches for starship.exe using the Windows search path. STARSHIP with no argument displays status, as does /STATUS.
The mode and executable override are saved in the [4NT] section of the current TCC INI file as StarshipPrompt (Auto, Yes, or No) and StarshipExecutable. StarshipPromptTimeout defaults to 1000 milliseconds and is limited to 50 through 2000 milliseconds at runtime. StarshipPromptMaxBytes defaults to 65536 bytes and is limited to 4096 through 262144 bytes at runtime.
TCC passes the previous command status, command duration, and terminal width to Starship. Prompt output must be UTF-8 and may contain text, line breaks, tabs, and ANSI SGR color sequences; other control sequences are rejected. A failed, timed-out, empty, or oversized render falls back to PROMPT.
Options:
| /AUTO | Enables automatic use when the executable is available. If Starship cannot render a prompt, TCC uses the normal PROMPT instead. An absent executable does not produce a warning in Auto mode. |
| /ENABLE | Enables Starship after checking that the configured executable exists and accepts the required prompt options. An unsuccessful check reports an error and does not enable it. |
| /DISABLE | Disables Starship and uses PROMPT. The default setting is No. |
/SETEXE="file" Sets an absolute drive or UNC path to an existing executable. Use /SETEXE="" to clear the override and return to searching for starship.exe. Quote paths containing spaces.
| /STATUS | Displays the mode, resolved executable or error, compatibility check, configured limits, and the last automatic render result, if any. The compatibility check runs even when Starship is disabled. |
| /TEST | Renders and displays one prompt without changing the mode; failures are reported. This test can be used while Starship is disabled. |