Starship Prompt Builder

Module reference

Search every Starship module and the builder's prompt components by name, purpose, or category. Module pages explain when they appear and list their options; component pages explain the format syntax they generate.

107 references

Prompt components

  • Text component

    Add literal text, spacing, separators, labels, Unicode characters, and Nerd Font symbols anywhere in the prompt.

Core

Git

  • Fossil branch module

    Shows the name of the active branch of the check-out in your current directory

  • Fossil metrics module

    Will show the number of added and deleted lines in the check-out in your current directory

  • Git branch module

    Show the active Git branch, its remote relationship, and a branch symbol when the current directory is inside a repository.

  • Git commit module

    Shows the current commit hash and also the tag (if any) of the repo in your current directory

  • Git metrics module

    Will show the number of added and deleted lines in the current git repository

  • Git state module

    Shows what operation is in progress — rebase, merge, cherry-pick, bisect, revert or git am

  • Git status module

    Summarise staged, modified, deleted, renamed, conflicted, untracked, stashed, ahead, and behind Git state.

  • Mercurial branch module

    Shows the active branch and topic of the repo in your current directory

  • Mercurial state module

    Shows the Mercurial operation in progress, such as merging or rebasing

  • Pijul channel module

    Shows the active channel of the repo in your current directory

  • Version control module

    Uses the first detected version-control system and renders its configured modules

  • VCSH module

    Displays the current active VCSH repository

Languages

  • Bun module

    Shows the currently installed version of the bun JavaScript runtime

  • C module

    Shows some information about your C compiler

  • COBOL module

    Shows the currently installed version of COBOL

  • C++ module

    Shows some information about your C++ compiler

  • Crystal module

    Shows the currently installed version of Crystal

  • Daml module

    Shows the currently used Daml SDK version when you are in the root directory of your Daml project

  • Dart module

    Shows the currently installed version of Dart

  • Deno module

    Shows you your currently installed version of Deno

  • .NET module

    Shows the relevant version of the .NET Core SDK for the current directory

  • Elixir module

    Shows the currently installed version of Elixir and Erlang/OTP

  • Elm module

    Shows the currently installed version of Elm

  • Erlang module

    Shows the currently installed version of Erlang/OTP

  • Fennel module

    Shows the currently installed version of Fennel

  • Fortran module

    Shows the current compiler version of Fortran

  • Gleam module

    Shows the currently installed version of Gleam

  • Go module

    Shows the currently installed version of Go

  • Haskell module

    Finds the current selected GHC version and/or the selected Stack snapshot

  • Haxe module

    Shows the currently installed version of Haxe

  • Java module

    Shows the currently installed version of Java

  • Julia module

    Shows the currently installed version of Julia

  • Kotlin module

    Shows the currently installed version of Kotlin

  • Lua module

    Shows the currently installed version of Lua

  • Mojo module

    Shows the current version of Mojo programming language installed

  • Nim module

    Shows the currently installed version of Nim

  • Node.js module

    Show the active Node.js version when the current project or files indicate a JavaScript runtime.

  • Ocaml module

    Shows the currently installed version of OCaml

  • Odin module

    Shows the currently installed version of Odin

  • Perl module

    Shows the currently installed version of Perl

  • Php module

    Shows the currently installed version of PHP

  • PureScript module

    Shows the currently installed version of PureScript version

  • Python module

    Show the Python version and active virtual environment for detected Python projects.

  • Quarto module

    Shows the current installed version of Quarto used in a project

  • Raku module

    Shows the currently installed version of Raku

  • Red module

    By default the red module shows the currently installed version of Red

  • R module

    Shows the currently installed version of R

  • Ruby module

    By default the ruby module shows the currently installed version of Ruby

  • Rust module

    By default the rust module shows the currently installed version of Rust

  • Scala module

    Shows the currently installed version of Scala

  • Solidity module

    Shows the currently installed version of Solidity The module will be shown

  • Swift module

    By default the swift module shows the currently installed version of Swift

  • Typst module

    Shows the current installed version of Typst used in a project

  • V module

    Shows you your currently installed version of V

  • Zig module

    By default the zig module shows the currently installed version of Zig

Build Tools

  • Buf module

    Shows the currently installed version of Buf

  • Cmake module

    Shows the currently installed version of CMake

  • Gradle module

    Shows the version of the Gradle Wrapper currently used in the project directory

  • Maven module

    Indicates the presence of a Maven project in the current directory

  • Meson module

    Shows the current Meson developer environment status

  • Spack module

    Shows the current Spack environment, if $SPACK_ENV is set

  • Vagrant module

    Shows the currently installed version of Vagrant

  • Xmake module

    Shows the currently installed version of XMake

Cloud & Tools

System