docs: sync README from source repo

This commit is contained in:
leokun
2026-08-28 12:36:30 +08:00
parent 1fcb78ad95
commit d015d1c33b
+5 -7
View File
@@ -1,9 +1,3 @@
![Connect cursor-byok to a wide range of model APIs](./images/en-brand-1.png)
![cursor-byok dashboard](./images/en-home-1.png)
<div align="center">
# cursor-byok
@@ -23,6 +17,10 @@ cursor-byok is a local implementation of Cursor's backend.
</div>
![Connect cursor-byok to a wide range of model APIs](./images/en-brand.png)
![cursor-byok dashboard](./images/en-home.png)
## About
cursor-byok is an open-source local model gateway for Cursor. It runs a service on your machine that connects Cursor to the model APIs you configure, routes model requests through your own providers, and preserves Cursor Agent capabilities such as tool calling, Skills, and MCP.
@@ -55,7 +53,7 @@ For complete installation steps, system configuration, and troubleshooting, see
Model configurations support both OpenAI and Anthropic API protocols. Each model channel can independently define its context window, maximum output tokens, reasoning effort, custom headers, and additional request parameters.
![cursor-byok model settings](./images/en-model-1.png)
![cursor-byok model settings](./images/en-model.png)
## How It Works