@cursorx/cli 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,133 @@
1
+ CursorX End-User License Agreement (EULA)
2
+
3
+ Version 1.0 — effective 2026-06-06
4
+
5
+ Copyright (c) 2026 CursorX. All rights reserved.
6
+
7
+ This End-User License Agreement (the "Agreement") is a legal agreement
8
+ between you ("You" or "Licensee") and CursorX (the "Licensor") governing
9
+ your use of the CursorX software, including its CLI, VS Code / Cursor
10
+ extension, local router, and any associated patch components and
11
+ documentation (collectively, the "Software").
12
+
13
+ By installing, copying, downloading, accessing, or otherwise using the
14
+ Software, You agree to be bound by the terms of this Agreement. If You do
15
+ not agree to these terms, do not install or use the Software.
16
+
17
+
18
+ 1. LICENSE GRANT
19
+
20
+ Subject to Your compliance with this Agreement, the Licensor grants You
21
+ a personal, non-exclusive, non-transferable, non-sublicensable, revocable
22
+ license to install and use the Software on devices You own or control,
23
+ solely for Your own internal use in the manner intended by the Licensor.
24
+
25
+ No rights are granted to You other than those expressly set forth in
26
+ this Agreement.
27
+
28
+
29
+ 2. RESTRICTIONS
30
+
31
+ You shall not, and shall not permit, encourage, or assist any third
32
+ party to:
33
+
34
+ (a) reverse engineer, decompile, disassemble, deobfuscate, or otherwise
35
+ attempt to derive the source code, underlying ideas, algorithms,
36
+ file formats, protocols, or non-public APIs of the Software, except
37
+ to the extent such activity is expressly permitted by applicable
38
+ law notwithstanding this limitation;
39
+
40
+ (b) redistribute, sublicense, rent, lease, lend, sell, resell, host as
41
+ a service, mirror, or otherwise transfer the Software (or any
42
+ portion thereof) to any third party;
43
+
44
+ (c) repackage, modify, translate, adapt, or create derivative works of
45
+ the Software, except as expressly permitted by the Licensor in
46
+ writing;
47
+
48
+ (d) remove, alter, obscure, or fail to reproduce any copyright,
49
+ trademark, license, attribution, or other proprietary notice
50
+ contained in or on the Software;
51
+
52
+ (e) circumvent, disable, tamper with, or otherwise interfere with any
53
+ license verification, activation, integrity check, telemetry
54
+ restriction, or other security or compliance mechanism of the
55
+ Software;
56
+
57
+ (f) use the Software to violate the terms of service or acceptable use
58
+ policy of any third-party product or service (including but not
59
+ limited to Cursor), to engage in any unlawful activity, or to
60
+ infringe any third-party right.
61
+
62
+
63
+ 3. INTELLECTUAL PROPERTY
64
+
65
+ The Software is licensed, not sold. The Licensor and its licensors
66
+ retain all right, title, and interest in and to the Software, including
67
+ all intellectual property rights therein. This Agreement does not grant
68
+ You any rights to the Licensor's trademarks, service marks, or logos.
69
+
70
+
71
+ 4. THIRD-PARTY COMPONENTS
72
+
73
+ The Software incorporates third-party open-source components, each
74
+ governed by its own license. Such components are provided under their
75
+ respective licenses and are not subject to the restrictions in
76
+ Sections 1 through 3 of this Agreement insofar as those restrictions
77
+ would conflict with the third-party license. A list of third-party
78
+ components and their licenses is available upon request.
79
+
80
+
81
+ 5. DISCLAIMER OF WARRANTIES
82
+
83
+ THE SOFTWARE IS PROVIDED "AS IS" AND "AS AVAILABLE", WITHOUT WARRANTY
84
+ OF ANY KIND, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED
85
+ TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
86
+ TITLE, AND NON-INFRINGEMENT. THE LICENSOR DOES NOT WARRANT THAT THE
87
+ SOFTWARE WILL BE UNINTERRUPTED, ERROR-FREE, SECURE, OR FREE OF HARMFUL
88
+ COMPONENTS, NOR DOES IT WARRANT ANY PARTICULAR RESULTS FROM YOUR USE
89
+ OF THE SOFTWARE.
90
+
91
+
92
+ 6. LIMITATION OF LIABILITY
93
+
94
+ TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT SHALL
95
+ THE LICENSOR BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
96
+ CONSEQUENTIAL, EXEMPLARY, OR PUNITIVE DAMAGES, OR FOR ANY LOSS OF
97
+ PROFITS, REVENUE, DATA, GOODWILL, OR BUSINESS OPPORTUNITY, ARISING OUT
98
+ OF OR RELATED TO THIS AGREEMENT OR YOUR USE OF (OR INABILITY TO USE)
99
+ THE SOFTWARE, WHETHER IN CONTRACT, TORT, OR OTHERWISE, EVEN IF ADVISED
100
+ OF THE POSSIBILITY OF SUCH DAMAGES.
101
+
102
+ THE LICENSOR'S TOTAL CUMULATIVE LIABILITY UNDER THIS AGREEMENT SHALL
103
+ NOT EXCEED THE GREATER OF (i) THE AMOUNT YOU PAID THE LICENSOR FOR THE
104
+ SOFTWARE IN THE TWELVE (12) MONTHS PRECEDING THE EVENT GIVING RISE TO
105
+ THE CLAIM, OR (ii) USD $50.
106
+
107
+
108
+ 7. TERM AND TERMINATION
109
+
110
+ This Agreement is effective until terminated. The Licensor may
111
+ terminate this Agreement immediately upon Your breach of any term
112
+ hereof. Upon termination, You must cease all use of the Software and
113
+ destroy all copies in Your possession or control. Sections 2 through 6
114
+ and Section 8 shall survive any termination of this Agreement.
115
+
116
+
117
+ 8. GENERAL
118
+
119
+ This Agreement constitutes the entire agreement between You and the
120
+ Licensor with respect to the Software and supersedes all prior or
121
+ contemporaneous communications, whether oral or written, regarding the
122
+ same. If any provision of this Agreement is held to be unenforceable,
123
+ the remaining provisions shall remain in full force and effect, and
124
+ the unenforceable provision shall be modified to the minimum extent
125
+ necessary to make it enforceable. No waiver of any breach shall
126
+ constitute a waiver of any subsequent breach.
127
+
128
+ The Licensor reserves the right to update this Agreement at any time.
129
+ Continued use of the Software after notice of changes constitutes
130
+ acceptance of the updated terms.
131
+
132
+
133
+ For licensing inquiries, please contact: contact@cursorx.top
package/README.md ADDED
@@ -0,0 +1,99 @@
1
+ # CursorX
2
+
3
+ > **CursorX 让你在 Cursor 中用自己的 API Key 接入自定义模型;非官方,与 Cursor 官方无隶属关系。**
4
+ >
5
+ > **CursorX lets you connect your own model API keys to Cursor; unofficial, not affiliated with Cursor.**
6
+
7
+ ---
8
+
9
+ ## 是什么 / What is it
10
+
11
+ CursorX 是一个**本地**的 Cursor 增强工具。它让你在 Cursor 中接入**自己配置的模型 API**与**自定义模型列表**,不论你是 Free 还是 Pro 计划。所有请求只走 `127.0.0.1`、所有 API Key 只入系统 Keychain、所有日志默认仅元数据、零远程上传。
12
+
13
+ CursorX is a local enhancement tool for Cursor. It lets you use your own model API and a custom model list inside Cursor, regardless of your Cursor plan. All requests stay on `127.0.0.1`; API keys live only in your system keychain; logs are metadata-only by default; nothing leaves your machine.
14
+
15
+ ---
16
+
17
+ ## 安装 / Install
18
+
19
+ ```bash
20
+ npx @cursorx/cli install
21
+ ```
22
+
23
+ 安装器会自动完成:
24
+
25
+ 1. 检测当前系统(macOS / Windows / Linux)与 Cursor 版本
26
+ 2. 在 `~/.cursorx/backups/<timestamp>/` 创建原始文件备份(带 SHA-256 校验,便于一键回滚)
27
+ 3. 安装 CursorX Extension 到你的 Cursor / VS Code
28
+ 4. 启动本地路由(监听 `127.0.0.1` 随机端口)
29
+
30
+ The installer detects your OS and Cursor version, backs up touched files under `~/.cursorx/backups/<timestamp>/` with SHA-256 checksums, installs the extension into Cursor / VS Code, and starts the local router on `127.0.0.1`.
31
+
32
+ ---
33
+
34
+ ## 配置 / Configure
35
+
36
+ 打开 Cursor → 左侧 Activity Bar 点 **CursorX** 图标 → 打开控制面板:
37
+
38
+ 1. 在 **提供商 / Providers** 添加一个 Provider(Base URL + API Key,Key 自动存入 Keychain)
39
+ 2. 在 **模型 / Models** 给该 Provider 添加 1–2 个模型
40
+ 3. 在 **路由 / Routes** 把 chat 指向上面的模型
41
+ 4. 在 **状态 / Status** 打开 CursorX 总开关 → 完成
42
+
43
+ Open Cursor → click the CursorX icon in the Activity Bar → in the Control Panel: add a provider with its Base URL and API key, add a model under it, point the chat route at that model, then toggle CursorX on.
44
+
45
+ ---
46
+
47
+ ## 卸载 / Restore / Uninstall
48
+
49
+ ```bash
50
+ npx @cursorx/cli restore # 回滚 Cursor 到安装前的原始文件(SHA-256 校验)
51
+ npx @cursorx/cli uninstall # restore + 清理 CursorX 数据
52
+ ```
53
+
54
+ `restore` rolls Cursor back to its pre-install state using the SHA-256-verified backup. `uninstall` does the same and also removes CursorX's own data.
55
+
56
+ ---
57
+
58
+ ## 安全 / Security
59
+
60
+ - **本地路由**硬编码绑定 `127.0.0.1`;不绑公网、不做反向代理。
61
+ - **API Key 仅入系统 Keychain**(macOS Keychain / Windows Credential Manager / Linux Secret Service)——绝不写入 JSON / 日志 / 错误响应。
62
+ - **日志默认仅元数据**:只记录请求 ID / 时间 / 模型 / 状态 / 延迟 / token 数,不记录 Prompt 内容。
63
+ - **零远程上传**:日志、Prompt、代码均不离开本机;不内置 telemetry / analytics。
64
+ - **唯一对外出站例外 = 授权校验**:启用付费授权时,CursorX 仅向自家授权服务发送 `授权码 + 不可逆设备哈希 + 平台 / 版本号`。绝不发送代码 / Prompt / API Key / Cursor 账号或 token。
65
+
66
+ Router binds `127.0.0.1` only. API keys live only in the system keychain. Logs are metadata-only by default. No remote upload, no telemetry. The only outbound exception is license activation, which sends only the license key, an irreversible device hash, and platform/version to CursorX's own license service — never your code, prompts, API keys, or Cursor account tokens.
67
+
68
+ ---
69
+
70
+ ## 合规 / Compliance
71
+
72
+ - CursorX **不**使用 Cursor 官方 Logo / 商标。
73
+ - CursorX **不**作为「破解 Pro」「绕过 Pro」「解锁 Pro」类工具宣传;CursorX **不提供** Cursor 任何付费模型的访问能力,那些仍由 Cursor 服务器决定。
74
+ - CursorX **不**修改 Cursor 服务器认证 / 不伪造订阅或支付状态 / 不读取 Cursor 账号或 token。
75
+ - CursorX **不**承诺所有 Cursor 版本永久可用;Cursor 升级若改动相关路径,CursorX 会自动暂停并提示你重新适配。
76
+
77
+ CursorX does not use Cursor's trademarks or logo. CursorX is not a "crack Pro" / "bypass Pro" / "unlock Pro" tool — it provides no access to Cursor's paid models, which remain gated by Cursor's own servers. CursorX does not touch Cursor's server-side authentication, subscription state, or account / session tokens. CursorX does not guarantee permanent compatibility — if Cursor changes the relevant paths, CursorX auto-pauses and prompts you to re-apply.
78
+
79
+ ---
80
+
81
+ ## 反馈 / Feedback
82
+
83
+ Bug 报告 / 功能请求 / Bug reports / feature requests: <https://github.com/Runcoor/cursorx-issues/issues>
84
+
85
+ 提交诊断信息前请先在控制面板「设置 → 导出诊断包」生成脱敏版本。Before sharing diagnostics, export a redacted bundle from the Control Panel → Settings.
86
+
87
+ ---
88
+
89
+ ## 许可 / License
90
+
91
+ 专有 EULA(详 [`LICENSE`](LICENSE))。允许个人非独占使用;禁止反向工程 / 再分发 / 重新打包 / 绕过授权校验。
92
+
93
+ Proprietary EULA (see [`LICENSE`](LICENSE)). Personal non-exclusive use; reverse engineering / redistribution / repackaging / circumvention of license verification are prohibited.
94
+
95
+ 商务 / 授权咨询 / Commercial inquiries: <contact@cursorx.top>
96
+
97
+ ---
98
+
99
+ CursorX · 2026-06