일반 소개
커서 API는 Cursor 에디터의 AI 기능을 OpenAI API와 호환되는 인터페이스 서비스로 전환하는 것을 목표로 하는 오픈 소스 프로젝트입니다. 이 프로젝트를 통해 사용자는 다른 애플리케이션에서 Cursor의 AI 기능을 재사용할 수 있으므로 더 다양한 애플리케이션 시나리오를 구현할 수 있습니다. 이 프로젝트는 Docker, Docker Compose, PM2 등 다양한 배포 방식을 제공하여 사용자가 필요에 따라 선택하여 사용하기 편리하며, Cursor API는 기본적인 대화 인터페이스를 지원할 뿐만 아니라 상세한 인터페이스 설명과 사용 가이드를 제공하여 사용자가 빠르게 시작할 수 있도록 돕습니다. 보충 자료커서-api.
학습 목적으로만 사용할 경우, Cursor2API는 안정화할 수 있는 것보다 더 많은 문제를 가지고 있습니다.
기능 목록
- 커서 편집기의 AI 기능을 OpenAI 호환 인터페이스로 변환하기
- 다양한 배포 방법 지원: Docker, Docker Compose, PM2
- 자세한 인터페이스 설명 및 사용 가이드라인 제공
- 기본 대화 인터페이스 지원
- 다양한 AI 모델과 호환
도움말 사용
설치 프로세스
- 도커 컴포즈 배포(권장)
- 터미널에서 다음 명령을 실행합니다:
bash
docker compose up -d
- 터미널에서 다음 명령을 실행합니다:
- 도커 배포
- 터미널에서 다음 명령을 실행합니다:
bash
docker run -d --name cursor-api -p 3000:3000 waitkafuka/cursor-api:latest
- 터미널에서 다음 명령을 실행합니다:
- PM2 배포
- 터미널에서 다음 명령을 실행합니다:
bash
cd cursor-api
npm install
pm2 start ecosystem.config.js
- 터미널에서 다음 명령을 실행합니다:
사용 가이드라인
- WorkosCursorSessionToken 가져오기
- 커서 웹사이트를 방문하여 등록 로그인을 완료합니다.
- 브라우저에서 개발자 도구(F12)를 열고 애플리케이션-쿠키에서 WorkosCursorSessionToken이라는 값을 찾아 저장합니다.
- 인터페이스 구성
- 인터페이스 주소:
http://localhost:3000/v1/chat/completions
- 요청 방법: POST
- 인증 방법: 베어러 토큰(WorkosCursorSessionToken 값 사용)
- 인터페이스 주소:
- 요청 형식
{
"model": "gpt-3.5-turbo",
"messages": [
{
"role": "user",
"content": "Hello, how can I use Cursor API?"
}
]
}
- 응답 형식
{
"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 체크섬 업데이트 튜토리얼
이 문서에서는 커서-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
© 저작권 정책
기사 저작권 AI 공유 서클 모두 무단 복제하지 마세요.
관련 문서
댓글 없음...