ITerm2 Shell Integration and Oh My Zsh Conflicts

iterm2oh-my-zshshell

I've recently re-installed iTerm2 and am now running into an interesting problem after setting up iTerm's Shell Integration.

Upon open a new terminal window, everything seems to look correct, showing the proper "agnoster" theme from Oh My ZSH:

If I issue clear, now my terminal window looks like this:

I can revert things to the original state by sourcing ~/.zshrc once again, but I'm really curious about the root issue and if there's any way to fix it.

I have tried hiding the marker in iTerm's settings, but that just results in a blank terminal.

In a previous install (before I wiped this Mac), I had Oh My ZSH and Shell Integration both going, and although it looked kind of wonky at times, it still seemed to keep the Oh My ZSH theme regardless of clearing the terminal or issuing any other command.

Does anyone have any ideas on this? I've checked the iTerm settings over and over, but can't seem to find anything that would be related.

Best Answer

Late answer but this worked for me.

The iTerm2 Shell Integrations page has you download the install script and pipe it into bash.

Instead, download it locally and modify it so it knows you are using ZSH.

First, download the script

wget https://iterm2.com/misc/install_shell_integration.sh

Then, instead of having the script determine the shell just define it as "zsh"

# comment out this line
# SHELL=$(echo "${SHELL}" | tr / "\n" | tail -1)

# replace it with this line
SHELL="zsh"

Next, make the install script executable and then run it

chmod +x install_shell_integration.sh
./install_shell_integration.sh

After that the integration should be installed properly.

Note Remove the Bash integration if you don't need it.

rm ~/.iterm2_shell_integration.bash

Related Solutions

Ruby – How to call shell commands from Ruby

This explanation is based on a commented Ruby script from a friend of mine. If you want to improve the script, feel free to update it at the link.

First, note that when Ruby calls out to a shell, it typically calls /bin/sh, not Bash. Some Bash syntax is not supported by /bin/sh on all systems.

Here are ways to execute a shell script:

cmd = "echo 'hi'" # Sample string that can be used

Kernel#` , commonly called backticks – `cmd`

This is like many other languages, including Bash, PHP, and Perl.

Returns the result (i.e. standard output) of the shell command.

Docs: http://ruby-doc.org/core/Kernel.html#method-i-60
```
value = `echo 'hi'`
value = `#{cmd}`
```
Built-in syntax, %x( cmd )

Following the x character is a delimiter, which can be any character. If the delimiter is one of the characters (, [, {, or <, the literal consists of the characters up to the matching closing delimiter, taking account of nested delimiter pairs. For all other delimiters, the literal comprises the characters up to the next occurrence of the delimiter character. String interpolation #{ ... } is allowed.

Returns the result (i.e. standard output) of the shell command, just like the backticks.

Docs: https://docs.ruby-lang.org/en/master/syntax/literals_rdoc.html#label-Percent+Strings
```
value = %x( echo 'hi' )
value = %x[ #{cmd} ]
```
Kernel#system

Executes the given command in a subshell.

Returns true if the command was found and run successfully, false otherwise.

Docs: http://ruby-doc.org/core/Kernel.html#method-i-system
```
wasGood = system( "echo 'hi'" )
wasGood = system( cmd )
```
Kernel#exec

Replaces the current process by running the given external command.

Returns none, the current process is replaced and never continues.

Docs: http://ruby-doc.org/core/Kernel.html#method-i-exec
```
exec( "echo 'hi'" )
exec( cmd ) # Note: this will never be reached because of the line above
```

Here's some extra advice: $?, which is the same as $CHILD_STATUS, accesses the status of the last system executed command if you use the backticks, system() or %x{}. You can then access the exitstatus and pid properties:

$?.exitstatus

For more reading see:

Bash – How to check if a directory exists in a Bash shell script

To check if a directory exists in a shell script, you can use the following:

if [ -d "$DIRECTORY" ]; then
  # Control will enter here if $DIRECTORY exists.
fi

Or to check if a directory doesn't exist:

if [ ! -d "$DIRECTORY" ]; then
  # Control will enter here if $DIRECTORY doesn't exist.
fi

However, as Jon Ericson points out, subsequent commands may not work as intended if you do not take into account that a symbolic link to a directory will also pass this check. E.g. running this:

ln -s "$ACTUAL_DIR" "$SYMLINK"
if [ -d "$SYMLINK" ]; then 
  rmdir "$SYMLINK" 
fi

Will produce the error message:

rmdir: failed to remove `symlink': Not a directory

So symbolic links may have to be treated differently, if subsequent commands expect directories:

if [ -d "$LINK_OR_DIR" ]; then 
  if [ -L "$LINK_OR_DIR" ]; then
    # It is a symlink!
    # Symbolic link specific commands go here.
    rm "$LINK_OR_DIR"
  else
    # It's a directory!
    # Directory command goes here.
    rmdir "$LINK_OR_DIR"
  fi
fi

Take particular note of the double-quotes used to wrap the variables. The reason for this is explained by 8jean in another answer.

If the variables contain spaces or other unusual characters it will probably cause the script to fail.

Best Answer

Related Solutions

Ruby – How to call shell commands from Ruby

Bash – How to check if a directory exists in a Bash shell script

Related Topic