# spaceship-prompt/spaceship-prompt **Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/spaceship-prompt-spaceship-prompt).** 20,398 stars · 969 forks · Shell · mit ## Links - GitHub: https://github.com/spaceship-prompt/spaceship-prompt - Homepage: https://spaceship-prompt.sh - awesome-repositories: https://awesome-repositories.com/repository/spaceship-prompt-spaceship-prompt.md ## Topics `oh-my-zsh` `prompt` `shell` `shell-prompt` `shell-theme` `spaceship` `terminal` `zsh` `zsh-theme` `zsh-users` ## Description Spaceship Prompt is a modular, highly customizable Zsh prompt framework designed to provide rich contextual information directly within the command line interface. It functions as a shell environment monitor, allowing users to track system metrics, version control status, and development environment details through a structured, theme-based layout. The framework distinguishes itself through an asynchronous execution model that offloads resource-intensive status checks to background processes, ensuring the terminal remains responsive during prompt generation. It supports incremental rendering, where prompt segments update as data becomes available, and utilizes declarative configuration to manage the visibility, order, and styling of individual components. Users can define complex, environment-aware logic that dynamically adjusts the prompt based on the current working directory, active language runtimes, or infrastructure context. The project covers a broad capability surface, including deep integration with version control systems, cloud and container orchestration tools, and local system monitoring. It provides extensive layout controls, enabling users to position elements on both sides of the terminal, insert line breaks, and apply custom decorators to organize information density. The system also includes utilities for directory-based context detection, allowing for automatic configuration overrides when navigating into specific project folders. ## Tags ### Development Tools & Productivity - [Zsh Frameworks](https://awesome-repositories.com/f/development-tools-productivity/terminal-shell-cli/terminal-cli-enhancements/shell-terminal-utilities/frameworks-architectures/shell-frameworks/zsh-frameworks.md) — Provides a modular and highly customizable framework for Zsh prompt themes that display contextual system and version control information. - [Terminal Prompt Customizers](https://awesome-repositories.com/f/development-tools-productivity/terminal-shell-cli/cli-tooling-frameworks/cli-tooling/shell-productivity-enhancements/terminal-prompt-customizers.md) — Provides a modular framework for personalizing the command line interface with custom information segments. - [Version Control Interfaces](https://awesome-repositories.com/f/development-tools-productivity/version-control-interfaces.md) — Displays branch, commit hash, and dirty state indicators in the command line prompt. ([source](https://spaceship-prompt.sh/sections/git/)) - [Shell Environment Orchestrators](https://awesome-repositories.com/f/development-tools-productivity/shell-environment-orchestrators.md) — Monitors and displays active runtime versions, cloud profiles, and repository states within the command line. - [Asynchronous Execution Utilities](https://awesome-repositories.com/f/development-tools-productivity/asynchronous-execution-utilities.md) — Manages asynchronous execution of prompt sections to maintain shell responsiveness during data retrieval. ([source](https://spaceship-prompt.sh/api/utils/)) - [Asynchronous Prompt Renderers](https://awesome-repositories.com/f/development-tools-productivity/terminal-shell-cli/terminal-cli-enhancements/shell-terminal-utilities/general-enhancements-tooling/shell-enhancements/asynchronous-prompt-renderers.md) — Updates the command line interface incrementally as background tasks complete to provide immediate feedback. - [Context-Aware Environment Managers](https://awesome-repositories.com/f/development-tools-productivity/context-aware-environment-managers.md) — Dynamically toggles prompt segments based on the current working directory and environment context. - [Development Environments](https://awesome-repositories.com/f/development-tools-productivity/development-environments.md) — Displays active language versions and virtual environments to track development settings. - [Version Control and Repository Tools](https://awesome-repositories.com/f/development-tools-productivity/version-control-repository-tools.md) — Displays repository branch names and commit status for immediate version control awareness. - [Prompt Configuration Managers](https://awesome-repositories.com/f/development-tools-productivity/prompt-configuration-managers.md) — Supports declarative configuration files to persist and autoload custom shell prompt settings for a consistent terminal experience. ([source](https://spaceship-prompt.sh/blog/2022-spaceship-v4/)) - [System Status Utilities](https://awesome-repositories.com/f/development-tools-productivity/system-status-utilities.md) — Monitors real-time system metrics like battery levels and command execution time within the prompt. - [Command Execution](https://awesome-repositories.com/f/development-tools-productivity/command-execution.md) — Displays a colored prompt character based on the success or failure of the previous command. ([source](https://spaceship-prompt.sh/sections/char/)) - [Runtime Context Providers](https://awesome-repositories.com/f/development-tools-productivity/context-retrieval-engines/runtime-context-providers.md) — Injects infrastructure and container metadata into the prompt for immediate visibility. ([source](https://spaceship-prompt.sh/fr/)) - [Exit Status Signaling](https://awesome-repositories.com/f/development-tools-productivity/exit-status-reporters/exit-status-signaling.md) — Shows the exit code of the most recently executed command to provide immediate feedback. ([source](https://spaceship-prompt.sh/sections/exit_code/)) - [Shell Integration Hooks](https://awesome-repositories.com/f/development-tools-productivity/shell-integration-hooks.md) — Executes custom shell functions during the prompt rendering lifecycle to inject dynamic system information. ### Software Engineering & Architecture - [Asynchronous Background Processors](https://awesome-repositories.com/f/software-engineering-architecture/asynchronous-background-processors.md) — Offloads resource-intensive status checks to background processes to maintain terminal responsiveness during prompt generation. - [Repository Status Indicators](https://awesome-repositories.com/f/software-engineering-architecture/project-management-governance/repository-maintenance/repository-metadata/repository-status-indicators.md) — Displays current branch and uncommitted change status for version control repositories. ([source](https://spaceship-prompt.sh/sections/hg/)) - [Declarative Configuration](https://awesome-repositories.com/f/software-engineering-architecture/declarative-configuration.md) — Uses structured configuration files to define the visibility, order, and styling of prompt components. ### Programming Languages & Runtimes - [Version Managers](https://awesome-repositories.com/f/programming-languages-runtimes/language-ecosystems-tooling/version-managers.md) — Detects and displays active language runtimes and toolchain versions for projects in the current directory. ([source](https://spaceship-prompt.sh/blog/2017-spaceship-v2/)) ### DevOps & Infrastructure - [Cloud Infrastructure](https://awesome-repositories.com/f/devops-infrastructure/cloud-infrastructure.md) — Tracks active cloud profiles, Kubernetes clusters, and infrastructure stacks directly within the terminal. ### System Administration & Monitoring - [Cluster Monitoring](https://awesome-repositories.com/f/system-administration-monitoring/cluster-monitoring.md) — Shows active Kubernetes cluster and namespace information directly in the command line prompt. ([source](https://spaceship-prompt.sh/sections/kubectl/)) - [System Environment Queries](https://awesome-repositories.com/f/system-administration-monitoring/system-diagnostics/system-environment-queries.md) — Displays real-time system environment and runtime information in the command line prompt. ([source](https://spaceship-prompt.sh/de/)) ### Operating Systems & Systems Programming - [Prompt Customization Tools](https://awesome-repositories.com/f/operating-systems-systems-programming/terminal-command-line-environments/terminal-customization-tools/terminal-customization/prompt-customization-tools.md) — Enables the injection of arbitrary data and custom scripts into the command line prompt for enhanced situational awareness. ([source](https://spaceship-prompt.sh/fr/)) - [Shell Prompt Themes](https://awesome-repositories.com/f/operating-systems-systems-programming/terminal-command-line-environments/terminal-customization-tools/terminal-customization/shell-prompt-themes.md) — Displays Nix environment status and purity indicators within the shell prompt. ([source](https://spaceship-prompt.sh/sections/nix_shell/))