Skip to content

README.md

Latest commit

 

History

History
106 lines (78 loc) · 3.63 KB

README.md

File metadata and controls

106 lines (78 loc) · 3.63 KB

🚀🌠 Pulsarship

License: GPL3 Go Version Release Platform

🚀 Pulsarship is a minimal, fast and customizable shell prompt tool written in Go.

✨ Features • 📦 Installation • 🔧 Shell Config • 🛠️ Configuration • 📜 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 or paru:

yay -S pulsarship

or

paru -S pulsarship

🛠️ Install via Script

You can install pulsarship with a single command:

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:

set -Ux PULSARSHIP_CONFIG ~/.config/pulsarship/pulsarship.toml
pulsarship init fish | source

Zsh: Add the following to your ~/.zshrc:

export PULSARSHIP_CONFIG="$HOME/.config/pulsarship/pulsarship.toml"
eval "$(pulsarship init zsh)"

Bash: Add the following to your ~/.bashrc:

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.

🤝 Contributing

Contributions are welcome! See CONTRIBUTING.md for details.

🐞 Reporting Issues

Found a bug or have a suggestion? Open an issue. 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 file for details.