Skip to content

Latest commit

 

History

History
114 lines (81 loc) · 3.98 KB

terminal.md

File metadata and controls

114 lines (81 loc) · 3.98 KB
Raw

Terminal

Tips on setting up your terminal and shell.

Shell prompt

When working with tools like python, git, gcloud, and Hail, you might need to frequently switch between virtual environments, git branches, Google Cloud projects, and Hail namespaces. It can be helpful to display the environment name in your prompt, as context for an operation:

prompt

zsh is the default shell on Mac OS. Powerlevel10k will work for zsh. See the custom configuration below for bash or zsh, and other shells for alternatives like fish.

Powerlevel10k

Powerlevel10k is a zsh theme with a great out-of-the-box experience. It comes with lots of status segments by default.

If you want to always show the current gcloud project, open ~/.p10k.zsh and comment out the following line:

typeset -g POWERLEVEL9K_GCLOUD_SHOW_ON_COMMAND='gcloud|gcs'

If you've installed the Meslo Nerd Font as part of the Powerlevel10k setup and you're using Visual Studio Code, you can update the font setting for the integrated terminal:

"terminal.integrated.fontFamily": "MesloLGS NF"

Custom configuration

prompt

Add this into your .zshrc, .bashrc or analogous:

git_rev() {
  # Returns current HEAD: either branch, or commit hash if detached.
  if [ ! -d .git ]; then echo ""; fi
  BRANCH=$(git branch --show-current)
  if [ -z $BRANCH ]
    then REV=$(git rev-parse --short HEAD)
    else REV=$BRANCH
  fi
  echo "$REV"
}

gcp_project() {
  # Returns current project, set with `gcloud config set project`.
  # Note: calling `gcloud config get-value project` is very slow, so parsing a file.
  PROJECT=$(grep project ~/.config/gcloud/configurations/config_default | sed 's/project = //')
  echo "$PROJECT"
}

virtual_env_name() {
  # When a virtual environment is set,
  echo $(basename $VIRTUAL_ENV)
}

hail_namespace() {
  # Returns current hail namespace set with `hailctl dev config set default_namespace`.
  echo "$(cat ~/.hail/deploy-config.json | jq -r ".default_namespace")"
}

_statuses() {
  echo "$(hail_namespace)·$(git_rev)·$(gcp_project)·$(virtual_env_name)"
}

# For zsh:
PROMPT='%~%  $(_statuses) $ '  # %~% resolves to the home directory starting with ~. To show the absolute path, use %/%
# For bash:
PS1='\w  $(_statuses) $ '

You can add some colors:

PROMPT='%{$fg[cyan]%}%~%  %{$fg[yellow]%}$(_statuses)%{$reset_color%} $ '
PS1='\[\033[00;36m\]\w\[\033[00m\] \[\033[00;33m\]$(_statuses)\[\033[00m\] $ '

For more details on bash colors, see this helpful article.

It can be also useful to use color code to show the last command return value. In zsh, it can be done with:

PROMPT='%{$fg[cyan]%}%~%  %{$fg[yellow]%}$(_statuses)%{$reset_color%} %(?.%{$fg[green]%}.%{$fg[red]%})%B$%b '

For zsh, you can move the statuses to the right hand side with the RPROMPT variable:

PROMPT='%{$fg[cyan]%}%~%  %(?.%{$fg[green]%}.%{$fg[red]%})%B$%b '
RPROMPT='%{$fg[yellow]%}$(_statuses)%{$reset_color%}'

Also, if you are using the a zsh git-prompt plugin, you can call $(git_super_status) instead of $(git_rev):

plugins=(<other plugins> git-prompt)
ZSH_THEME_GIT_PROMPT_PREFIX=""  # remove left parenthesis around git_super_status
ZSH_THEME_GIT_PROMPT_SUFFIX=""  # remove right parenthesis around git_super_status
_statuses() {
  echo "$(hail_namespace)·$(git_super_status)·$(gcp_project)·$(virtual_env_name)"
}

Other shells

Starship is a cross-shell prompt that works on many shells.

For the gcloud status, you'll have to customize its configuration to show the project variable.