steffen/ps1-craft
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
a7c88d772e4f6b64bbb43f1254bf3d5e90adf9a7
ps1-craft/README.md

9.2 KiB
Raw Blame History

Bashrc Dotfiles — Global & Portable Bash Prompt

Elegant, portable, and easy-to-install Bash prompt with seasonal palettes, time-aware emoji, and clean powerline structure.

✅ Requirements (Nerd Fonts)

This prompt relies on Nerd Font glyphs for the rounded separators.

bash dotfiles/install/install-nerdfont.sh

After install:

If you use a non‑Nerd font, the prompt falls back to ASCII/Unicode.

🚀 Install

🐧 Linux / WSL (global, all users)

  1. Clone the repo:
git clone <repo-url>
  1. Enter the folder:
cd Bashrc
  1. Run the global installer (auto-installs deps + prompts for punchline):
sudo bash dotfiles/install/install-linux-global.sh
  1. Open a new shell to see the prompt and banner.

🍏 macOS (per-user)

  1. Clone the repo:
git clone <repo-url>
  1. Enter the folder:
cd Bashrc
  1. Run the user installer:
bash dotfiles/install/install-macos-user.sh
  1. Reload your shell (or open a new terminal):
source ~/.bashrc
Installer choices

Linux/WSL:

  • PS1 only / Banner only / Both
  • PS1 modes: Single season, Dynamic season, Contest pack, Holidays pack, Custom pack
  • Dynamic season auto-switches by time of year (Spring: Mar–May, Summer: Jun–Aug, Autumn: Sep–Nov 14, Winter: Nov 15–Feb)
  • Layout order (day-time-user, user-time, time-user, day-time) for seasonal and contest modes

macOS:

  • PS1 modes: Single season, Dynamic season, Contest pack, Holidays pack, Custom pack
  • Dynamic season auto-switches by time of year (same ranges as Linux)
  • Layout order (day-time-user, user-time, time-user, day-time) for seasonal and contest modes

✨ Features

  • Two-line, powerline-style prompt
  • Seasonal palettes + time-based emoji accents
  • Smart path shortening (keeps home visible)
  • Status-colored prompt arrow
  • Works on Linux, WSL, and macOS
  • Per-user disable switch
What gets installed

Linux / WSL

  • Installs the prompt module to /etc/profile.d/ps1.sh
  • Installs the banner module to /etc/profile.d/banner.sh
  • Sources both from /etc/bash.bashrc
  • Installs landscape-common, figlet, and lolcat if missing
  • Prompts for the global punchline used by the banner
  • You can change the selection or remove PS1/banner by running the installer again

macOS

  • Copies ps1/ps1.sh to ~/.config/ps1/ps1.sh
  • Adds a source block in ~/.bashrc and ~/.bash_profile
PS1 module (when it runs)
  • Linux/WSL: sourced from /etc/bash.bashrc (global)
  • macOS: sourced from ~/.bashrc and ~/.bash_profile (per-user)

You normally do not need to run ps1.sh manually.

Banner (hostname + punchline + sysinfo)

On Linux/WSL, a banner is also shown on login:

  • figlet $(hostname) -c | lolcat
  • figlet -f digital "<punchline>" -c | lolcat
  • landscape-sysinfo | lolcat

Punchline (global)

The banner reads the punchline from:

  • /etc/ps1-punchline

The install script prompts for a punchline and stores it in the file. You can also set it manually:

echo "Your punchline" | sudo tee /etc/ps1-punchline >/dev/null

🎛️ Themes & Style Packs

🏁 Contest Pack

The contest pack is a bold, DEFCON-ready set of five styles (Aurora, Neon, Forge, Circuit, Mono) with optional layout order. It always starts on a new line and ends with @host - /path.

Note: This repo was built with AI assistance, and the contest pack itself is fully AI-authored.

Custom Pack (bold styles)

Seven extra styles, built to be loud and expressive:

  • Radar: green scanline HUD
  • Synthwave: pink/cyan/orange glow blocks
  • Noir: near-black minimal + red path
  • Topo: elevation-style path segments
  • Glitch: jitter separators + neon
  • ArcticFire: icy blues into ember orange
  • AcidLime: black + electric green

Custom styles add a small context badge when relevant (ssh, ctr, git).

Git Theme (details)

The Git theme adds a repo-aware capsule on line 2 that only appears inside a Git repo. The branch name is wrapped as ⟦branch⟧, and status emojis reflect state:

  • Clean: ✨
  • Dirty: 🔨
  • Staged: 📌
  • Untracked: 🧷
  • Stashed: 📦

It uses the same two-block layout as Aurora, but focuses on signal and minimal noise for fast scanning. Use it when you want repo status on every command without a full VCS prompt.

Git capsule switch:

  • PS1_GIT=1 enables the git capsule on all themes
  • Git theme always shows it, regardless of PS1_GIT
Holidays Pack (themes)

Holidays pack uses themed palettes + emojis and the contest layout order:

  • Christmas, Easter, Halloween, Valentine, Thanksgiving, New Year

🧭 Theme Design Notes

  • Aurora (seasonal): calm hierarchy, subtle gradients, long-term readability
  • Contest styles: bold contrast and distinct silhouettes for instant recognition
  • Custom pack: experimental, high-signal variants for strong personal style
  • Holidays: themed colors + emojis without compromising legibility
Emoji palette

Fixed times (all seasons):

  • Lunch 11:00–11:29 = 🥪
  • Dinner 16:00–16:59 = 🍲

Seasonal sets (sunrise / work):

  • Spring: 🌷 🌱 🐣 🌤 / 🌿 🪴 🐝 🌼
  • Summer: 🌞 🏖️ 🌅 🌤 / 🏄 🏖️ 🚤 🌴
  • Autumn: 🍁 🍂 🌫️ 🌦️ / 🍂 🍄 🎃 🪵
  • Winter: 🏔️ 🌨️ ❄️ 🌌 / 🎿 ⛷️ 🏂 🧊

Time slots:

  • Sunrise: 05:00–08:59
  • Coffee: 09:00–10:59
  • Work: 11:30–15:59 (unless lunch overrides)
  • Evening: 17:00–22:59
  • Night: 23:00–04:59

Meaning:

  • Emoji is a light accent for time/season; it never replaces core info

🗂️ Repo Structure

.
├── .context.json
├── contest-styles.json
├── images/
│   ├── bash-pallete.png
│   └── contest.png
│   └── themes/
├── dotfiles/
│   ├── banner/
│   │   └── banner.sh
│   ├── ps1/
│   │   └── ps1.sh
│   └── install/
│       ├── install-global-ps1.sh
│       ├── install-linux-global.sh
│       ├── install-macos-user.sh
│       └── install-nerdfont.sh
└── README.md
Overrides (Optional)

Sometimes autodetection doesn’t work (e.g., on macOS without fontconfig):

Force Nerd Font glyphs:

export PS1_FORCE_NF=1

Force fallback (no powerline glyphs):

export PS1_FORCE_ASCII=1

Add these to your ~/.bashrc or ~/.bash_profile.

Disable prompt (per user)

If you want to disable the global prompt for your account:

Temporarily in a shell:

export DISABLE_GLOBAL_PS1=1

Permanently:

mkdir -p ~/.config/ps1
touch ~/.config/ps1/disable

To re-enable:

rm -f ~/.config/ps1/disable
Testing

After install, open a new shell and run:

bash -i -c 'echo OK'

If you see a prompt with colors and emoji, things are working.

Usage notes

Font matters: even with Nerd Fonts installed, you must select them in your terminal settings.

Works on terminals like:

  • GNOME Terminal
  • iTerm2
  • Kitty
  • VS Code integrated terminal
  • Windows Terminal (WSL)

If you see squares or missing glyphs, your terminal is likely using a non-Nerd font.

📸 Theme Gallery

Seasonal (Aurora):

Winter Spring Summer Autumn

Contest pack:

Aurora (contest) Neon Forge Circuit Mono Git Hawolex HawolexV2

Holidays pack:

Christmas Easter Halloween Valentine Thanksgiving NewYear

Custom pack:

Radar Synthwave Noir Topo Glitch ArcticFire AcidLime

Palette reference:

🛠️ Contribution

Want to help improve this project?

  • Fork the repository
  • Make your changes
  • Open a merge request
  • Please keep consistent colors and styles

📄 License

MIT © 2026 Steffen Skui