Skip to content

Commit 2b2fb6d

Browse files
committed
refactor: Remove install.sh and enhance README.md with updated installation instructions
- Deleted the `install.sh` script to streamline the installation process and reduce complexity. - Updated the `README.md` to reflect the new installation method, emphasizing the recommended automatic installation approach. - Improved clarity in installation instructions for both Linux/macOS and Windows, ensuring users have clear guidance on how to install the tool. - Added details about the automatic installation script's features, including privilege requests and configuration backups. - Enhanced the manual installation section with step-by-step instructions for users who prefer that method. These changes collectively improve the documentation and user experience during the installation process.
1 parent 20b2eb7 commit 2b2fb6d

6 files changed

Lines changed: 674 additions & 323 deletions

File tree

README.md

Lines changed: 69 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,39 @@ this is a mistake.
3333

3434
### 📥 Installation
3535

36-
#### Automatic Installation
36+
#### Automatic Installation (Recommended)
3737

3838
**Linux/macOS**
3939
```bash
40-
curl -fsSL https://raw.githubusercontent.com/yuaotian/go-cursor-help/refs/heads/master/install.sh | bash -s -- --auto-sudo && rm -f /tmp/cursor_id_modifier_*
40+
curl -fsSL https://raw.githubusercontent.com/yuaotian/go-cursor-help/master/scripts/install.sh | sudo bash
4141
```
4242

43-
**Windows** (Run in PowerShell as Admin)
43+
**Windows** (Run PowerShell as Admin)
4444
```powershell
45-
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/yuaotian/go-cursor-help/refs/heads/master/bin/cursor_id_modifier_v2.0.0_windows_amd64.exe')); Remove-Item -Path "$env:TEMP\cursor-id-modifier.exe" -ErrorAction SilentlyContinue
45+
irm https://raw.githubusercontent.com/yuaotian/go-cursor-help/master/scripts/install.ps1 | iex
4646
```
4747

48-
#### Manual Method
48+
The installation script will automatically:
49+
- Request necessary privileges (sudo/admin)
50+
- Close any running Cursor instances
51+
- Backup existing configuration
52+
- Install the tool
53+
- Add it to system PATH
54+
- Clean up temporary files
55+
56+
#### Manual Installation
57+
58+
1. Download the latest release for your system from the [releases page](https://github.com/yuaotian/go-cursor-help/releases)
59+
2. Extract and run with administrator/root privileges:
60+
```bash
61+
# Linux/macOS
62+
sudo ./cursor-id-modifier
63+
64+
# Windows (PowerShell Admin)
65+
.\cursor-id-modifier.exe
66+
```
67+
68+
#### Manual Configuration Method
4969

5070
1. Close Cursor completely
5171
2. Navigate to the configuration file location:
@@ -68,17 +88,25 @@ Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManage
6888

6989
### 🔧 Technical Details
7090

71-
The program modifies Cursor's `storage.json` config file:
91+
#### Configuration Files
92+
The program modifies Cursor's `storage.json` config file located at:
7293
- Windows: `%APPDATA%\Cursor\User\globalStorage\`
7394
- macOS: `~/Library/Application Support/Cursor/User/globalStorage/`
7495
- Linux: `~/.config/Cursor/User/globalStorage/`
7596

76-
Generates new unique identifiers for:
97+
#### Modified Fields
98+
The tool generates new unique identifiers for:
7799
- `telemetry.machineId`
78100
- `telemetry.macMachineId`
79101
- `telemetry.devDeviceId`
80102
- `telemetry.sqmId`
81103

104+
#### Safety Features
105+
- Automatic backup of existing configuration
106+
- Safe process termination
107+
- Atomic file operations
108+
- Error handling and rollback
109+
82110
---
83111

84112
# 🌏 Chinese
@@ -102,19 +130,39 @@ this is a mistake.
102130

103131
### 📥 安装方法
104132

105-
#### 自动安装
133+
#### 自动安装(推荐)
106134

107135
**Linux/macOS**
108136
```bash
109-
curl -fsSL https://raw.githubusercontent.com/yuaotian/go-cursor-help/refs/heads/master/install.sh | bash -s -- --auto-sudo && rm -f /tmp/cursor_id_modifier_*
137+
curl -fsSL https://raw.githubusercontent.com/yuaotian/go-cursor-help/master/scripts/install.sh | sudo bash
110138
```
111139

112140
**Windows** (以管理员身份运行PowerShell)
113141
```powershell
114-
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/yuaotian/go-cursor-help/refs/heads/master/bin/cursor_id_modifier_v2.0.0_windows_amd64.exe')); Remove-Item -Path "$env:TEMP\cursor-id-modifier.exe" -ErrorAction SilentlyContinue
142+
irm https://raw.githubusercontent.com/yuaotian/go-cursor-help/master/scripts/install.ps1 | iex
115143
```
116144

117-
#### 手动方法
145+
安装脚本会自动:
146+
- 请求必要的权限(sudo/管理员)
147+
- 关闭所有运行中的Cursor实例
148+
- 备份现有配置
149+
- 安装工具
150+
- 添加到系统PATH
151+
- 清理临时文件
152+
153+
#### 手动安装
154+
155+
1.[发布页面](https://github.com/yuaotian/go-cursor-help/releases)下载适合您系统的最新版本
156+
2. 解压并以管理员/root权限运行:
157+
```bash
158+
# Linux/macOS
159+
sudo ./cursor-id-modifier
160+
161+
# Windows (PowerShell 管理员)
162+
.\cursor-id-modifier.exe
163+
```
164+
165+
#### 手动配置方法
118166

119167
1. 完全关闭 Cursor
120168
2. 找到配置文件位置:
@@ -137,17 +185,25 @@ Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManage
137185

138186
### 🔧 技术细节
139187

140-
程序修改Cursor的`storage.json`配置文件:
188+
#### 配置文件
189+
程序修改Cursor的`storage.json`配置文件,位于:
141190
- Windows: `%APPDATA%\Cursor\User\globalStorage\`
142191
- macOS: `~/Library/Application Support/Cursor/User/globalStorage/`
143192
- Linux: `~/.config/Cursor/User/globalStorage/`
144193

145-
生成新的唯一标识符:
194+
#### 修改字段
195+
工具会生成新的唯一标识符:
146196
- `telemetry.machineId`
147197
- `telemetry.macMachineId`
148198
- `telemetry.devDeviceId`
149199
- `telemetry.sqmId`
150200

201+
#### 安全特性
202+
- 自动备份现有配置
203+
- 安全的进程终止
204+
- 原子文件操作
205+
- 错误处理和回滚
206+
151207
## 📄 License
152208

153209
MIT License

0 commit comments

Comments
 (0)