iterm2-utils/README.md

   1 ---
   2 title: iTerm2 Shell Integrations
   3 homepage: https://iterm2.com/documentation-shell-integration.html
   4 tagline: |
   5   iTerm2 Shell Integrations enable several useful features.
   6 ---
   7
   8 To update, just run `webi iterm2-utils` again.
   9
  10 Note: On first use you'll need to source the new config, or login and login
  11 again.
  12
  13 ```bash
  14 source ~/.iterm2_shell_integration.bash
  15 ```
  16
  17 ## Cheat Sheet
  18
  19 > iTerm2 may be integrated with the unix shell so that it can keep track of your
  20 > command history, current working directory, host name, and more—even over ssh.
  21
  22 This downloads and runs the same exact script that runs if you select the
  23 _iTerm2>Install Shell Integration_ menu item.\
  24 (the advantage being that you can use the CLI! _Look ma', no GUI!_)
  25
  26 In addition to enabling [automatic profile switching](./iterm2), the following
  27 utilities will also be installed.
  28
  29 | iterm2 Util            | Description                                                       |
  30 | :--------------------- | :---------------------------------------------------------------- |
  31 | imgcat filename        | Displays the image inline.                                        |
  32 | imgls                  | Shows a directory listing with image thumbnails.                  |
  33 | it2api                 | Command-line utility to manipulate iTerm2.                        |
  34 | it2attention fireworks | Gets your attention.                                              |
  35 | it2check               | Checks if the terminal is iTerm2.                                 |
  36 | it2copy [filename]     | Copies to the pasteboard.                                         |
  37 | it2dl filename         | Downloads the specified file, saving it in your Downloads folder. |
  38 | it2setcolor ...        | Changes individual color settings or loads a color preset.        |
  39 | it2setkeylabel ...     | Changes Touch Bar function key labels.                            |
  40 | it2ul                  | Uploads a file.                                                   |
  41 | it2universion          | Sets the current unicode version.                                 |
  42
  43 To learn more, see <https://iterm2.com/documentation-shell-integration.html>.