Unpacking Software Livestream

Join our monthly Unpacking Software livestream to hear about the latest news, chat and opinion on packaging, software deployment and lifecycle management!

Learn More

Chocolatey Product Spotlight

Join the Chocolatey Team on our regular monthly stream where we put a spotlight on the most recent Chocolatey product releases. You'll have a chance to have your questions answered in a live Ask Me Anything format.

Learn More

Chocolatey Coding Livestream

Join us for the Chocolatey Coding Livestream, where members of our team dive into the heart of open source development by coding live on various Chocolatey projects. Tune in to witness real-time coding, ask questions, and gain insights into the world of package management. Don't miss this opportunity to engage with our team and contribute to the future of Chocolatey!

Learn More

Calling All Chocolatiers! Whipping Up Windows Automation with Chocolatey Central Management

Webinar from
Wednesday, 17 January 2024

We are delighted to announce the release of Chocolatey Central Management v0.12.0, featuring seamless Deployment Plan creation, time-saving duplications, insightful Group Details, an upgraded Dashboard, bug fixes, user interface polishing, and refined documentation. As an added bonus we'll have members of our Solutions Engineering team on-hand to dive into some interesting ways you can leverage the new features available!

Watch On-Demand
Chocolatey Community Coffee Break

Join the Chocolatey Team as we discuss all things Community, what we do, how you can get involved and answer your Chocolatey questions.

Watch The Replays
Chocolatey and Intune Overview

Webinar Replay from
Wednesday, 30 March 2022

At Chocolatey Software we strive for simple, and teaching others. Let us teach you just how simple it could be to keep your 3rd party applications updated across your devices, all with Intune!

Watch On-Demand
Chocolatey For Business. In Azure. In One Click.

Livestream from
Thursday, 9 June 2022

Join James and Josh to show you how you can get the Chocolatey For Business recommended infrastructure and workflow, created, in Azure, in around 20 minutes.

Watch On-Demand
The Future of Chocolatey CLI

Livestream from
Thursday, 04 August 2022

Join Paul and Gary to hear more about the plans for the Chocolatey CLI in the not so distant future. We'll talk about some cool new features, long term asks from Customers and Community and how you can get involved!

Watch On-Demand
Hacktoberfest Tuesdays 2022

Livestreams from
October 2022

For Hacktoberfest, Chocolatey ran a livestream every Tuesday! Re-watch Cory, James, Gary, and Rain as they share knowledge on how to contribute to open-source projects such as Chocolatey CLI.

Watch On-Demand

Downloads:

1,907

Downloads of v 1.18.1:

35

Last Update:

24 Mar 2024

Package Maintainer(s):

Software Author(s):

  • Starship Contributors

Tags:

powershell prompt starship pwsh

Starship

  • 1
  • 2
  • 3

1.18.1 | Updated: 24 Mar 2024

Downloads:

1,907

Downloads of v 1.18.1:

35

Software Author(s):

  • Starship Contributors

Starship 1.18.1

  • 1
  • 2
  • 3

Some Checks Have Failed or Are Not Yet Complete

Not All Tests Have Passed


Validation Testing Passed


Verification Testing Passed

Details

Scan Testing Resulted in Flagged as a Note:

At least one file within this package has greater than 0 detections, but less than 5

Details
Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

To install Starship, run the following command from the command line or from PowerShell:

>

To upgrade Starship, run the following command from the command line or from PowerShell:

>

To uninstall Starship, run the following command from the command line or from PowerShell:

>

Deployment Method:

NOTE

This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)


2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Copy Your Script

choco upgrade starship.portable -y --source="'INTERNAL REPO URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade starship.portable -y --source="'INTERNAL REPO URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Install starship.portable
  win_chocolatey:
    name: starship.portable
    version: '1.18.1'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'starship.portable' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '1.18.1'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller starship.portable
{
    Name     = "starship.portable"
    Version  = "1.18.1"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'starship.portable':
  ensure   => '1.18.1',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

NOTE

Private CDN cached downloads available for licensed customers. Never experience 404 breakages again! Learn more...

NOTE

This package is likely a meta/virtual (*) or an installer (*.install) or portable (*.portable) application package.

  • Meta/virtual (*) - has a dependency on the *.install or the *.portable package - it is provided for discoverability and for other packages to take a dependency on.
  • Portable (*.portable/*.commandline (deprecated naming convention)/*.tool (deprecated naming convention)) - usually zips or archives that require no administrative access to install.
  • Install (*.install/*.app (deprecated naming convention)) - uses native installers, usually requires administrative access to install.

Learn more about chocolatey's distinction of installed versus portable apps and/or learn about this kind of package.

Package Approved

This package was approved as a trusted package on 24 Mar 2024.

Description

Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!
Shows the information you need, while staying sleek and minimal.


tools\chocolateyInstall.ps1
$ErrorActionPreference = 'Stop'

$packageName = $env:ChocolateyPackageName

$url_x86_64_zip = 'https://github.com/starship/starship/releases/download/v1.18.1/starship-x86_64-pc-windows-msvc.zip'
$url_i686_zip = 'https://github.com/starship/starship/releases/download/v1.18.1/starship-i686-pc-windows-msvc.zip'
$checksum_x86_64_zip = '6F14DADCFC2E202F22E91143FDCA703009FB12543847E0F39364DCF18155A18B'
$checksum_i686_zip = '1F8BC2F9B3A80C54952D6358412A0F7DE505DAECD1DAA61DA0E6E2AD01161636'

$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
$packageArgs = @{
    packageName   = $packageName
    fileType      = 'zip'
    url           = $url_i686_zip
    url64bit      = $url_x86_64_zip
    checksum      = $checksum_i686_zip
    checksum64    = $checksum_x86_64_zip
    checksumType  = 'sha256'
    unzipLocation = $toolsDir
}
Install-ChocolateyZipPackage @packageArgs

# Add to Profile
Write-Host "Add the following to the end of ~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1 'Invoke-Expression (&starship init powershell)'"

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Add to Builder Version Downloads Last Updated Status
Starship 1.18.0 20 Thursday, March 21, 2024 Approved
Starship 1.17.1 89 Tuesday, January 2, 2024 Approved
Starship 1.17.0 32 Thursday, December 28, 2023 Approved
Starship 1.16.0 146 Sunday, July 30, 2023 Approved
Starship 1.15.0 91 Tuesday, June 6, 2023 Approved
Starship 1.14.2 38 Wednesday, April 12, 2023 Approved
Starship 1.14.1 33 Tuesday, April 11, 2023 Approved
Starship 1.14.0 19 Tuesday, April 11, 2023 Approved
Starship 1.13.1 46 Sunday, February 26, 2023 Approved
Starship 1.12.0 50 Wednesday, December 14, 2022 Approved
Starship 1.11.0 47 Saturday, November 26, 2022 Approved
Starship 0.41.0 556 Tuesday, April 28, 2020 Approved
Starship 0.40.1 90 Sunday, April 12, 2020 Approved
Starship 0.39.0 109 Tuesday, April 7, 2020 Approved
Starship 0.38.1 121 Saturday, March 28, 2020 Approved
Starship 0.38.0 111 Saturday, March 21, 2020 Approved
Starship 0.37.0 160 Friday, March 6, 2020 Approved
Starship 0.36.0 114 Tuesday, February 18, 2020 Approved

Changelog

1.18.1 (2024-03-24)

Bug Fixes

  • deps: update rust crate os_info to 3.8.2 (#5870) (d421f63)
  • replace all remaining paths referring to vuepress (#5859) (d5861f9)

1.18.0 (2024-03-21)

Features

Bug Fixes

  • bash: Handle Unbound Variables Errors in Bash (#4972) (7093d5c)
  • bash: improve integration with bash-preexec (#5734) (2aa711c)
  • character: also handle vi edit mode in pwsh (#5775) (0891ec2)
  • direnv: update to work with direnv v2.33 (#5657) (cec111a)
  • git_branch: fall back to "HEAD" when there is no current branch (#5768) (6a96e84)
  • nu: continuation prompt not being displayed correctly (#5851) (d308e91)
  • status: fix pipestatus width calculation (#5036) (ab84043), closes #3162
  • zsh: improve starship binary path escaping (#5574) (2bb57cf)

1.17.1 (2024-01-02)

Bug Fixes

Reverts

  • refactor(modules): use whoami crate to get username (#5669) (a83e107)

1.17.0 (2023-12-28)

Features

  • add additional exit status code meanings from libc (#5412) (81c7d0c)
  • add typst module (7b21705)
  • aws: Adding the AWS SSO CLI env variable to profile list (#5640) (6d96df3)
  • direnv: add new direnv module (#5157) (e47bfba)
  • fossil_metrics: add fossil_metrics module (#4874) (e867cda)
  • hostname: add detect_env_vars as option (#5196) (43b2d42)
  • kubernetes: Add styling based on current context (#4550) (6b444e0)
  • R lang packages version, remove .Rprofile from rlang detection (#5588) (5267c46)
  • scanner: add option not to follow symlinks (#5325) (7b851fc)
  • shell: allow distinguishing between pwsh and powershell (#5478) (d7a34b4)

Bug Fixes

  • bash: unbound variable error with STARSHIP_PREEXEC_READY (#5438) (8168c21)
  • docker_context: ignore unix domain socket path from Docker Context (#5616) (a910e09), closes #5548
  • git_status: Avoid printing error on missing stash ref (#5434) (00d3dc8)
  • git: prevent core.fsmonitor from executing external commands (#3981) (03278e4)
  • install: do not use curl installed through snap (#5442) (0e73817)
  • pastel-powerline: remove $path from docker-context module format string (#5534) (6abc83d)

Performance Improvements

  • git_status: avoid running in bare repos (#5581) (ac4a839)
  • Skip unnecessary indirection in starship init zsh (#5322) (5ca8daa)

1.16.0 (2023-07-30)

Features

  • pwsh: Support vi command mode indicator (#5049) (3180509)
  • shlvl: add repeat_offset for repeated symbol (#5289) (3402f0e)
  • update the nushell init file and make it valid module and overlay (#5188) (470aeb0)

Bug Fixes

  • bash: Clear out completed jobs before counting NUM_JOBS (#5253) (0a05b5c)
  • rprompt: remove lprompt modules from $all again (#5067) (b9a4b08)

Performance Improvements

  • git_status: query git stash count via gitoxide (#5238) (410f107)

1.15.0 (2023-06-06)

Features

Bug Fixes

  • bump libz-ng-sys (#5218) (6ab8f40)
  • config: Make print-config not panic without a config (#5001) (ce7f984)
  • ensure nested style variables are processed during formatting (e5cec9e)
  • presets: Added ($style) to format in module 'sudo' in Bracketed Segments Preset (#5146) (1bd6db5)
  • snap: Update snapcraft.yaml to add personal-files interface (#5131) (b3ccc0f)
  • style: ensure nested style variables are processed during formatting (#5120) (e5cec9e)
  • update of presets and default configuration to reflect changes in Nerd Fonts 3.0 (#5162) (2558c45)

1.14.2 (2023-04-12)

Bug Fixes

  • git_commit: resolve panic on 32-bit targets (#5095) (5ef90a6)

1.14.1 (2023-04-11)

Bug Fixes

1.14.0 (2023-04-10)

Features

  • aws: add support for source_profile (#3834) (d2801ac)
  • aws: add support for source_profile (#4859) (d2801ac)
  • aws: Adds support for AWS_CREDENTIAL_EXPIRATION environment variable (#5002) (74ce7fd)
  • custom: add option to check if pwd is in a repo (#4822) (d29ce7c)
  • fossil: detection of Fossil check-outs in subdirectories (#4910) (4bca74e)
  • release: handle chocolatey starship.portable and starship.install pkg publishing (#4723) (b55774d)

Bug Fixes

  • fossil_branch: fossil checkout database file name on windows (#4978) (c07a21d)
  • fossil_branch: use proper fossil checkout database file name on windows (c07a21d)
  • gradle: add support for unstable Gradle versions (#5021) (f7fe41f)
  • init: avoid cygpath for starship binary path (#4970) (0ad0465)
  • java: wrong version number when using Android Studio JDK (#4966) (de7e948)
  • preset: add output-flag to avoid encoding issues (#4926) (5e78226)
  • pulumi: Fix formatting on pulumi module when using version (#5038) (aef799b)

1.13.1 (2023-02-26)

Bug Fixes

1.13.0 (2023-02-24)

Features

Bug Fixes

  • 'to to' -> 'to' (8c2135f)
  • container: reduce docker, podman and systemd confusion (#4832) (85d683d)
  • fish: enable transient prompt when in vi mode (#4826) (9ac924e)
  • git_commit: fix potential test failure (#4734) (27d167b)
  • Improve regex for extracting gradle package version from gradle.properties (#4759) (9093891)
  • let-env warning when using nushell (#4893) (e6c5571)
  • nodejs: apply style even if node version is unavailable (#4713) (e88484d)
  • package: Improve regex for extracting gradle version from gradle.properties (#4760) (9093891)
  • Remove vulnerable time-0.1.x chrono dependency (#4750) (255f91c)

1.12.0 (2022-12-13)

Features

Bug Fixes

  • aws: enable when using .aws/credentials (#4604) (c8ac877)
  • buf: broken icon on windows 10 (#4689) (7341607)
  • ci: cache after selecting the toolchain (#4619) (e4dbff0)
  • config: unrecognized config properties don't cause config error (#4547) (1b03ef2)
  • container: avoid detecting WSL as a systemd-container (#4593) (b47a4fe)
  • don't attempt to display cmd_duration notification if in TTY (#4535) (0427863)
  • git: check tag_disabled option (#4527) (fd165b9)
  • java: Improved regex for Java version (starship#4610) (#4616) (a9eb65e)
  • nu: remove -c parameter from term size (#4477) (4999530)
  • pwsh: fix error log display on older versions of pwsh (#4650) (ef83e7a)
  • status: replace multiply with cross mark emoji (#4461) (186d99e)

1.11.0 (2022-10-14)

Features

Bug Fixes

  • buf: fix spacing & harmonize docs with actual configuration (#4450) (3d45236)
  • directory: don't strip duplicate directory names twice (#4295) (801fbab)
  • pwsh: avoid potential deadlock in init (#4335) (fd55397)

Performance Improvements

  • directory: Skip repo resolution if unused by directory config (#4401) (227ec32)

1.10.3 (2022-09-07)

Performance Improvements

  • git_commit: only use exact match for tag by default (#4281) (5984f08)

1.10.2 (2022-08-18)

Bug Fixes

1.10.1 (2022-08-15)

Bug Fixes

  • Disable multithreading in jwalk (via gitoxide) as workaround for #4251 (#4258) (37b54f7)

1.10.0 (2022-08-14)

Features

  • add bun module (#4187) (85692d1)
  • Add starship preset command (#4112) (c8a5adb)
  • Add support for blink, hidden, and strikethrough styles. (#4138) (aaab920)
  • Add the ability to have some file extensions prevent a module from triggering (#4043) (dd73447)
  • Enable transience for Cmd and PowerShell (#4143) (6e9c013)
  • git: replace git2 with git-repository (#3883) (ac55a01)
  • k8s: Add folder detection to the k8s module. (#4157) (5c5969c)
  • package: support cargo workspace versions (#4161) (0a1235e)
  • status: Add pipestatus_segment_format option to status module (#4103) (6143848)

Bug Fixes

  • aws: support official AWS_SHARED_CREDENTIALS_FILE variable (#4242) (1390036)
  • timings: count time spent on custom on 'when' command failure (#4121) (aae1ed0)

Performance Improvements

  • pulumi: allow disabling upwards discovery (#4159) (af15de9)
  • rust: avoid calling rustup in more conditions (#4174) (d8ac940)

Miscellaneous Chores

1.9.1 (2022-06-27)

Bug Fixes

Miscellaneous Chores

1.9.0 (2022-06-26)

Features

Bug Fixes

  • character: Standadise Vim config names (#4081) (6761938)
  • install: Have fixed a spacing issue in output (#4082) (2ffe173)

1.8.0 (2022-06-16)

Features

Bug Fixes

  • escape text segments in meta variables (#3563) (7d31bac)
  • fish: add proper vi mode detection for fish shell (#3839) (1469763)
  • install: ignore tarfile ownership values when installing as root (#4046) (1a91510)
  • nu: don't use cygpath for starship binary path in init (#4001) (9b52475)
  • some typos (e7c1976)

1.7.1 (2022-05-24)

Bug Fixes

1.7.0 (2022-05-24)

Features

  • go: check for go.work file to show Go module in prompt (#3968) (9ebfce1)
  • hostname: add ssh_symbol for ssh connections (#3806) (2bf30dc)
  • package: Extract package version from PEP 621 compliant pyproject.toml (#3950) (1b938fd)
  • rust: Display toolchain names (#3414) (393d62c)

Bug Fixes

  • ci: Version bump and fix Crowdin Pretranslate (#3992) (a0a6c94)
  • Do not panic in config if editor not found (#3766) (2e80aec)
  • module: list option not working (#3919) (6fe6735)
  • nu: use the most recent starship init (#3908) (382445d)
  • Use git2Repositoryopen_ext() instead of discover() (#3591) (81a696a)

1.6.3 (2022-04-26)

Bug Fixes

  • git_branch: correct variable name for remote branch (#3897) (bd7957f)
  • schema: move config-schema into docs folder (#3878) (094f982)

Performance Improvements

  • package: only try to read files that exist (#3904) (2a650bf)

Reverts

  • schema: move config-schema back into .github folder (#3886) (9b2ce42)

1.6.2 (2022-04-15)

Bug Fixes

  • trigger another release (81d2ce6)

1.6.1 (2022-04-15)

Bug Fixes

  • fix release-please permissions (23be606)

1.6.0 (2022-04-14)

Features

Bug Fixes

  • bash: ensure checkwinsize is enabled for $COLUMNS (#3832) (0334327)
  • directory: enable repo_root_style when truncation_length is zero. (#3536) (441ebb3)
  • docker_context: ignore the "default" context (#3803) (#3804) (230e85b)
  • fish: allow generating session keys in older versions of fish (#3697) (0fb4219)
  • init: Change Elvish init to catch for 0.18 (#3769) (538329d)
  • nu: Use = instead of space to pass command line parameters (#3833) (2608db3)
  • nu: use shell-provided terminal width (#3800) (859b780)

This package has no dependencies.

Discussion for the Starship Package

Ground Rules:

  • This discussion is only about Starship and the Starship package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Starship, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus