Allgemeine Einführung
Cursor API ist ein Open-Source-Projekt, das darauf abzielt, die KI-Funktionen des Cursor-Editors in einen Schnittstellendienst umzuwandeln, der mit der OpenAI API kompatibel ist. Durch dieses Projekt können Benutzer die KI-Fähigkeiten von Cursor in anderen Anwendungen wiederverwenden, wodurch eine größere Bandbreite von Anwendungsszenarien ermöglicht wird. Die Cursor-API unterstützt nicht nur die grundlegenden Dialogschnittstellen, sondern bietet auch ausführliche Schnittstellenbeschreibungen und Anwendungsleitfäden, um den Benutzern einen schnellen Einstieg zu ermöglichen. Ergänzendcursor-api.
Nur zu Lernzwecken hat Cursor2API mehr Probleme als es stabilisiert werden kann.
Funktionsliste
- Umwandlung der KI-Funktionen des Cursor-Editors in eine OpenAI-kompatible Schnittstelle
- Unterstützt mehrere Bereitstellungsmethoden: Docker, Docker Compose, PM2
- Detaillierte Schnittstellenbeschreibungen und Nutzungsrichtlinien bereitstellen
- Unterstützung für die Basis-Dialogschnittstelle
- Kompatibel mit einer breiten Palette von AI-Modellen
Hilfe verwenden
Ablauf der Installation
- Docker Compose-Bereitstellung (empfohlen)
- Führen Sie den folgenden Befehl im Terminal aus:
bash
docker compose up -d
- Führen Sie den folgenden Befehl im Terminal aus:
- Docker-Bereitstellung
- Führen Sie den folgenden Befehl im Terminal aus:
bash
docker run -d --name cursor-api -p 3000:3000 waitkafuka/cursor-api:latest
- Führen Sie den folgenden Befehl im Terminal aus:
- PM2-Einsatz
- Führen Sie den folgenden Befehl im Terminal aus:
bash
cd cursor-api
npm-Installation
pm2 start ökosystem.config.js
- Führen Sie den folgenden Befehl im Terminal aus:
Richtlinien für die Verwendung
- WorkosCursorSessionToken abrufen
- Besuchen Sie die Cursor-Website und füllen Sie das Anmeldeformular aus.
- Öffnen Sie die Entwicklertools in Ihrem Browser (F12), suchen Sie den Wert namens WorkosCursorSessionToken in Application-Cookies und speichern Sie ihn.
- Konfigurieren Sie die Schnittstelle
- Adresse der Schnittstelle:
http://localhost:3000/v1/chat/completions
- Anfragemethode: POST
- Authentifizierungsmethode: Bearer Token (unter Verwendung des Wertes von WorkosCursorSessionToken)
- Adresse der Schnittstelle:
- Format der Anfrage
{
"Modell": "gpt-3.5-turbo", "Modell": [
"messages": [
{
"role": "user", "content": "Hallo, wie kann ich die Cursor-API verwenden?
"content": "Hallo, wie kann ich die Cursor-API nutzen?"
}
]
}
- Antwortformat
{
"id": "chatcmpl-123",
"object": "chat.completion",
"choices": [
{
"index": 0, "nachricht": {
"message": {
"role": "assistant", "content": "Sie können Cursor API verwenden, indem Sie die Installations- und
"content": "Sie können die Cursor-API verwenden, indem Sie die in der Dokumentation enthaltenen Installations- und Nutzungsrichtlinien befolgen."
}, "finish_reason".
"finish_reason": "stop"
}
}, "finish_reason": "stop" }
"usage": {
"fertig_tokens": 12, "total_tokens": 21, "fertig_tokens": 20
"total_tokens": 21
}
}
caveat
- Bitte bewahren Sie Ihren WorkosCursorSessionToken sicher auf und geben Sie ihn nicht an Dritte weiter.
- Dieses Projekt ist nur für Studien- und Forschungszwecke gedacht. Bitte beachten Sie die Nutzungsbedingungen von Cursor.
Cursor-API Prüfsummen-Aktualisierungs-Tutorial
Dieses Dokument zeigt Ihnen, wie Sie den Prüfsummenwert für die Cursor-API aktualisieren können.
Update-Schritte
1. die Stilllegung der bestehenden Verpackungen
docker stop cursor-api
2. die Löschung der alten Verpackungen
docker rm cursor-api
3. den neuen Prüfsummenwert abrufen
Neue Prüfsumme (bald ablaufend)
4. den Container mit dem neuen Prüfsummenwert neu starten
docker run -d --name cursor-api -e x-cursor-checksum=Ersetzen durch den gewünschten Prüfsummenwert -p 3000:3000 zhx47/cursor-api:latest
Validierung des Einsatzes
Sobald die Aktualisierung abgeschlossen ist, können Sie den Status des Containers mit dem folgenden Befehl überprüfen:
docker ps | grep cursor-api
Befehl "Aktualisierten Prüfsummenwert anzeigen":
docker exec cursor-api env | grep x-cursor-checksum