{"id":13897687,"url":"https://github.com/mattmc3/zephyr","last_synced_at":"2025-03-15T12:30:26.099Z","repository":{"id":41357489,"uuid":"464011715","full_name":"mattmc3/zephyr","owner":"mattmc3","description":":wind_face: A Zsh framework as nice as a cool summer breeze","archived":false,"fork":false,"pushed_at":"2024-04-22T11:45:25.000Z","size":1273,"stargazers_count":87,"open_issues_count":3,"forks_count":9,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-04-22T12:59:18.683Z","etag":null,"topics":["zsh","zsh-framework","zsh-plugin","zsh-plugins"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mattmc3.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-02-27T01:48:44.000Z","updated_at":"2024-04-23T21:49:28.912Z","dependencies_parsed_at":"2024-01-29T15:45:15.610Z","dependency_job_id":"a484f99d-5761-4f68-99c4-eb6ec26a5eb2","html_url":"https://github.com/mattmc3/zephyr","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattmc3%2Fzephyr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattmc3%2Fzephyr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattmc3%2Fzephyr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattmc3%2Fzephyr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mattmc3","download_url":"https://codeload.github.com/mattmc3/zephyr/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243730819,"owners_count":20338722,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["zsh","zsh-framework","zsh-plugin","zsh-plugins"],"created_at":"2024-08-06T18:03:48.489Z","updated_at":"2025-03-15T12:30:26.093Z","avatar_url":"https://github.com/mattmc3.png","language":"Shell","readme":"# :wind_face: Zephyr\n\n\u003e A Zsh framework as nice as a cool summer breeze\n\nZsh is a wonderful shell, but out-of-the-box it needs a boost. That's where Zephyr comes\nin.\n\nZephyr combines some of the best parts from [Prezto][prezto] and other Zsh frameworks,\nremoves bloat and dependencies, and prioritizes speed and simplicity.\n\nZephyr can be thought of as a fast, lightweight set of independent Zsh features, and is\ndesigned to be one of the first things you load to build your ideal Zsh config.\n\nCombine Zephyr with a [plugin manager][antidote] and some [awesome\nplugins](https://github.com/unixorn/awesome-zsh-plugins) and you'll have a powerful Zsh\nsetup that rivals anything out there.\n\n## Project goals\n\nZephyr allows you to take an _a la carte_ approach to building your ideal Zsh\nconfiguration. Other Zsh frameworks are meant to be used wholesale and are not truly\nmodular. Zephyr is different - each of its plugins works independently, and are designed\nto pair well with a modern Zsh plugin manager like [antidote]. Zephyr can be used in\nwhole or in part, and plays nice with other popular plugins. Zephyr brings together core\nZsh functionality that typically is not available elsewhere as standalone plugins -\nwhile favoring a build-your-own composable Zsh config.\n\n## Prompt\n\nZephyr comes with an (optional) [Starship][starship] prompt config.\n\n![Zephyr Prompt][terminal-img]\n\n## Install\n\n### Using a Plugin manager\n\nIf your plugin manager supports using sub-plugins, you can load Zephyr that way as well.\n\n[Antidote][antidote] is one such plugin manager. You can load only the parts of Zephyr you need like so:\n\n```shell\n# .zsh_plugins.txt\n# pick only the plugins you want and remove the rest\nmattmc3/zephyr path:plugins/color\nmattmc3/zephyr path:plugins/completion\nmattmc3/zephyr path:plugins/confd\nmattmc3/zephyr path:plugins/directory\nmattmc3/zephyr path:plugins/editor\nmattmc3/zephyr path:plugins/environment\nmattmc3/zephyr path:plugins/history\nmattmc3/zephyr path:plugins/homebrew\nmattmc3/zephyr path:plugins/macos\nmattmc3/zephyr path:plugins/prompt\nmattmc3/zephyr path:plugins/utility\nmattmc3/zephyr path:plugins/zfunctions\n```\n\n### Manually\n\nAdd the following snippet to your `.zshrc`:\n\n```zsh\n# Clone Zephyr.\n[[ -d ${ZDOTDIR:-~}/.zephyr ]] ||\n  git clone --depth=1 https://github.com/mattmc3/zephyr ${ZDOTDIR:-~}/.zephyr\n\n# Use zstyle to specify which plugins you want. Order matters.\nzephyr_plugins=(\n  zfunctions\n  directory\n  editor\n  history\n)\nzstyle ':zephyr:load' plugins $zephyr_plugins\n\n# Source Zephyr.\nsource ${ZDOTDIR:-~}/.zephyr/zephyr.zsh\n```\n\n## Plugins\n\n- **color** - Make terminal things more colorful\n- **completion** - Load and initialize the built-in zsh completion system\n- **compstyle** - Load and initialize a completion style system\n- **confd** - Source a Fish-like `conf.d` directory\n- **directory** - Set options and aliases related to the dirstack and filesystem\n- **editor** - Override and fill in the gaps of the default keybinds\n- **environment** - Define common environment variables\n- **history** - Load and initialize the built-in zsh history system\n- **homebrew** - Functionality for users of Homebrew\n- **macos** - Functionality for macOS users\n- **prompt** - Load and initialize the built-in zsh prompt system\n- **utility** - Common shell utilities, aimed at making cross platform work less painful\n- **zfunctions** - Lazy load a Fish-like functions directory\n\n## Why don't you include...\n\n_Q: Why don't you include programming language plugins (eg: Python, Ruby)?_ \\\n**A:** These kinds of plugins can be very opinionated, and are in need of lots of upkeep\nfrom maintainers that use those languages. Language plugins are already available via\nOh-My-Zsh and Prezto, and can always be installed with [a plugin manager that supports\nsubplugins][antidote].\n\n_Q: Why don't you also include popular plugins the way Prezto does (eg:\nzsh-autosuggestions, zsh-history-substring-search)?_ \\\n**A:** These kinds of utilities are already\navailable as standalone plugins. Zephyr aims to include only core Zsh functionality that\nyou can't already easily get via a [plugin manager][antidote], with a few exceptions for\nconvenience. I have experimented with including submodules similar to Prezto, but was\nnot happy with the result. Simpler is better.\n\n## Credits\n\nZephyr is a derivative work of the following great projects:\n\n- [Prezto][prezto] - [MIT License][prezto-license]\n- [zsh-utils][zsh-utils] - [MIT License][zsh-utils-license]\n- [Oh-My-Zsh][ohmyzsh] - [MIT License][ohmyzsh-license]\n\n[antidote]:           https://antidote.sh\n[ohmyzsh]:            https://github.com/ohmyzsh/ohmyzsh\n[ohmyzsh-license]:    https://github.com/ohmyzsh/ohmyzsh/blob/master/LICENSE.txt\n[prezto]:             https://github.com/sorin-ionescu/prezto\n[prezto-license]:     https://github.com/sorin-ionescu/prezto/blob/master/LICENSE\n[zsh-utils]:          https://github.com/belak/zsh-utils\n[zsh-utils-license]:  https://github.com/belak/zsh-utils/blob/main/LICENSE\n[terminal-img]:       https://raw.githubusercontent.com/mattmc3/zephyr/resources/img/terminal.png\n[starship]:           https://starship.rs\n","funding_links":[],"categories":["Tutorials","Shell"],"sub_categories":["Generic ZSH"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattmc3%2Fzephyr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmattmc3%2Fzephyr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattmc3%2Fzephyr/lists"}