Skip to content

alexandermarquesm/work-fish

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🍵 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.

Banner (Note: Add your own screenshot here!)

✨ Features

  • 🚀 Instant Setup: Run work for the first time, and it guides you through a cozy configuration wizard.
  • ⌨️ 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 (Recommended)

fisher install alexandermarquesm/work-fish

Manual Installation

Clone this repository and copy the files:

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:

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 <project> Directly opens a specific project.
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

About

interactive project manager for the Fish Shell.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors

Languages