はじめに
カーソル APIは、CursorエディタのAI機能をOpenAI APIと互換性のあるインターフェースサービスに変換することを目的としたオープンソースプロジェクトです。このプロジェクトを通じて、ユーザはCursorのAI機能を他のアプリケーションで再利用することができ、より幅広いアプリケーションシナリオを可能にします。本プロジェクトでは、Docker、Docker Compose、PM2など、様々なデプロイ方法を提供しており、ユーザが自身のニーズに応じて選択・利用するのに便利です。Cursor APIは、基本的な対話インターフェースをサポートするだけでなく、ユーザがすぐに使い始められるように、詳細なインターフェースの説明や利用ガイドも提供しています。補足カーソル.
学習目的に限って言えば、Cursor2APIは安定させる以上に多くの問題を抱えている。
機能一覧
- カーソルエディタのAI機能をOpenAI互換インターフェイスに変換する
- 複数のデプロイ方法をサポート:Docker、Docker Compose、PM2
- 詳細なインターフェイスの説明と使用ガイドラインの提供
- 基本対話インターフェースのサポート
- 幅広いAIモデルに対応
ヘルプの使用
設置プロセス
- Docker Composeデプロイメント(推奨)
- ターミナルで以下のコマンドを実行する:
バッシュ
docker compose up -d
- ターミナルで以下のコマンドを実行する:
- Dockerのデプロイメント
- ターミナルで以下のコマンドを実行する:
バッシュ
docker run -d --name cursor-api -p 3000:3000 waitkafuka/cursor-api:latest
- ターミナルで以下のコマンドを実行する:
- PM2の展開
- ターミナルで以下のコマンドを実行する:
バッシュ
cd cursor-api
npmインストール
pm2 start ecosystem.config.js
- ターミナルで以下のコマンドを実行する:
使用ガイドライン
- WorkosCursorSessionToken の取得
- カーソルのウェブサイトにアクセスし、登録ログインを完了します。
- ブラウザでデベロッパーツールを開き(F12)、Application-CookiesにあるWorkosCursorSessionTokenという値を見つけて保存します。
- インターフェースを設定する
- インターフェースアドレス:
http://localhost:3000/v1/chat/completions
- リクエスト・メソッド: POST
- 認証方法:ベアラートークン(WorkosCursorSessionTokenの値を使用)
- インターフェースアドレス:
- リクエスト形式
{
"model": "gpt-3.5-turbo", "model": [ ]モデル
「メッセージ": [
{
"role": "user", "content": "Hello, how can I use Cursor API?
「コンテンツ": "Hello, how can I use Cursor API?
}
]
}
- 応答フォーマット
{
"id": "chatcmpl-123"、
「選択肢": [
{
"インデックス": 0, "メッセージ": {
「メッセージ": {
"役割": "アシスタント", "内容": "CursorAPIを使用するには、以下のインストール方法と使用方法に従ってください。
"content": "ドキュメントで提供されているインストールと使用に関するガイドラインに従うことで、Cursor APIを使用できます。"
}, "finish_reason".
"finish_reason": "停止"
}
}, "finish_reason": "stop" }。
"usage": {
"completion_tokens": 12, "total_tokens": 21, "completion_tokens": 20
「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=replace with requested checksum value -p 3000:3000 zhx47/cursor-api:latest
配備の確認
更新が完了したら、以下のコマンドを使用してコンテナの状態を確認できる:
docker ps | grep cursor-api
更新されたチェックサム値を表示するコマンド:
docker exec cursor-api env | grep x-cursor-checksum