mirror of
https://wget.la/https://github.com/leookun/cursor-byok
synced 2026-10-05 20:44:07 +08:00
leokun
e874d68b79
- Enhanced instructions for restarting Cursor after upgrades or initial model configuration to ensure proper functionality. - Updated references from "Troubleshooting" to "Frequently Asked Questions" for better alignment with user needs. - Improved clarity in the installation and usage steps across multiple language versions.
98 lines
3.9 KiB
Plaintext
98 lines
3.9 KiB
Plaintext
---
|
|
title: Quick Start
|
|
description: Install Cursor Byok and let Cursor use your own model APIs.
|
|
icon: Rocket
|
|
---
|
|
|
|
Cursor Byok is a Cursor model gateway that runs on your machine. It receives Cursor Agent requests, converts them, and forwards them to the OpenAI- or Anthropic-compatible service you configure.
|
|
|
|
<Callout type="warn" title="Before you start">
|
|
Cursor Byok is an independent open-source project and is not affiliated with Cursor or its developers. The software itself is free, but model providers may charge for usage.
|
|
</Callout>
|
|
|
|
<Callout type="warn" title="Restart Cursor and start a new conversation after an upgrade or first setup">
|
|
After upgrading Cursor or configuring a model for the first time, quit Cursor completely and restart it once, then start a new conversation before selecting the model. Existing conversations do not load the new connection settings and may show “not signed in,” omit the model, or show `An unexpected error occurred`.
|
|
</Callout>
|
|
|
|
## Install and configure
|
|
|
|
<Steps>
|
|
|
|
<Step>
|
|
|
|
### Update Cursor
|
|
|
|
Download the latest official Cursor from [cursor.com](https://cursor.com) and install it over your existing copy, so the client stays up to date.
|
|
|
|
</Step>
|
|
|
|
<Step>
|
|
|
|
### Download and launch Cursor Byok
|
|
|
|
Download the latest release for your operating system from [GitHub Releases](https://github.com/leookun/cursor-byok/releases/latest), then launch cursor-byok.
|
|
|
|
</Step>
|
|
|
|
<Step>
|
|
|
|
### Initialize and configure a model
|
|
|
|
Open **Cursor Configuration**, follow the prompts to initialize the local CA, then add a model. Fill in the server address, API key, and model name, and run the connectivity test until it passes.
|
|
|
|
|
|
|
|
See [Model Configuration](./model-configuration.mdx) for how to choose the type and protocol for different models.
|
|
|
|
</Step>
|
|
|
|
<Step>
|
|
|
|
### Restart Cursor after an upgrade or first setup
|
|
|
|
After upgrading Cursor or configuring a model for the first time, **quit Cursor completely and restart it once**. Closing only the window or continuing in the current conversation does not load the new connection settings.
|
|
|
|
</Step>
|
|
|
|
<Step>
|
|
|
|
### Start a new conversation and select the model
|
|
|
|
Once Cursor has restarted, start a new conversation and select the model you just configured from the model list (do not select Auto). Do not continue a conversation that was already open before setup.
|
|
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
## Coexists with your official account
|
|
|
|
The current design goal is coexistence with the official service — there is no more "stop the service" or account juggling:
|
|
|
|
- Sign in to Cursor with your own account. If you previously used a fake account generated by an old version, sign out of it first, then sign in with your own.
|
|
- If your account has official quota, there is no boundary between official models and your local models — switch and mix freely.
|
|
- **Auto always routes to official models**: picking Auto without quota results in an error, so select your configured model instead.
|
|
- Cursor features such as plugins and codebase indexing keep working as usual.
|
|
|
|
## Next steps
|
|
|
|
<Cards>
|
|
<Card title="Installation" description="Download, initialize, and run for the first time." href="/docs/installation" />
|
|
<Card title="Model Configuration" description="Choose a protocol and fill in upstream model parameters." href="/docs/model-configuration" />
|
|
<Card title="TAB Service" description="Choose how Cursor connects to Tab completion endpoints." href="/docs/tab-service" />
|
|
<Card title="Frequently Asked Questions" description="Answer common certificate, connection, and model configuration questions." href="/docs/faq" />
|
|
</Cards>
|
|
|
|
## How data flows
|
|
|
|
```text
|
|
Cursor client
|
|
│ Agent requests and tool results
|
|
▼
|
|
Cursor Byok local service
|
|
│ OpenAI- / Anthropic-compatible requests
|
|
▼
|
|
Your model API
|
|
```
|
|
|
|
API keys, model configurations, and app settings are stored on your machine. Model requests are still sent to the upstream provider you choose.
|