Cipher ist ein quelloffenes Speicherschichtwerkzeug, das für Codierassistenten entwickelt wurde. Es tut dies mit Hilfe der Modell-Kontext-Protokoll (MCP) Das Protokoll lässt sich nahtlos in eine breite Palette von Programmierwerkzeugen und KI-Assistenten integrieren, wie z. B. Claude Code, Cursor und Windsurf: Die Hauptfunktion von Cipher ist die Speicherung und Verwaltung von Kontextinformationen während des Codierungsprozesses, um Entwicklern zu helfen, die Kontinuität in komplexen Projekten zu wahren. Es unterstützt mehrere Umgebungskonfigurationen und ist für einzelne Entwickler oder Teams geeignet. Das Projekt ist Open Source auf GitHub, so dass die Community Code und Funktionsverbesserungen beitragen kann. Benutzer können es schnell über einfache Befehlszeilenoperationen oder den API-Modus einsetzen und verwenden.
Funktionsliste
- Bietet eine persistente Speicherschicht zur Speicherung von Kontextinformationen über Programmierinteraktionen.
- Unterstützt das MCP-Protokoll und ist kompatibel mit Tools wie Claude Code, Cursor, Windsurf und anderen.
- Bietet eine Befehlszeilenschnittstelle (CLI), die den interaktiven Modus und einzelne Befehlsoperationen unterstützt.
- Unterstützt API- und MCP-Server-Modi, um unterschiedliche Entwicklungsanforderungen zu erfüllen.
- Flexible Konfiguration über Umgebungsvariablen und YAML-Dateien.
- Unterstützt API-Schlüssel für eine breite Palette von KI-Modellen, wie OpenAI, Anthropic und OpenRouter.
- Bietet Docker-Bereitstellungsoptionen zur Vereinfachung des Installations- und Laufzeitprozesses.
- Erlauben Sie Beiträge der Gemeinschaft und unterstützen Sie die gemeinschaftliche Entwicklung von Open Source.
Hilfe verwenden
Einbauverfahren
Cipher hat einen einfachen Installationsprozess, unterstützt die globale oder lokale Installation und bietet Docker-Bereitstellungsoptionen. Im Folgenden finden Sie die detaillierten Schritte:
Installation über npm
- globale Installation: Führen Sie den folgenden Befehl in einem Terminal aus, um die Befehlszeilentools für Cipher zu installieren:
npm install -g @byterover/cipher
Dadurch wird Cipher für Entwickler, die es häufig verwenden müssen, global installiert.
- lokale InstallationWenn es nur in einem bestimmten Projekt verwendet wird, wechseln Sie in das Projektverzeichnis und führen Sie es aus:
npm install @byterover/cipher
Klonen und Konfiguration über Git
- Klon-LagerKlonen Sie das Cipher-Projekt lokal von GitHub:
git clone https://github.com/campfirein/cipher.git cd cipher
- Kopieren von KonfigurationsdateienKopieren Sie die Beispiel-Umgebungskonfigurationsdatei und bearbeiten Sie sie:
cp .env.example .env
Öffnen mit einem Texteditor
.env
fügen Sie die erforderlichen API-Schlüssel hinzu, zum Beispiel:OPENAI_API_KEY=your_openai_api_key ANTHROPIC_API_KEY=your_anthropic_api_key OPENROUTER_API_KEY=your_openrouter_api_key
Wenn Sie die lokale Ollama Modell, das konfiguriert werden kann:
OLLAMA_BASE_URL=http://localhost:11434/v1
- Installation von Abhängigkeiten: Im Projektverzeichnis ausführen:
npm install
Bereitstellung über Docker
- Stellen Sie sicher, dass Docker und Docker Compose installiert sind.
- Führen Sie es im Projektverzeichnis aus:
docker-compose up -d
Dadurch wird der Cipher-Dienst gestartet.
- Prüft, ob der Dienst ordnungsgemäß funktioniert:
curl http://localhost:3000/health
Wenn der Rückgabestatus normal ist, wird der Dienst gestartet.
Verwendung
Cipher bietet mehrere Betriebsmodi, darunter den interaktiven Modus, den Einzelbefehlsmodus, den API-Servermodus und den MCP-Servermodus. Im Folgenden werden die spezifischen Betriebsmethoden beschrieben:
interaktiver Modus
- Geben Sie ihn in das Terminal ein:
cipher
Dies führt zu einer interaktiven Befehlszeilenschnittstelle, in die der Entwickler Befehle oder Fragen eingeben kann, und Cipher speichert den Kontext und gibt eine Antwort.
- Beispiel: Geben Sie "Dokumentieren Sie häufige Ursachen von CORS-Fehlern in der lokalen Entwicklung von Vite + Express" ein, und Cipher speichert die Informationen für spätere Abfragen im Speicher.
Einzelbefehl
- Führen Sie einen einzigen Befehl aus, um bestimmte Informationen zu speichern:
cipher "Add this to memory as common causes of 'CORS error' in local dev with Vite + Express."
Dadurch wird der angegebene Inhalt direkt in der Speicherebene gespeichert.
API-Server-Modus
- Starten Sie den API-Server:
cipher --mode api
- Verwenden Sie HTTP-Anfragen zur Interaktion mit dem Cipher, z. B. über die
curl
oder andere Tools, um API-Endpunkte aufzurufen.
MCP-Server-Modell
- Starten Sie den MCP-Server, um kompatible Tools zu unterstützen:
cipher --mode mcp
- konfigurieren. Claude Code vielleicht Cursor usw., um eine Verbindung mit der MCP-Serveradresse von Cipher herzustellen (Standard)
http://localhost:3000
).
Hauptfunktionen
Speichern und Abrufen von Kontext
Das Herzstück von Cipher ist sein duales Speichersystem, das Programmierkonzepte und Argumentationsmuster speichern kann. Wenn Sie zum Beispiel Claude Code verwenden, wird der Inhalt jeder Entwicklerinteraktion automatisch in der Cipher-Speicherschicht gespeichert. Bei Bedarf führen Sie den folgenden Befehl aus, um ihn abzurufen:
cipher "Retrieve context about CORS error causes"
Cipher liefert den relevanten Kontext, damit die Entwickler schnell wieder an die Arbeit gehen können.
Umgebungsvariablen konfigurieren
Der Entwickler kann die .env
File Adjustment Log Level oder andere Einstellungen, zum Beispiel:
CIPHER_LOG_LEVEL=info
NODE_ENV=production
Dadurch wird sichergestellt, dass Cipher in Produktionsumgebungen stabil ist.
Integration von Drittanbieter-Tools
Cipher lässt sich über das MCP-Protokoll mit Tools wie Claude Code, Cursor usw. integrieren. Sobald sie konfiguriert sind, senden die Tools automatisch Interaktionsdaten zur Speicherung an Cipher. Wenn Sie z. B. den MCP-Client in Claude Code aktivieren und die Serveradresse auf die MCP-Adresse von Cipher einstellen, können die Daten in Echtzeit synchronisiert werden.
caveat
- Stellen Sie sicher, dass Sie mindestens einen API-Schlüssel konfigurieren (
OPENAI_API_KEY
(muss zum Einbetten angegeben werden). - Die Docker-Bereitstellung erfordert eine stabile Netzwerkumgebung, um reibungslose Image-Downloads zu gewährleisten.
- Mitwirkende aus der Gemeinschaft können sich auf die GitHub
Contributing Guide
Code einreichen.
Anwendungsszenario
- Projektmanagement für einzelne Entwickler
Bei der Arbeit an komplexen Projekten müssen Entwickler oft Codeschnipsel oder Debugging-Informationen aufzeichnen. Cipher bietet eine persistente Speicherebene, die den Kontext des Debugging-Prozesses speichert und jederzeit leicht abrufbar ist. - Entwicklung der Teamarbeit
Entwicklungsteams können den Projektkontext mithilfe des MCP-Servermodells von Cipher gemeinsam nutzen. Teammitglieder greifen über Claude Code oder Cursor auf den Unified Memory Layer zu, um die Zusammenarbeit effizienter zu gestalten. - Lernen und Lehren
Programmieranfänger oder Ausbilder können Cipher verwenden, um Probleme und Lösungen während des Codelernens aufzuzeichnen. Zeichnen Sie z. B. die Ursachen und Lösungen von CORS-Fehlern zur einfachen Überprüfung auf. - AI-Assistent-Erweiterung
Cipher bietet Speicherunterstützung für KI-Codierassistenten und verbessert so deren Fähigkeit, lange Kontexte zu verarbeiten. Benutzer von Claude Code können Cipher zum Beispiel verwenden, um den Kontext mehrerer Dialogrunden zu speichern und so sicherzustellen, dass der KI-Assistent genauere Ratschläge gibt.
QA
- Welche Programmierwerkzeuge unterstützt Cipher?
Cipher unterstützt das MCP-Protokoll mit Claude Code, Cursor, Windsurf, Gemini CLI, AWS Kiro, VS Code und Roo-Code und andere Tool-Integrationen. - Benötige ich einen API-Schlüssel?
Ja, mindestens ein OpenAI-API-Schlüssel ist für die Einbettung von Funktionen erforderlich. Andere API-Schlüssel (wie z.B. Anthropisch oder OpenRouter) ist optional. - Wie kann ich den Cipher-Dienst debuggen?
in Bewegung seincurl http://localhost:3000/health
Überprüfen Sie den Status des Dienstes, oder im.env
Einstellung in der DateiCIPHER_LOG_LEVEL=debug
Detaillierte Protokolle anzeigen. - Was ist der Unterschied zwischen der Docker-Bereitstellung und der direkten Installation?
Docker-Bereitstellungen eignen sich gut für Schnellstart- und isolierte Umgebungen, und Direktinstallationen sind gut für Entwickler, die eine tiefgreifende Anpassung benötigen.