summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-02-07 22:07:27 +0200
committerPaul Buetow <paul@buetow.org>2026-02-07 22:07:27 +0200
commitebc50a6600fcf4ebc53df4846f790bb05757b3df (patch)
tree64e66a0cbed140a75aa580fe9ba02d510b68601c /README.md
parent545e65fe16c761822f0999b8f4ab05f1cd325975 (diff)
feat(sync): add throttled sync modev0.12.0
Introduce an opt-in throttle that skips inactive repos based on local activity and per-repo cooldowns, and bump the version to 0.12.0. Co-authored-by: Cursor <cursoragent@cursor.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 38c9e85..13175d1 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,7 @@ It has been vibe coded mainly using AI tools (Claude Code CLI and amp).
- Never deletes branches (only adds/updates)
- GitHub token validation tool
- Opt-in backup mode with --backup flag for resilient offline backups
+- Opt-in sync throttling with --throttle based on local activity
- AI-powered project showcase generation for documentation
- Weekly batch run mode with --batch-run for automated synchronization
@@ -104,6 +105,18 @@ gitsyncer sync repo myproject --no-ai-release-notes
gitsyncer sync repo myproject --auto-create-releases
```
+#### Throttled sync
+```bash
+# Throttle syncing based on local activity in ~/git/<repo>
+gitsyncer sync repo myproject --throttle
+
+# Throttle all public repo sync modes
+gitsyncer sync bidirectional --throttle
+gitsyncer sync codeberg-to-github --throttle
+gitsyncer sync github-to-codeberg --throttle
+```
+When `--throttle` is enabled, GitSyncer checks `~/git/<repo>` for commits in the last 7 days. If no recent commits are found (or the repo is missing locally), the repo sync is allowed only once per random interval between 60 and 120 days and the next allowed date is stored. Throttle state is stored in `.gitsyncer-state.json` in the work directory.
+
#### Sync all configured repositories
```bash
gitsyncer sync all