Skip to content

ptavares/zsh-auto-update-plugins

Repository files navigation

GitHub GitHub Release

zsh-auto-update-plugins

oh-my-zsh plugin to update all oh-my-zsh plugin's git-repositories, and my personal zsh plugins stored in $ZSH_CUSTOM folder.

Table of content

This documentation section is generated automatically

Install

Once the plugin installed, auto-update-plugins will be available

Clone zsh-auto-update-plugins into your custom plugins repo and load as a plugin in your .zshrc

git clone https://github.com/ptavares/zsh-auto-update-plugins.git ~/.oh-my-zsh/custom/plugins/zsh-auto-update-plugins
plugins+=(zsh-auto-update-plugins)

Keep in mind that plugins need to be added before oh-my-zsh.sh is sourced.

Usage

Setup custom days

By default, the plugin will check for updates every 15 days. If you want to change this value, add this line in your ${HOME}/.zshrc .

# Example to check every 10 days
export UPDATE_ZSH_DAYS=10

Disable auto-update functions

By default, the plugin will call all my plugins custom update functions. This feature can be disabled exporting some variables in your ${HOME}/.zshrc.

ALL

  • Disable all auto-update
export ZSH_AUTOUPDATE_IGNORE_ALL=true

Custom

  • Disable direnv auto-update from zsh-direnv plugin
export ZSH_AUTOUPDATE_IGNORE_DIRENV=true
export ZSH_AUTOUPDATE_IGNORE_KUBECTX=true
  • Disable sdkman auto-update from zsh-sdkman plugin
export ZSH_AUTOUPDATE_IGNORE_SDKMAN=true
  • Disable tfenv auto-update from zsh-tfenv plugin
export ZSH_AUTOUPDATE_IGNORE_TFENV=true
  • Disable tgenv auto-update from zsh-tgenv plugin
export ZSH_AUTOUPDATE_IGNORE_TGENV=true
  • Disable pkenv auto-update from zsh-pkenv plugin
export ZSH_AUTOUPDATE_IGNORE_PKENV=true
  • Disable exa auto-update from zsh-exa plugin
export ZSH_AUTOUPDATE_IGNORE_EXA=true
  • Disable z auto-update from zsh-z plugin
export ZSH_AUTOUPDATE_IGNORE_Z=true
export ZSH_AUTOUPDATE_IGNORE_TFSWITCH=true
export ZSH_AUTOUPDATE_IGNORE_TGSWITCH=true
export ZSH_AUTOUPDATE_IGNORE_TF_TOOLS=true

Silent Mode

To turn off auto-update-plugins message, add this variable in your ${HOME}/.zshrc

export ZSH_AUTOUPDATE_PLUGINS_SILENT=true

Force update

The plugin comes with a zsh function to force update manually (not wait for automatic) :

upgrade_oh_my_zsh_custom

And another function to call upgrade_oh_my_zsh before updating custom plugins :

upgrade_all_oh_my_zsh

License

MIT

About

zsh plugin to update oh-my-zsh and my personal zsh plugins

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published