MrTechKing

5 min read

Starship: A Fast, Good-Looking Prompt for Any Shell (GitHub, Scanned)

A free, fast prompt for any shell that shows your git branch, language versions and more at a glance. One small Rust program.

Starship logo
✅
Scan: safe. Nothing to warn about. No secrets or suspicious code, no advisories in the Rust code you run, and the program does not go online. Scanned Nov 16, 2026; the full report is below.

Starship is a free prompt for your terminal that works in any shell: bash, zsh, fish, PowerShell, Nushell and more. You install one small program, add one line to your shell's config file, and the next terminal you open shows your folder, your git branch and its status, and the version of the language or tool the project uses, such as Node, Python, Rust or Docker, only when it is relevant.

It earns its place because it is one fast program that looks the same on every machine and every shell, so a single config file, ~/.config/starship.toml, follows you from a Mac to a Linux server to Windows. There are around 100 modules you can switch on, off or restyle, and ready-made presets if you would rather copy a look than design one. It expects a Nerd Font in your terminal for its icons.

Starship is ISC-licensed, a short permissive licence like MIT, and community-maintained, with about 61,000 stars and roughly 700 contributors. Version 1.27.0 came out on 17 October 2026.

Who it is for

Developers, students, sysadmins and anyone who lives in a terminal and wants useful information in the prompt without writing shell scripts. It works on macOS, Linux and Windows; you need to be comfortable adding a line to a config file.

Getting started

1. Install a Nerd Font and choose it in your terminal's settings, so the icons show

https://www.nerdfonts.com/font-downloads

2. Install Starship on macOS or Linux with Homebrew

brew install starship

3. Or use the official install script on macOS and Linux

curl -sS https://starship.rs/install.sh | sh

4. Or on Windows, with winget

winget install --id Starship.Starship

5. Turn it on for zsh, then open a new terminal (for bash, use starship init bash in ~/.bashrc)

echo 'eval "$(starship init zsh)"' >> ~/.zshrc

6. Optional: start from a preset look

starship preset nerd-font-symbols -o ~/.config/starship.toml

The install script puts the starship program in /usr/local/bin and asks for sudo only if that folder is not writable; it does not edit your shell files, it prints the line to add. Our scan covers the source code, not the prebuilt downloads from GitHub releases or package managers.

Safety scan

We cloned starship/starship at commit 6e1ae29 on Nov 16, 2026 and ran the checks described on the GitHub Tools page: credential patterns, decode-and-execute code, install-time scripts, committed binaries, risky CI workflows, every host the code talks to, known vulnerabilities in pinned dependencies, and project hygiene. A person read every hit. This is what we found.

  • 0 secret hits and no committed binaries across 821 files and about 231,000 lines, most of it documentation in many languages, with about 55,000 lines of Rust.
  • 0 pattern hits. The one build script, build.rs, only bundles the preset files from docs/ into the program and sets the Windows icon and manifest.
  • install/install.sh is about 550 lines. It downloads the release archive for your system from GitHub and unpacks it into /usr/local/bin, using sudo only when that folder is not writable. The scanner marks it as editing your shell profile because it names those files, but it only prints the line for you to add. Windows releases are code-signed through SignPath.
  • All 407 Rust packages in Cargo.lock come back with no advisories. The 9 advisories (1 high, 7 moderate, 1 low) are all in Vite and esbuild in docs/package-lock.json, which builds the starship.rs documentation site, not the program.
  • The program has no web client and contacts no server; to show versions it runs tools already in your project, such as git or node, and starship bug-report only opens a prefilled GitHub issue in your browser. Nine workflows, no pull_request_target, and 21 of 22 action references pinned to commits, the other being the project's own docs workflow; cargo-deny and zizmor audit the dependencies and workflows. A security policy and Renovate are present. OpenSSF Scorecard gives it 5.7 out of 10, lowered by CI token permissions and unsigned release files.

What the scanner counted

CheckResult
SecretsNone found.
Suspicious codeNone found.
Install-time code1 Cargo build script. 1 installer script (one edits your shell profile; one can call sudo)
Committed binariesNone.
CI workflows9 workflows. None use pull_request_target. 1 of 22 third-party actions pinned to a tag rather than a commit.
Network hosts28 distinct hosts referenced from source; most often github.com, maven.apache.org, api.pulumi.com, api.example.com. No URLs to bare IP addresses.
Known vulnerabilities9 advisories across 581 pinned packages: 0 critical, 1 high, 7 moderate, 1 low. Cargo.lock: 407 packages, 0 advisories; docs/package-lock.json: 174 packages, 9 advisories.
Project hygieneHas security policy, automated dependency updates, licence file, contributing guide. Missing CodeQL.
OpenSSF Scorecard5.7 out of 10, as of Nov 2, 2026.

The raw findings

Every hit the scanner wrote out, with a link to the exact line at the scanned commit. Secrets candidates are redacted.

Installer scripts (1)
  • install/install.sh, 555 lines, uses sudo, edits your shell profile; talks to github.com, stackoverflow.com
Worst known vulnerabilities (9 of 9)
AdvisorySeverityPackageSummary
GHSA-587h-7wmj-h5pmhighvite@5.4.21launch-editor: `fs.existsSync()` existence check can be bypassed on Windows
GHSA-67mh-4wv8-2f99moderateesbuild@0.21.5esbuild enables any website to send any requests to the development server and read the response
GHSA-4w7w-66w2-5vf9moderatevite@5.4.21Vite Vulnerable to Path Traversal in Optimized Deps `.map` Handling
GHSA-698v-4r3x-3vcvmoderatevite@5.4.21launch-editor: escapeCmdArgs() omits % escaping on Windows
GHSA-fx2h-pf6j-xcffmoderatevite@5.4.21vite: `server.fs.deny` bypass on Windows alternate paths
GHSA-r825-w8mm-5pxwmoderatevite@5.4.21launch-editor: Editor CLI flag misinterpretation causing arbitrary command execution for some editors
GHSA-rq7h-c2jc-7f22moderatevite@5.4.21Vite: Files outside `server.fs.allow` could be served when project paths match system paths on non-Windows machine
GHSA-v6wh-96g9-6wx3moderatevite@5.4.21launch-editor: NTLMv2 hash disclosure via UNC path handling on Windows
GHSA-9jrq-w75r-8gcwlowvite@5.4.21Vite: Cross origin script execution through Vite custom middleware

By the numbers

Stars60.7K
Forks2,880
Contributors699
Commits4,504
Open issues805
Open pull requests258
Releases142
Latest releasev1.27.0
LicenceISC
Main languageRust
Project age7 years
Last pushNov 16, 2026
Tracked files821
Lines of code231.3K
Checkout size22 MB

Lines by language: Markdown 163.4K, Rust 54.7K, JSON 7,592, TOML 2,805, Shell 1,132, YAML 1,066.

Questions

Is Starship free?

Yes. It is free and open source under the ISC licence, with no paid tier. The project accepts optional GitHub sponsorships.

Starship or Oh My Zsh?

They do different jobs and work well together. Oh My Zsh manages zsh plugins and themes; Starship is only the prompt, but it works in every shell and stays fast. Many people keep Oh My Zsh's plugins and use Starship as the prompt.

Does Starship work on Windows?

Yes. Install it with winget, Scoop or Chocolatey and add the init line to your PowerShell profile. It also works in Command Prompt through Clink.

Does Starship send my data anywhere?

No. We found no network code in the program. It reads files in the folder you are in and runs local tools like git to build the prompt.

How do I uninstall Starship?

Remove the starship init line from your shell config, then remove the program: brew uninstall starship, or delete the starship file from /usr/local/bin if you used the script. Delete ~/.config/starship.toml too if you made one.


This post is part of GitHub Tools, where every repository is cloned and scanned before it is written up. The scan is a snapshot of one commit on one day; the repository has moved on since, so check it before you install.