diff options
Diffstat (limited to 'plugins/git-auto-fetch/README.md')
| -rw-r--r-- | plugins/git-auto-fetch/README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/plugins/git-auto-fetch/README.md b/plugins/git-auto-fetch/README.md new file mode 100644 index 000000000..35f3c2f71 --- /dev/null +++ b/plugins/git-auto-fetch/README.md @@ -0,0 +1,31 @@ +# Git auto-fetch + +Automatically fetches all changes from all remotes while you are working in git-initialized directory. + +#### Usage + +Add `git-auto-fetch` to the plugins array in your zshrc file: + +```shell +plugins=(... git-auto-fetch) +``` + +Every time you launch a command in your shell all remotes will be fetched in background. +By default autofetch will be triggered only if last fetch was done at least 60 seconds ago. +You can change fetch interval in your .zshrc: +``` +GIT_AUTO_FETCH_INTERVAL=1200 #in seconds +``` +Log of `git fetch --all` will be saved into `.git/FETCH_LOG` + + +#### Toggle auto fetch per folder +If you are using mobile connection or for any other reason you can disable git-auto-fetch for any folder: + +```shell +$ cd to/your/project +$ git-auto-fetch +disabled +$ git-auto-fetch +enabled +``` |