https://github.com/devmor-j/private.fish
A lightweight Fish shell extension to indicate private mode sessions in your prompt with a ghost icon 👻
https://github.com/devmor-j/private.fish
fish fish-plugin
Last synced: 18 days ago
JSON representation
A lightweight Fish shell extension to indicate private mode sessions in your prompt with a ghost icon 👻
- Host: GitHub
- URL: https://github.com/devmor-j/private.fish
- Owner: devmor-j
- License: mit
- Created: 2025-08-18T14:36:54.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-18T16:54:00.000Z (10 months ago)
- Last Synced: 2025-08-18T17:14:49.740Z (10 months ago)
- Topics: fish, fish-plugin
- Language: Shell
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 🕵️♂️ private.fish
A lightweight Fish shell extension to indicate **private mode** sessions in your prompt with a ghost icon 👻. Each terminal session is tracked independently, and the icon can show a per-terminal activity count.
## 🚀 Features
- **Private mode indicator**: Shows a ghost icon `👻` in the prompt for private Fish sessions.
- **Per-terminal session tracking**: Counts actions/outputs **per terminal**, independent of other terminals.
- **Customizable behavior** via universal variables: control symbol and count display.
- **Automatic prompt wrapping**: Works with any Fish prompt without modifying it manually.
---
## ⚙️ Installation
Install using [fisher](https://github.com/jorgebucaran/fisher):
```bash
fisher install devmor-j/private.fish
```
> Fish will automatically detect private mode and display the ghost icon in your prompt.
---
## 📝 Configuration / Defaults
| Variable | Default | Description |
| -------------------- | ------- | -------------------------------------------- |
| `private_symbol` | `👻` | The icon used for private sessions. |
| `private_show_count` | `true` | Show a numeric count next to the ghost icon. |
You can override defaults by setting these variables in your Fish config (`config.fish`) before loading `private.fish`. Example:
```fish
set -U private_symbol "🔒"
set -U private_show_count false
set -U root_symbol "🔥"
```
If you need more space between emojies, add them on the variable itself.
### 🔒 Emojis
Here are some emojis you can use for private mode:
- 👻 **Ghost (default)**
- 🔒 Lock
- 🔑 Key
- 🐡 Pufferfish
- 🦈 Shark
- 🐙 Octopus
And some _root_ related emojies when in root mode:
- 🔥 **Fire (default)**
- ☠️ Skull
- 🛡️ Shield
- ⚡️ Lightning
- 💥 Explosion
- 👑 Crown
---
## 💡 Usage
1. Open a Fish terminal in private mode:
```bash
fish -P
# or fish --private
```
2. You’ll see the ghost icon `👻` in your prompt.
3. If you have multiple commands recorded in the session and `private_show_count=true`, the icon will show the count, e.g., `👻3`.
4. Each terminal is independent, so counts don’t interfere with each other.
Note: Will show "🔥" icon (fire is default) when _root_ user is active. So you'd be more careful since you have full access.
## 📝 License
MIT License. Free to use and modify.
This plugin was developed with AI assistance; Expect bugs and compatibility issues until they are fixed.