Cornelicorn/oh-my-zsh
1
0
Fork 0
mirror of https://github.com/robbyrussell/oh-my-zsh.git synced 2026-09-29 06:26:06 +02:00
Code Issues Releases Wiki Activity

feat: document cooldown updater option (#135) 

Co-authored-by: carlosala <66907184+carlosala@users.noreply.github.com>
Copilot
2026-09-14 21:38:50 +02:00
committed by GitHub
co-authored by carlosala
parent 167496fee3
commit dc7e2324e6
2 changed files with 20 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
FAQ.md
+4 -1
@@ -148,6 +148,8 @@ If you want to manually update Oh My Zsh, you have 2 options:
omz update omz update
``` ```
This command honors the `':omz:update' cooldown` setting documented in [[Settings]].
- If you want to update Oh My Zsh as part of an automated script, its better to use the `upgrade.sh` script directly. You can call it with any of these alternatives: - If you want to update Oh My Zsh as part of an automated script, its better to use the `upgrade.sh` script directly. You can call it with any of these alternatives:
```sh ```sh
@@ -157,10 +159,11 @@ If you want to manually update Oh My Zsh, you have 2 options:
/path/to/ohmyzsh/tools/upgrade.sh /path/to/ohmyzsh/tools/upgrade.sh
``` ```
This script also allows you to pass in 2 separate flags to control its behavior: This script also allows you to pass in 3 separate flags to control its behavior:
- `-i`: tells the script to upgrade interactively. In this mode, the only change is that the changelog will be displayed after the update. - `-i`: tells the script to upgrade interactively. In this mode, the only change is that the changelog will be displayed after the update.
- `-v default|minimal|silent`: control the verbosity of the script. This is equivalent to the [verbosity](https://github.com/ohmyzsh/ohmyzsh/wiki/Settings#omzupdate-verbosity) settings. - `-v default|minimal|silent`: control the verbosity of the script. This is equivalent to the [verbosity](https://github.com/ohmyzsh/ohmyzsh/wiki/Settings#omzupdate-verbosity) settings.
- `-c <days>`: only apply updates that are at least _N_ days old. This is equivalent to the [`cooldown`](https://github.com/ohmyzsh/ohmyzsh/wiki/Settings#omzupdate-cooldown) setting.
> [!IMPORTANT] > [!IMPORTANT]
> To upgrade Oh My Zsh, you need to have `git` installed and it needs to be installed as a git repository. > To upgrade Oh My Zsh, you need to have `git` installed and it needs to be installed as a git repository.
Settings.md
+16
@@ -19,6 +19,7 @@
- [Update settings](#update-settings) - [Update settings](#update-settings)
- [`':omz:update' mode`](#omzupdate-mode) - [`':omz:update' mode`](#omzupdate-mode)
- [`':omz:update' frequency`](#omzupdate-frequency) - [`':omz:update' frequency`](#omzupdate-frequency)
- [`':omz:update' cooldown`](#omzupdate-cooldown)
- [`':omz:update' verbose`](#omzupdate-verbose) - [`':omz:update' verbose`](#omzupdate-verbose)
- [Deprecated settings](#deprecated-settings) - [Deprecated settings](#deprecated-settings)
- [Completion settings](#completion-settings) - [Completion settings](#completion-settings)
@@ -139,6 +140,21 @@ setting only takes effect when automatic updates are enabled. **The default are
zstyle ':omz:update' frequency 7 zstyle ':omz:update' frequency 7
``` ```
### `':omz:update' cooldown`
By default, updates always pull the latest changes. This setting tells Oh My Zsh to only apply updates whose commits are at least _N_ days old. It affects both the auto-updater and `omz update`. **The default is 0 days**, which keeps the current behavior.
```zsh
# Only apply updates that are at least 10 days old
zstyle ':omz:update' cooldown 10
```
If you call `upgrade.sh` directly from a script, pass the same value with `-c` because the script does not read your `.zshrc`:
```sh
"$ZSH/tools/upgrade.sh" -c 10
```
### `':omz:update' verbose` ### `':omz:update' verbose`
This setting controls the amount of information displayed after an update finishes. These are the available verbosity levels: This setting controls the amount of information displayed after an update finishes. These are the available verbosity levels: