https://github.com/alexandermarquesm/work-fish
interactive project manager for the Fish Shell.
https://github.com/alexandermarquesm/work-fish
cli-tool fish fish-shell fzf productivity shell-extension workflow
Last synced: 5 days ago
JSON representation
interactive project manager for the Fish Shell.
- Host: GitHub
- URL: https://github.com/alexandermarquesm/work-fish
- Owner: alexandermarquesm
- License: mit
- Created: 2026-04-11T18:31:32.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-06-19T01:36:50.000Z (10 days ago)
- Last Synced: 2026-06-24T02:34:25.383Z (5 days ago)
- Topics: cli-tool, fish, fish-shell, fzf, productivity, shell-extension, workflow
- Language: Shell
- Homepage: https://github.com/alexandermarquesm
- Size: 15.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🍵 work-fish
A cozy, interactive project manager for the Fish Shell.
`work` is a productivity tool designed to help you jump between your projects instantly using a beautiful, keyboard-navigable interface. It supports automatic editor detection, fuzzy finding (via `fzf`), and is styled with a soft, cozy Catppuccin-inspired palette.
 *(Note: Add your own screenshot here!)*
## ✨ Features
- **🚀 Instant Setup**: Run `work` for the first time, and it guides you through a cozy configuration wizard.
- **🆕 Project Creation**: Instantly create a new project with `work --new ` (or `-n `) and optionally initialize a Git repository.
- **🗑️ Safe Deletion**: Safely delete projects with confirmation using `work --delete ` (or `-d `), keeping a backup copy in `/tmp/work_backups`.
- **⌨️ Keyboard Navigation**: Select editors using Arrows, `W/S`, or `J/K`.
- **🔍 Fuzzy Search**: Integrated with `fzf` for lightning-fast project switching.
- **🎨 Cozy Aesthetics**: Styled with Lavender, Sage, and Rose pastel colors.
- **🧩 Smart Completions**: Tab-complete your project names and command flags.
- **🧹 Auto-Cleanup**: Automatically wipes its universal variables upon uninstallation to keep your system clean.
- **🛠️ Flexible**: Change your path (`--path`) or editor (`--editor`) anytime.
## 📦 Installation
### Using [fisher](https://github.com/jorgebucaran/fisher) (Recommended)
```fish
fisher install alexandermarquesm/work-fish
```
### Manual Installation
Clone this repository and copy the files:
```fish
cp functions/work.fish ~/.config/fish/functions/
cp completions/work.fish ~/.config/fish/completions/
cp conf.d/work.fish ~/.config/fish/conf.d/
```
## 🗑️ Uninstallation
If you used **fisher**:
```fish
fisher remove alexandermarquesm/work-fish
```
*(The tool will automatically clean up its universal variables and say goodbye!)*
## 🚀 Usage
| Command | Description |
|---|---|
| `work` | Opens the interactive project picker (fzf). |
| `work ` | Directly opens a specific project. |
| `work -n ` / `work --new ` | Creates and opens a new project. |
| `work -d ` / `work --delete ` | Safely deletes a project (moving a backup to `/tmp/work_backups/`). |
| `work --help` | Shows the interactive guide. |
| `work --path` | Change your projects base directory. |
| `work --editor` | Select a different code editor. |
| `work --reset` | Clear all settings and start fresh. |
## 🍵 Configuration
On the first run, `work` will ask you for:
1. Your projects directory (defaulting to `~/projects`).
2. Your preferred code editor (auto-detects VS Code, Vim, NeoVim, Zed, etc.).
Settings are stored in **Universal Variables** (`set -Ux`), so they persist across sessions without cluttering your config files.
## 🤝 Contributing
Feel free to open issues or pull requests if you have ideas for more "cozy" features!
## 📄 License
MIT © [Alexander Marques](https://github.com/alexandermarquesm)