oh-my-fish/oh-my-fish
Oh My Fish
This project is a configuration framework for the Fish shell, providing a centralized system for managing plugins, themes, and custom environment settings. It functions as a plugin manager and theme engine that allows users to install, update, and remove functional extensions and visual styles.
The framework includes a shell extension scaffolder that generates standardized directory structures and boilerplate files for creating new plugins and themes. To ensure quality, it provides a specification-based testing suite for validating package functionality through automated assertions.
The system covers a broad range of capabilities, including repository management for Git-based distribution, autoload path and key binding configuration, and system health diagnostics for identifying installation errors. It also supports the management of startup scripts and offline installation.
Features
- Shell Configuration Frameworks - Functions as a comprehensive configuration framework for managing plugins, themes, and settings in the Fish shell.
- Terminal and Command-Line Environments - Provides a comprehensive framework for customizing the interactive Fish shell experience, including key bindings and startup scripts.
- Git Repository Distributions - Manages the distribution, installation, and updating of extensions via remote Git repositories.
- Configuration Search Paths - Manages search paths to determine where functions and completions are loaded from.
- Custom Key Mappings - Provides a system for loading script files that define keyboard shortcuts for users and plugins.
- Shell Plugin Systems - Provides a framework to install, manage, and activate custom extensions for the Fish shell.
- Shell Key Bindings - Sources keyboard shortcuts from themes and packages while supporting user-defined overrides.
- Git-Based Repositories - Manages the installation and updating of shell extensions by cloning and tracking remote Git repositories.
- Shell Themes - Includes a theme engine for managing the visual styling, prompts, and appearance of the Fish shell.
- Package Initialization - Automates the loading of functions, completions, and key bindings during extension package initialization.
- Search Path Loading - Implements directory-based loading of functions and key bindings via shell autoload search paths.
- Prompt Theme Engines - Implements a theme engine for applying visual styles and prompt appearances to the Fish shell.
- Package Registries - Uses a simple file system layout to track installed extensions and metadata for shell discovery.
- Extension Scaffolders - Ships a utility for generating standardized directory structures and boilerplate for creating new shell plugins and themes.
- Hook Registration - Provides mechanisms for registering custom logic to be executed at specific system lifecycle stages.
- Lifecycle Script Execution - Executes specific scripts during installation or resource management lifecycle events.
- Package Installers - Implements utilities to download and install shell extensions from external registries or URLs.
- Direct URL Installations - Allows installing plugins or themes directly from specified web URLs or Git commits.
- Package Removal Utilities - Provides a mechanism to delete installed packages and execute cleanup hooks to remove residual files.
- Scaffolding Tools - Provides automated utilities for generating boilerplate code and structures for new plugins and themes.
- Project Scaffolding Templates - Provides templates for generating standardized directory structures and boilerplate for new plugins and themes.
- Shell Startup Managers - Manages the execution of custom initialization logic before or after plugins load.
- Theme Installers - Allows the installation of visual themes and color schemes for the command prompt.
- Plugin Development Kits - Includes a scaffolder to generate standardized directory structures and boilerplate files for creating new plugins and themes.
- Release Channel Managers - Allows users to switch between stable and development release tracks for the core system.
- Repository Management - Allows users to add, remove, and list the external sources used to discover and install packages.
- Event Hook Systems - Implements an architectural pattern for executing custom logic during specific lifecycle events like installation.
- System Update Managers - Provides a mechanism to refresh the core framework and all installed extensions to their latest versions.
- Automated Test Suites - Ships a specification-based test suite to validate package functionality through automated assertions.
- Visual Themes - Enables changing the shell's visual appearance by selecting and activating specific themes from available options.
- Command Line Tools - Listed in the “Command Line Tools” section of the The Book Of Secret Knowledge awesome list.
- Shell Environment - Configuration framework for the Fish shell.
- Shell Environments - Framework for the Fish shell.
- Shell Frameworks - Core infrastructure for extending the Fish shell.
- Shells and Scripting - Framework for extending Fish shell functionality.
- Terminal and Shell Tools - Plugin framework for the Fish shell.
