Cursor2API: CursorエディタのAI機能をOpenAI互換インターフェースサービスに変換する

はじめに

カーソル APIは、CursorエディタのAI機能をOpenAI APIと互換性のあるインターフェースサービスに変換することを目的としたオープンソースプロジェクトです。このプロジェクトを通じて、ユーザはCursorのAI機能を他のアプリケーションで再利用することができ、より幅広いアプリケーションシナリオを可能にします。本プロジェクトでは、Docker、Docker Compose、PM2など、様々なデプロイ方法を提供しており、ユーザが自身のニーズに応じて選択・利用するのに便利です。Cursor APIは、基本的な対話インターフェースをサポートするだけでなく、ユーザがすぐに使い始められるように、詳細なインターフェースの説明や利用ガイドも提供しています。補足カーソル.

学習目的に限って言えば、Cursor2APIは安定させる以上に多くの問題を抱えている。

機能一覧

• カーソルエディタのAI機能をOpenAI互換インターフェイスに変換する
• 複数のデプロイ方法をサポート：Docker、Docker Compose、PM2
• 詳細なインターフェイスの説明と使用ガイドラインの提供
• 基本対話インターフェースのサポート
• 幅広いAIモデルに対応

ヘルプの使用

設置プロセス

1. Docker Composeデプロイメント（推奨）
   • ターミナルで以下のコマンドを実行する： bash
docker compose up -d

2. Dockerのデプロイメント
   • ターミナルで以下のコマンドを実行する： bash
docker run -d --name cursor-api -p 3000:3000 waitkafuka/cursor-api:latest

3. PM2の展開
   • ターミナルで以下のコマンドを実行する： bash
cd cursor-api
npm install
pm2 start ecosystem.config.js


使用ガイドライン

1. WorkosCursorSessionToken の取得
   • カーソルのウェブサイトにアクセスし、登録ログインを完了します。
   • ブラウザでデベロッパーツールを開き（F12）、Application-CookiesにあるWorkosCursorSessionTokenという値を見つけて保存します。
2. インターフェースを設定する
   • インターフェースアドレス：http://localhost:3000/v1/chat/completions
   • リクエスト・メソッド: POST
   • 認証方法：ベアラートークン（WorkosCursorSessionTokenの値を使用）
3. リクエスト形式

   {
"model": "gpt-3.5-turbo",
"messages": [
{
"role": "user",
"content": "Hello, how can I use Cursor API?"
}
]
}

4. 応答フォーマット

   {
"id": "chatcmpl-123",
"object": "chat.completion",
"created": 1677652280,
"model": "gpt-3.5-turbo",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "You can use Cursor API by following the installation and usage guidelines provided in the documentation."
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 9,
"completion_tokens": 12,
"total_tokens": 21
}
}

ほら

• WorkosCursorSessionToken を安全に保管し、他人に公開しないでください。
• このプロジェクトは研究・調査用ですので、Cursorの利用規約に従ってください。

カーソルAPIチェックサム更新チュートリアル

このドキュメントでは、Cursor-API のチェックサム値を更新する方法について説明します。

更新ステップ

1.既存パッケージの廃止

docker stop cursor-api

2.古いパッケージの削除

docker rm cursor-api

3.新しいチェックサム値を取得する

新しいチェックサム（もうすぐ期限切れ）

4. 新しいチェックサム値でコンテナを再起動する。

docker run -d --name cursor-api -e x-cursor-checksum=替换为请求的checksum值 -p 3000:3000 zhx47/cursor-api:latest

配備の確認

更新が完了したら、以下のコマンドを使用してコンテナの状態を確認できる：

docker ps | grep cursor-api

更新されたチェックサム値を表示するコマンド：

docker exec cursor-api env | grep x-cursor-checksum