Expand description
iTerm2 configuration instruction generator.
Most iTerm2 settings live in plist files, which are complex to modify programmatically, so this module generates manual setup instructions for them. The tab icon is the exception: iTerm2 loads Dynamic Profiles from plain JSON files with no restart, so the icon profile below is fully installable from code.
Structs§
- Profile
Icon Install Report - Outcome of
install_profile_icon.
Constants§
- PROFILE_
GUID - Stable identity of the shipped iTerm2 profile so reinstalls overwrite instead of duplicating it.
- PROFILE_
ICON_ FILENAME - Filename of the installed profile artwork under the data root.
Functions§
- default_
install_ paths - Resolve default install locations: home directory and canonical data root.
- dynamic_
profile_ json - Render the dynamic-profile JSON pointing at an absolute icon path.
- ensure_
profile_ icon - Ensure the iTerm2 profile icon is installed, returning the install report when this call wrote files.
- ensure_
profile_ icon_ at - Testable core of
ensure_profile_iconwith explicit paths and environment flags (no process-environment reads, no global roots). - generate_
config - Generate iTerm2 setup instructions (manual configuration required)
- install_
profile_ icon - Install the VT Code iTerm2 profile icon (macOS only, idempotent).
- installed_
icon_ path - Absolute destination of the installed icon under a data root.
- profile_
icon_ instructions - Guidance lines pointing at the automatic installer and the manual fallback.
- run_
profile_ icon_ install - Run the non-interactive profile-icon install with progress output.
- run_
profile_ icon_ reset - Reset the current session’s iTerm2 profile to its original name.