https://github.com/axrona/pulsarship
🚀🌠 A minimal, fast, and customizable terminal prompt written in Go
https://github.com/axrona/pulsarship
bash fish fish-prompt golang linux prompt pulsarship shell shell-prompt zsh zsh-prompt
Last synced: 9 months ago
JSON representation
🚀🌠 A minimal, fast, and customizable terminal prompt written in Go
- Host: GitHub
- URL: https://github.com/axrona/pulsarship
- Owner: axrona
- License: gpl-3.0
- Created: 2025-07-19T08:52:57.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-08-25T08:14:22.000Z (10 months ago)
- Last Synced: 2025-08-25T10:43:04.546Z (10 months ago)
- Topics: bash, fish, fish-prompt, golang, linux, prompt, pulsarship, shell, shell-prompt, zsh, zsh-prompt
- Language: Go
- Homepage:
- Size: 1.51 MB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀🌠 Pulsarship
[](https://github.com/axrona/pulsarship/blob/main/LICENSE)
[](https://golang.org/dl/)
[](https://github.com/axrona/pulsarship/releases/latest)
[](https://www.kernel.org/)
---
**🚀 Pulsarship** is a minimal, fast and customizable shell prompt tool written in Go.
[✨ Features](#-features) • [📦 Installation](#-installation) • [🔧 Shell Config](#-add-to-your-shell-config) • [🛠️ Configuration](#-configuration) • [📜 License](#-license)
## ✨ Features
- ⚙️ Modular architecture – Easily customize each part of the prompt
- 🎨 Color palette support – Define theme colors using `palette`
- 🧩 Components – Includes:
- `cwd`, `username`, `hostname`, `git`, `character`, etc
- 🧰 Custom components – Define your own modules
- ⚡ Blazing fast – Lightweight Go binary
- 🧪 Extensible – Right prompt, async, etc
---
## 📦 Installation
### 🔁 AUR (Arch Linux / Manjaro / EndeavourOS)
If you're using an Arch-based distribution, you can install `pulsarship` from the AUR using an AUR helper like [`yay`](https://github.com/Jguer/yay) or [`paru`](https://github.com/Morganamilo/paru):
```bash
yay -S pulsarship
```
or
```bash
paru -S pulsarship
```
### 🛠️ Install via Script
You can install `pulsarship` with a single command:
```bash
curl -sS https://raw.githubusercontent.com/axrona/pulsarship/main/install.sh | bash
```
This script will clone the repository, build the binary, and install it for you.
### 🔧 Add to your shell config
Add the following to your `~/.config/fish/config.fish`:
**Fish:**
```bash
set -Ux PULSARSHIP_CONFIG ~/.config/pulsarship/pulsarship.toml
pulsarship init fish | source
```
**Zsh:**
Add the following to your `~/.zshrc`:
```zsh
export PULSARSHIP_CONFIG="$HOME/.config/pulsarship/pulsarship.toml"
eval "$(pulsarship init zsh)"
```
**Bash:**
Add the following to your `~/.bashrc`:
```bash
export PULSARSHIP_CONFIG="$HOME/.config/pulsarship/pulsarship.toml"
eval "$(pulsarship init bash)"
```
> Make sure to restart your shell or source the config file after editing:
> `source ~/.config/fish/config.fish` or `source ~/.bashrc` or `source ~/.zshrc`
## 🛠️ Configuration
The default config file location is `~/.config/pulsarship/pulsarship.toml`.
You can generate this file by running the `pulsarship gen-config` command.
Pulsarship uses TOML-based configuration for customizing the prompt and other settings.
For more information visit the [Wiki](https://github.com/axrona/pulsarship/wiki).
## 🤝 Contributing
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
## 🐞 Reporting Issues
Found a bug or have a suggestion? [Open an issue](https://github.com/axrona/pulsarship/issues). Be concise and include any relevant output or screenshots.
## 📜 License
This project is licensed under the **GNU General Public License v3.0.**
See the [LICENSE](LICENSE) file for details.