{"id":13751941,"url":"https://github.com/zap-zsh/zap","last_synced_at":"2025-05-16T05:06:05.013Z","repository":{"id":62802189,"uuid":"556830783","full_name":"zap-zsh/zap","owner":"zap-zsh","description":":zap: Zap is a minimal zsh plugin manager","archived":false,"fork":false,"pushed_at":"2024-05-23T18:33:36.000Z","size":174,"stargazers_count":1052,"open_issues_count":12,"forks_count":41,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-08T15:06:38.466Z","etag":null,"topics":["plugin-manager","sh","shell","zsh","zshell"],"latest_commit_sha":null,"homepage":"https://www.zapzsh.com/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zap-zsh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","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,"publiccode":null,"codemeta":null},"funding":{"github":"christianchiarulli","patreon":"chrisatmachine","ko_fi":"chrisatmachine"}},"created_at":"2022-10-24T15:40:29.000Z","updated_at":"2025-04-06T07:13:37.000Z","dependencies_parsed_at":"2024-01-03T04:15:24.016Z","dependency_job_id":"0a39f002-2136-4ff3-bb88-d5e586a53eb6","html_url":"https://github.com/zap-zsh/zap","commit_stats":{"total_commits":200,"total_committers":27,"mean_commits":7.407407407407407,"dds":0.75,"last_synced_commit":"6d8c83ae1650df8f51ffb45651d679a293822e16"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zap-zsh%2Fzap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zap-zsh%2Fzap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zap-zsh%2Fzap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zap-zsh%2Fzap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zap-zsh","download_url":"https://codeload.github.com/zap-zsh/zap/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254471061,"owners_count":22076585,"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":["plugin-manager","sh","shell","zsh","zshell"],"created_at":"2024-08-03T09:00:57.370Z","updated_at":"2025-05-16T05:06:04.037Z","avatar_url":"https://github.com/zap-zsh.png","language":"Shell","funding_links":["https://github.com/sponsors/christianchiarulli","https://patreon.com/chrisatmachine","https://ko-fi.com/chrisatmachine"],"categories":["Frameworks","Terminal","Shell"],"sub_categories":["[zshPlug](https://github.com/Atlas34/zshPlug)","Shell","\u003cb\u003e\u003ccode\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;0⭐\u003c/code\u003e\u003c/b\u003e \u003cb\u003e\u003ccode\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;0🍴\u003c/code\u003e\u003c/b\u003e [zshPlug](https://github.com/Atlas34/zshPlug))"],"readme":"\u003cdiv align=\"center\"\u003e\n\n![zap_logo](https://user-images.githubusercontent.com/29136904/202043505-8fda8d1e-3669-463b-a0c9-38c367ffb753.png)\n\n\u003c/div\u003e\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n\u003cp\u003e\n    \u003ca href=\"https://github.com/zap-zsh/zap/releases/latest\"\u003e\n      \u003cimg alt=\"Latest release\" src=\"https://img.shields.io/github/v/release/zap-zsh/zap?style=for-the-badge\u0026logo=starship\u0026color=C9CBFF\u0026logoColor=D9E0EE\u0026labelColor=302D41\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/zap-zsh/zap/pulse\"\u003e\n      \u003cimg alt=\"Last commit\" src=\"https://img.shields.io/github/last-commit/zap-zsh/zap?style=for-the-badge\u0026logo=starship\u0026color=8bd5ca\u0026logoColor=D9E0EE\u0026labelColor=302D41\"/\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/zap-zsh/zap/blob/master/LICENSE\"\u003e\n      \u003cimg alt=\"License\" src=\"https://img.shields.io/github/license/zap-zsh/zap?style=for-the-badge\u0026logo=starship\u0026color=ee999f\u0026logoColor=D9E0EE\u0026labelColor=302D41\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/zap-zsh/zap/stargazers\"\u003e\n      \u003cimg alt=\"Stars\" src=\"https://img.shields.io/github/stars/zap-zsh/zap?style=for-the-badge\u0026logo=starship\u0026color=c69ff5\u0026logoColor=D9E0EE\u0026labelColor=302D41\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/zap-zsh/zap/issues\"\u003e\n      \u003cimg alt=\"Issues\" src=\"https://img.shields.io/github/issues/zap-zsh/zap?style=for-the-badge\u0026logo=bilibili\u0026color=F5E0DC\u0026logoColor=D9E0EE\u0026labelColor=302D41\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/zap-zsh/zap\"\u003e\n      \u003cimg alt=\"Repo Size\" src=\"https://img.shields.io/github/repo-size/zap-zsh/zap?color=%23DDB6F2\u0026label=SIZE\u0026logo=codesandbox\u0026style=for-the-badge\u0026logoColor=D9E0EE\u0026labelColor=302D41\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://patreon.com/chrisatmachine\" title=\"Donate to this project using Patreon\"\u003e\n      \u003cimg alt=\"Patreon donate button\" src=\"https://img.shields.io/badge/patreon-donate-yellow.svg?style=for-the-badge\u0026logo=starship\u0026color=f5a97f\u0026logoColor=D9E0EE\u0026labelColor=302D41\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://twitter.com/intent/follow?screen_name=chrisatmachine\"\u003e\n      \u003cimg alt=\"follow on Twitter\" src=\"https://img.shields.io/twitter/follow/chrisatmachine?style=for-the-badge\u0026logo=twitter\u0026color=8aadf3\u0026logoColor=D9E0EE\u0026labelColor=302D41\" /\u003e\n    \u003c/a\u003e\n\n:zap: Zap is a minimal `zsh` plugin manager\n\n\u003c/div\u003e\n\n## Prerequisites\n\n- [ZSH](https://www.zsh.org/)\n- a nerd font (optional)\n\nTo get your nerd font check out [getNF](https://github.com/ronniedroid/getnf) project or visit [NerdFonts](https://www.nerdfonts.com/) site.\n\n## Install\n\n```zsh\nzsh \u003c(curl -s https://raw.githubusercontent.com/zap-zsh/zap/master/install.zsh) --branch release-v1\n```\n\n\u003e [!TIP]  \n\u003e If you wish to keep your current `.zshrc` file, you may add the `-k or --keep` argument when executing the install script.\n\n**Zap works on Linux, macOS, Windows (within WSL), Android (within Termux)**\n\n## Example usage\n\nAdd the following to your `.zshrc`\n\n```zsh\n# Example install of plugins\nplug \"zap-zsh/supercharge\"\nplug \"zsh-users/zsh-autosuggestions\"\n\n# Example install of a plugin pinned to specifc commit or branch, just pass the git reference\nplug \"zsh-users/zsh-syntax-highlighting\" \"122dc46\"\n\n# Example install of a theme\nplug \"zap-zsh/zap-prompt\"\n\n# Example install of a zsh completion\nplug \"esc/conda-zsh-completion\"\n```\n\nYou can also use `Zap` to install custom plugins or source custom files present on your local filesystem. A file descriptor which points to a directory is treated as a plugin, versus a regular file. For example:\n\n```zsh\n# Example install of a local plugin\nplug \"$HOME/plugins/my-custom-prompt\"\n\n# Example sourcing of local files\nplug \"$HOME/.config/zsh/aliases.zsh\"\nplug \"$HOME/.config/zsh/exports.zsh\"\n\n# Example install all local plugin in a folder (must be an absolute path anding with *)\nplug \"$HOME/plugins/*\"\n```\n\nBy default `Zap` when installing a plugin will clone a GitHub repository using a HTTPS web URL, if you require to be able to install from a private GitHub or from a different git server (for example GitLab) you can provide a different URL prefix to be used. For example:\n\n```zsh\n# Example globally setting the prefix for Zap to git clone using an SSH key\nexport ZAP_GIT_PREFIX=\"git@github.com:\"\nplug \"zap-zsh/private-repo\"\n\n# Example git clone using GitLab for a single plugin\nZAP_GIT_PREFIX=\"https://gitlab.com/\" plug \"user/repo\"\n```\n\nIt is possible to call `plug` in any interactive shell session to source a file or to download and source a plugin for that particular session.\n\n:warning: If you call `plug` outside your `.zshrc` file, the plugin you sourced will not be sourced at the next shell reload.\n\n## Commands\n\nZap provided commands for updating and cleaning up plugins\n\n- To update plugins or Zap:\n\n  ```zsh\n  zap update self # Update the Zap installation\n  zap update plugins # Update all your plugins but not Zap\n  zap update all # Update both the Zap installation and its plugins\n  ```\n\n- To list all plugins you are using:\n\n  ```zsh\n  zap list\n  ```\n\n- To remove plugins you are no longer using:\n\n  ```zsh\n  zap clean\n  ```\n\n## Uninstall\n\nTo uninstall Zap, when currently active, execute the following:\n\n```zsh\nrm -rf \"$ZAP_DIR\"\n```\n\nWhen not currently active, execute the following:\n\n```zsh\nrm -rf \"${XDG_DATA_HOME:-$HOME/.local/share}/zap\"\n```\n\n## Notes\n\nFor sourcing local files use `$HOME` instead of `~` when giving a full path to the file.\n\n---\n\n[![zap thumbnail](https://user-images.githubusercontent.com/29136904/238183118-943e3f25-5198-45a5-a22e-45a3a27db11d.png)](https://www.youtube.com/watch?v=LhDMw6n3GI4)\n\n\u003c!-----------------------------------------------------------------------------\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n## Socials\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/zap-zsh\"\u003e\u003cimg src=\"https://user-images.githubusercontent.com/696094/196835284-c52d4bd1-7034-439e-848b-47d4f2933dff.svg\" width=\"64\" height=\"64\" alt=\"Github Logo\"/\u003e\u003c/a\u003e \u003cimg src=\"assets/misc/transparent.png\" height=\"1\" width=\"5\"/\u003e \u003ca href=\"https://discord.gg/Xb9B4Ny\"\u003e\u003cimg src=\"https://user-images.githubusercontent.com/696094/196835282-f5c47d66-29b7-4210-9ee0-d9cdecde3559.svg\" width=\"64\" height=\"64\" alt=\"Discord Logo\"/\u003e\u003c/a\u003e \u003cimg src=\"assets/misc/transparent.png\" height=\"1\" width=\"5\"/\u003e \u003ca href=\"https://twitter.com/chrisatmachine\"\u003e\u003cimg src=\"https://user-images.githubusercontent.com/696094/196835281-52617611-ede6-40da-a4bc-8c5025622bbf.svg\" width=\"64\" height=\"64\" alt=\"Twitter Logo\"/\u003e\u003c/a\u003e \u003cimg src=\"assets/misc/transparent.png\" height=\"1\" width=\"5\"/\u003e \u003ca href=\"https://reddit.com/r/zapzsh\"\u003e\u003cimg src=\"https://user-images.githubusercontent.com/696094/196835278-041a4f99-28e1-4a93-8e35-c8912f1089fc.svg\" width=\"64\" height=\"64\" alt=\"Reddit Logo\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Thanks to all contributors\n\n\u003ca href=\"https://github.com/zap-zsh/zap/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=zap-zsh/zap\" /\u003e\n\u003c/a\u003e\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzap-zsh%2Fzap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzap-zsh%2Fzap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzap-zsh%2Fzap/lists"}