458 lines
10 KiB
Markdown
458 lines
10 KiB
Markdown
# Bashrc Dotfiles — Global & Portable Bash Prompt
|
||
|
||
Elegant, portable, and easy-to-install Bash prompt with seasonal palettes, time-aware emoji, and clean powerline structure.
|
||
|
||
---
|
||
|
||
## ⚡ Quick Look
|
||
|
||
- Theme gallery + full specs: [Theme Library](libary.md)
|
||
- Packs: Seasonal (auto), Contest, Holidays, Custom, Git
|
||
- Layout order option: day-time-user, user-time, time-user, day-time
|
||
- Optional git capsule across themes
|
||
|
||
## ✅ Requirements (Nerd Fonts)
|
||
|
||
This prompt relies on Nerd Font glyphs for the rounded separators.
|
||
|
||
```bash
|
||
bash dotfiles/install/install-nerdfont.sh
|
||
```
|
||
|
||
After install:
|
||
|
||
- Set your terminal font to JetBrainsMono Nerd Font (or any Nerd Font)
|
||
- Manual download: https://www.nerdfonts.com/font-downloads
|
||
|
||
If you use a non‑Nerd font, the prompt falls back to ASCII/Unicode.
|
||
|
||
---
|
||
|
||
## 🚀 Install
|
||
|
||
### 🐧 Linux / WSL (global, all users)
|
||
|
||
1) Clone the repo:
|
||
|
||
```bash
|
||
git clone <repo-url>
|
||
```
|
||
|
||
2) Enter the folder:
|
||
|
||
```bash
|
||
cd Bashrc
|
||
```
|
||
|
||
3) Run the global installer (auto-installs deps + prompts for punchline):
|
||
|
||
```bash
|
||
sudo bash dotfiles/install/install-linux-global.sh
|
||
```
|
||
|
||
4) Open a new shell to see the prompt and banner.
|
||
|
||
### 🍏 macOS (per-user)
|
||
|
||
1) Clone the repo:
|
||
|
||
```bash
|
||
git clone <repo-url>
|
||
```
|
||
|
||
2) Enter the folder:
|
||
|
||
```bash
|
||
cd Bashrc
|
||
```
|
||
|
||
3) Run the user installer:
|
||
|
||
```bash
|
||
bash dotfiles/install/install-macos-user.sh
|
||
```
|
||
|
||
4) Reload your shell (or open a new terminal):
|
||
|
||
```bash
|
||
source ~/.bashrc
|
||
```
|
||
|
||
<details>
|
||
<summary><strong>Installer menu (structure)</strong></summary>
|
||
|
||
```text
|
||
Install options
|
||
├─ 1) PS1 only
|
||
├─ 2) Banner only
|
||
└─ 3) Both (PS1 + banner)
|
||
└─ PS1 mode
|
||
├─ 1) Single season (static)
|
||
│ ├─ Pick season (Winter/Spring/Summer/Autumn)
|
||
│ └─ Layout order (day-time-user / user-time / time-user / day-time)
|
||
├─ 2) Dynamic season (auto)
|
||
│ └─ Layout order (day-time-user / user-time / time-user / day-time)
|
||
├─ 3) Contest pack (static)
|
||
│ ├─ Layout order
|
||
│ └─ Style preset (Aurora/Neon/Forge/Circuit/Mono/Git/Hawolex/HawolexV2)
|
||
├─ 4) Holidays pack (static)
|
||
│ ├─ Pick holiday (Christmas/Easter/Halloween/Valentine/Thanksgiving/NewYear)
|
||
│ └─ Layout order
|
||
└─ 5) Custom pack (static)
|
||
└─ Style (Radar/Synthwave/Noir/Topo/Glitch/ArcticFire/AcidLime)
|
||
|
||
Final prompt:
|
||
└─ Enable git capsule for all themes? [y/N]
|
||
```
|
||
</details>
|
||
|
||
<details>
|
||
<summary><strong>Installer choices</strong></summary>
|
||
|
||
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
|
||
</details>
|
||
|
||
---
|
||
|
||
## ✨ 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
|
||
|
||
---
|
||
|
||
<details>
|
||
<summary><strong>What gets installed</strong></summary>
|
||
|
||
### 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`
|
||
|
||
</details>
|
||
|
||
---
|
||
|
||
<details>
|
||
<summary><strong>PS1 module (when it runs)</strong></summary>
|
||
|
||
- 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.
|
||
</details>
|
||
|
||
---
|
||
|
||
<details>
|
||
<summary><strong>Banner (hostname + punchline + sysinfo)</strong></summary>
|
||
|
||
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:
|
||
|
||
```bash
|
||
echo "Your punchline" | sudo tee /etc/ps1-punchline >/dev/null
|
||
```
|
||
</details>
|
||
|
||
---
|
||
|
||
## 🎛️ 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.
|
||
|
||
---
|
||
|
||
<details>
|
||
<summary><strong>Custom Pack (bold styles)</strong></summary>
|
||
|
||
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`).
|
||
</details>
|
||
|
||
---
|
||
|
||
<details>
|
||
<summary><strong>Git Theme (details)</strong></summary>
|
||
|
||
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`
|
||
</details>
|
||
|
||
---
|
||
|
||
<details>
|
||
<summary><strong>Holidays Pack (themes)</strong></summary>
|
||
|
||
Holidays pack uses themed palettes + emojis and the contest layout order:
|
||
|
||
- Christmas, Easter, Halloween, Valentine, Thanksgiving, New Year
|
||
</details>
|
||
|
||
---
|
||
|
||
## 🧭 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
|
||
|
||
---
|
||
|
||
<details>
|
||
<summary><strong>Emoji palette</strong></summary>
|
||
|
||
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
|
||
</details>
|
||
|
||
---
|
||
|
||
## 🗂️ Repo Structure
|
||
|
||
```text
|
||
.
|
||
├── .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
|
||
```
|
||
|
||
<details>
|
||
<summary><strong>Overrides (Optional)</strong></summary>
|
||
|
||
Sometimes autodetection doesn’t work (e.g., on macOS without fontconfig):
|
||
|
||
Force Nerd Font glyphs:
|
||
|
||
```bash
|
||
export PS1_FORCE_NF=1
|
||
```
|
||
|
||
Force fallback (no powerline glyphs):
|
||
|
||
```bash
|
||
export PS1_FORCE_ASCII=1
|
||
```
|
||
|
||
Add these to your `~/.bashrc` or `~/.bash_profile`.
|
||
</details>
|
||
|
||
---
|
||
|
||
<details>
|
||
<summary><strong>Disable prompt (per user)</strong></summary>
|
||
|
||
If you want to disable the global prompt for your account:
|
||
|
||
Temporarily in a shell:
|
||
|
||
```bash
|
||
export DISABLE_GLOBAL_PS1=1
|
||
```
|
||
|
||
Permanently:
|
||
|
||
```bash
|
||
mkdir -p ~/.config/ps1
|
||
touch ~/.config/ps1/disable
|
||
```
|
||
|
||
To re-enable:
|
||
|
||
```bash
|
||
rm -f ~/.config/ps1/disable
|
||
```
|
||
</details>
|
||
|
||
---
|
||
|
||
<details>
|
||
<summary><strong>Testing</strong></summary>
|
||
|
||
After install, open a new shell and run:
|
||
|
||
```bash
|
||
bash -i -c 'echo OK'
|
||
```
|
||
|
||
If you see a prompt with colors and emoji, things are working.
|
||
</details>
|
||
|
||
---
|
||
|
||
<details>
|
||
<summary><strong>Usage notes</strong></summary>
|
||
|
||
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.
|
||
</details>
|
||
|
||
---
|
||
|
||
## 📸 Theme Gallery
|
||
|
||
Seasonal (Aurora):
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Contest pack:
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Holidays pack:
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Custom pack:
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Palette reference:
|
||
|
||
<p align="center">
|
||
<img src="images/bash-pallete.png" width="900">
|
||
</p>
|
||
|
||
---
|
||
|
||
## 🛠️ 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
|