Skip to content

iarchean/tmux-starship

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

tmux-starship

A tmux plugin to display Starship prompt in the tmux status bar.

As shown in the image below, the right side of the status bar displays the results for the starship prompt kubernetes and the starship prompt gcloud.

Prerequisites

  • starship installed and accessible in your system's PATH
  • tmux installed (version 1.9 or higher recommended)
  • TPM (Tmux Plugin Manager) installed

Installation

  1. Add the plugin to your ~/.tmux.conf:

    set -g @plugin 'iarchean/tmux-starship'
  2. Press prefix + I (capital I) to install and load the plugin.

Usage

Use #(@starship_cmd) in your tmux configuration to display the Starship prompt:

# Display full Starship prompt
set -g status-right "#( #(@starship_cmd) )"

# Display specific Starship module (e.g., git_branch)
set -g status-right "#( #(@starship_cmd) git_branch )"

# Combine with other tmux status elements
set -g status-right "Starship: #( #(@starship_cmd) ) | %H:%M %d-%b-%y"

Update Interval

By default, tmux updates the status bar every 15 seconds. To update more frequently, adjust status-interval:

set -g status-interval 5 # Update every 5 seconds

License

MIT

About

A tmux plugin that displays starship prompt in the tmux status bar.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages