Was macht DocSync?
Ein Befehlszeilenwerkzeug und KI-Agenten-Skill zur automatischen Synchronisierung und Konsolidierung von Repository-Dokumentationsdateien wie README.md, AGENTS.md und CLAUDE.md.
Funktionen
- Automatische Generierung: Erstellt oder aktualisiert die genannten Dateien mit einem einzigen Befehl.
- Konfigurierbar: Über eine
docsync.jsonkönnen Quelldateien, Ausgabepfade und Vorlagen definiert werden. - Änderungsverfolgung: Erkennt automatisch Änderungen im Repository und schlägt Aktualisierungen vor.
- Plattformübergreifend: Funktioniert mit Claude Code, Cursor, Codex und anderen KI-Agenten.
Installation
# Über npm (falls als Paket veröffentlicht)
npm install -g @hunterzheng1/docsync
# Oder als Git-Submodul in Ihrem Projekt
git submodule add https://github.com/hunterzheng1/DocSync.git
Verwendung
Initialisieren Sie die Konfigurationsdatei:
docsync init
Dies erstellt eine docsync.json im Stammverzeichnis Ihres Projekts. Passen Sie die Datei an Ihre Bedürfnisse an:
{
"source": ["src/", "doc/"],
"output": ["README.md", "AGENTS.md", "CLAUDE.md"],
"template": "default",
"watch": true
}
Führen Sie dann die Synchronisierung durch:
docsync sync
Um kontinuierlich auf Änderungen zu überwachen:
docsync watch
Integration mit KI-Agenten
Fügen Sie Ihrem AGENTS.md oder der Konfiguration Ihres KI-Agenten folgende Anweisungen hinzu:
## DocSync Skill
- Verwenden Sie `docsync sync`, um die Repository-Dokumentation zu aktualisieren.
- Führen Sie `docsync watch` aus, bevor Sie mit der Arbeit beginnen, um sicherzustellen, dass die Dokumentation aktuell ist.
- Bei Konflikten priorisieren Sie die lokalen Änderungen, es sei denn, die Konfiguration gibt etwas anderes vor.
Konfigurationsoptionen
| Option | Typ | Standard | Beschreibung |
|---|---|---|---|
source | array | ["."] | Zu durchsuchende Verzeichnisse für Quelldateien |
output | array | [] | Ausgabedateien, die generiert/aktualisiert werden |
template | string | default | Vorlagenname (siehe templates/-Verzeichnis) |
watch | bool | false | Kontinuierliche Überwachung auf Änderungen |
Vorlagen
Standardvorlage:
# {{project-name}}
{{project-description}}
## Dokumentation
{{generated-content}}
Eigene Vorlagen können im templates/-Verzeichnis abgelegt oder über die Konfiguration referenziert werden.
Entwicklung
- Klonen Sie das Repository:
git clone https://github.com/hunterzheng1/DocSync.git - Installieren Sie Abhängigkeiten:
npm install - Führen Sie Tests aus:
npm test
Lizenz
MIT