Skip to content

Commit

Permalink
doc: 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
chengchongzhen committed Jan 21, 2025
1 parent e4945d7 commit f1a3f99
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 10 deletions.
33 changes: 30 additions & 3 deletions README.EN.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Cursor Pro Automation Tool User Guide

README also available in: [中文](./README.md), [Tiếng Việt](./README.VI.md)

## Note
Recently, some users have sold this software on platforms like Xianyu. Please avoid such practices—theres no need to earn money this way.
Recently, some users have sold this software on platforms like Xianyu. Please avoid such practices—there's no need to earn money this way.

## License
This project is licensed under [CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/).
Expand All @@ -22,12 +24,14 @@ Automated account registration and token refreshing to free your hands.
3. **A stable internet connection is required, preferably via an overseas node. Do not enable global proxy.**

## Configuration Instructions

### 1. tempmail.plus Email Forwarding
- Use a Cloudflare domain email. Search for instructions if needed.
- **(Very Important)** Use tempmail.plus email. Search for instructions if needed.
- Forward Cloudflare emails to tempmail.plus.
- Download the `.env.example` file to the program's root directory and rename it to `.env`.

### Example `.env` file:
Example `.env` file:
```bash
DOMAIN='xxxxx.me' # Your email domain (search for Cloudflare email usage)
TEMP_MAIL='xxxxxx' # Temporary email, the target position you set in Cloudflare, using https://tempmail.plus/zh/#!
Expand All @@ -39,6 +43,25 @@ TEMP_MAIL='ccxxxxcxx'
```
The program will randomly generate emails with the `@wozhangsan.me` suffix.

### 2. Using IMAP Instead of tempmail.plus
If you can't use tempmail.plus or prefer a more secure method to receive verification codes, you can configure like this:
```bash
DOMAIN='wozhangsan.me'
TEMP_MAIL=null

# IMAP server
IMAP_SERVER=imap.xxxxx.com
# IMAP SSL port
IMAP_PORT=993
# Email forwarded from CF
[email protected]
# Email authorization code
IMAP_PASS=xxxxxxxxxxxxx
# [Optional] Default is inbox
# You can set it to other folders where you can receive emails
IMAP_DIR=
```

## How to Run the Program

### Mac
Expand Down Expand Up @@ -71,6 +94,9 @@ After running the script, restart your editor. If the displayed account matches
- Wait for the program to complete all operations.
- Close the program only after seeing the "script completed" message.

## Sponsor for More Updates
![image](./screen/afdian-[未认证]阿臻.jpg)

## Common Issues
1. Program freezes:
- Check your internet connection.
Expand All @@ -83,5 +109,6 @@ This tool is for educational and research purposes only. Users bear full respons
- **2025-01-09**: Added logs and auto-build feature.
- **2025-01-10**: Switched to Cloudflare domain email.
- **2025-01-11**: Added headless mode and proxy configuration through .env file.
- **2025-01-20**: Added IMAP to replace tempmail.plus.

Inspired by [gpt-cursor-auto](https://github.com/hmhm2022/gpt-cursor-auto).
Inspired by [gpt-cursor-auto](https://github.com/hmhm2022/gpt-cursor-auto); optimized verification and email auto-registration logic; solved the issue of not being able to receive email verification codes.
38 changes: 32 additions & 6 deletions README.VI.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Công Cụ Tự Động Hóa Cursor Pro

README cũng có sẵn bằng: [中文](./README.md), [English](./README.EN.md)

## Lời Nhắc
Gần đây có người mang phần mềm này bán trên các trang thương mại, việc này nên hạn chế. Không phải cái gì cũng cần kiếm tiền.

Expand All @@ -22,12 +24,14 @@ Tự động đăng ký tài khoản, tự động làm mới token, giải phó
3. **Cần có kết nối mạng ổn định, ưu tiên sử dụng máy chủ nước ngoài. Không bật proxy toàn cầu.**

## Hướng Dẫn Cấu Hình

### 1. Chuyển Tiếp Email tempmail.plus
- Cần sử dụng email theo tên miền Cloudflare. Hãy tìm hiểu cách sử dụng.
- **(Rất quan trọng)** Cần sử dụng email tạm thời từ tempmail.plus. Hãy tìm hiểu cách sử dụng.
- Chuyển tiếp email từ tên miền Cloudflare sang tempmail.plus.
- Tải tệp `.env.example` về thư mục gốc của chương trình và đổi tên thành `.env`.

### Cấu hình tệp `.env`:
Cấu hình tệp `.env`:
```bash
DOMAIN='xxxxx.me' # Tên miền email của bạn (tự tìm hiểu cách sử dụng Cloudflare email)
TEMP_MAIL='xxxxxx' # Email tạm thời, là địa chỉ đích bạn đã thiết lập trong Cloudflare, sử dụng email từ https://tempmail.plus/zh/#!
Expand All @@ -39,6 +43,25 @@ TEMP_MAIL='ccxxxxcxx'
```
Chương trình sẽ tự tạo ngẫu nhiên email với đuôi `@wozhangsan.me`.

### 2. Sử Dụng IMAP Thay Thế tempmail.plus
Nếu bạn không thể sử dụng tempmail.plus hoặc muốn một phương pháp an toàn hơn để nhận mã xác minh, bạn có thể cấu hình như sau:
```bash
DOMAIN='wozhangsan.me'
TEMP_MAIL=null

# Máy chủ IMAP
IMAP_SERVER=imap.xxxxx.com
# Cổng SSL IMAP
IMAP_PORT=993
# Email được chuyển tiếp từ CF
[email protected]
# Mã xác thực email
IMAP_PASS=xxxxxxxxxxxxx
# [Tùy chọn] Mặc định là hộp thư đến (inbox)
# Bạn có thể đặt thành các thư mục khác nơi bạn có thể nhận email
IMAP_DIR=
```

## Cách Chạy Chương Trình

### Phiên Bản Mac
Expand Down Expand Up @@ -79,9 +102,12 @@ Sau khi chạy script, khởi động lại trình chỉnh sửa. Nếu tài kho
## Tuyên Bố Miễn Trừ
Công cụ này chỉ dành cho mục đích học tập và nghiên cứu. Người dùng tự chịu trách nhiệm về mọi hậu quả. Nghiêm cấm sử dụng cho mục đích thương mại. Vi phạm giấy phép sẽ chịu trách nhiệm pháp lý.

## Nhật Ký Cập Nhật
- **2025-01-09**: Thêm log, chức năng tự xây dựng.
- **2025-01-10**: Chuyển sang email tên miền Cloudflare.
- **2025-01-11**: Thêm chức năng tự động xây dựng, thêm chức năng tự động xây dựng, thêm chức năng tự động xây dựng.
## Tài Trợ Để Có Thêm Cập Nhật
![image](./screen/afdian-[未认证]阿臻.jpg)

Lấy cảm hứng từ [gpt-cursor-auto](https://github.com/hmhm2022/gpt-cursor-auto).
## Nhật Ký Cập Nhật
- **2025-01-09**: Thêm nhật ký và tính năng tự động xây dựng.
- **2025-01-10**: Chuyển sang sử dụng email tên miền Cloudflare.
- **2025-01-11**: Thêm chế độ không giao diện và cấu hình proxy thông qua tệp .env.
- **2025-01-20**: Thêm chế độ IMAP để thay thế tempmail.plus.
Lấy cảm hứng từ [gpt-cursor-auto](https://github.com/hmhm2022/gpt-cursor-auto); đã tối ưu hóa logic xác minh và đăng ký email tự động; đã giải quyết vấn đề không thể nhận mã xác minh email.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ https://github.com/chengazhen/cursor-auto-free/releases

## 配置说明

## 1. tempmail.plus 转发邮箱
+ 需要使用 cloudflare 域名邮箱,请自行搜索如何使用 cloudflare 域名邮箱,请自行搜索如何使用。
+ **(非常重要)** 需要使用 tempmail.plus 邮箱,请自行搜索如何使用 tempmail.plus 邮箱。
+ 将 cloudflare 的域名邮箱转发到 tempmail.plus 邮箱。
Expand All @@ -50,7 +51,7 @@ TEMP_MAIL='ccxxxxcxx'
```
那么程序将随机生成 `@wozhangsan.me` 后缀作为注册邮箱。

### 使用 IMAP 来代替 tempmail.plus 邮箱
### 2. 使用 IMAP 来代替 tempmail.plus 邮箱
如果无法使用 tempmail.plus 邮箱,或者想使用一种更安全的方法来获取验证码,你可以像这样设置
```base
DOMAIN='wozhangsan.me'
Expand Down Expand Up @@ -129,6 +130,7 @@ chmod +x ./CursorPro
- **2025-01-09** 增加了 log 日志,方便调试,增加了退出cursor,自动构建功能
- **2025-01-10** 修改为使用 cloudflared 域名邮箱
- **2025-01-11** 增加了可以通过 .env 文件配置 无头模式,增加了代理
- **2025-01-20** 增加了通过 IMAP 来代替 tempmail.plus 邮箱

灵感来自[gpt-cursor-auto](https://github.com/hmhm2022/gpt-cursor-auto);自行优化了验证和邮箱自动注册逻辑;解决了无法获取邮箱验证码的问题。

0 comments on commit f1a3f99

Please sign in to comment.