mirror of
https://wget.la/https://github.com/leookun/cursor-byok
synced 2026-10-03 18:23:51 +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.
87 lines
2.6 KiB
Plaintext
87 lines
2.6 KiB
Plaintext
---
|
|
title: Installation
|
|
description: Download Cursor Byok, complete local initialization, and verify it is running.
|
|
icon: Download
|
|
---
|
|
|
|
## Download the app
|
|
|
|
Go to the [latest release page](https://github.com/leookun/cursor-byok/releases/latest) and download the installer for macOS, Windows, or Linux.
|
|
|
|
<Callout type="info">
|
|
Prefer the latest stable release. The release page lists the installers and release notes for each version.
|
|
</Callout>
|
|
|
|
## First launch
|
|
|
|
<Steps>
|
|
|
|
<Step>
|
|
|
|
### Open Cursor Settings
|
|
|
|
After launching the app, go to **Cursor Settings**. If the local CA has not been initialized, the page shows an initialization entry.
|
|
|
|
</Step>
|
|
|
|
<Step>
|
|
|
|
### Initialize the local CA
|
|
|
|
Click **Initialize CA**. The local CA is used to inspect HTTPS requests from Cursor on your device; its files never leave your machine.
|
|
|
|
When the system asks for authorization, follow the instructions shown in the app to complete the trust step in your terminal, then return to the app and click **I have initialized, refresh**.
|
|
|
|
</Step>
|
|
|
|
<Step>
|
|
|
|
### Add your first model
|
|
|
|
Click **Add Model**, choose the OpenAI or Anthropic type, fill in the upstream service parameters, and save. See [Model Configuration](./model-configuration.mdx) for details on each field.
|
|
|
|
</Step>
|
|
|
|
<Step>
|
|
|
|
### Run the connectivity test
|
|
|
|
Click **Test** on the model. Once the test passes, the model appears in Cursor's model list.
|
|
|
|
</Step>
|
|
|
|
<Step>
|
|
|
|
### Completely 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 is not enough; make sure the Cursor process has stopped before opening it again.
|
|
|
|
</Step>
|
|
|
|
<Step>
|
|
|
|
### Start a new conversation
|
|
|
|
After Cursor restarts, start a new conversation and select your configured model from the model list. Do not continue a conversation opened before setup, and do not select **Auto**.
|
|
|
|
</Step>
|
|
|
|
</Steps>
|
|
|
|
## Verify the installation
|
|
|
|
After configuration, confirm that:
|
|
|
|
- The Cursor Settings page no longer shows the CA initialization prompt.
|
|
- At least one model passes the connectivity test.
|
|
- Cursor Byok stays running.
|
|
- Cursor has been quit completely and restarted once.
|
|
- You started a new conversation instead of continuing one opened before setup.
|
|
- The configured display name shows up in Cursor's model list.
|
|
|
|
If any of these steps fail, head to [Frequently Asked Questions](./faq.mdx).
|
|
|
|
## Updates
|
|
|
|
Check for new versions in the app settings, or visit [GitHub Releases](https://github.com/leookun/cursor-byok/releases/latest) directly. You do not need to delete existing model configurations before updating.
|