返回 AiToEarn
README_EN.md
根目录 / README_EN.md
1 # [Aitoearn: The Best Open-Source AI Agent for Content Marketing](https://aitoearn.ai)
2
3 <a href="https://trendshift.io/repositories/20785" target="_blank"><img src="https://trendshift.io/api/badge/repositories/20785" alt="yikart%2FAiToEarn | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
4
5 [![GitHub stars](https://img.shields.io/github/stars/yikart/AiToEarn?color=fa6470)](https://github.com/yikart/AiToEarn/stargazers)
6 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
7 [![Required Node.JS 20.18.x](https://img.shields.io/static/v1?label=node&message=20.18.x&logo=node.js&color=3f893e)](https://nodejs.org/about/releases)
8
9 English | [简体中文](README.md) | [日本語](README_JA.md)
10
11 **Monetize · Publish · Engage · Create — all in one platform.**
12
13 AiToEarn helps OPCs (One-Person Companies), creators, brands, and businesses build, distribute, and monetize content with **AI-powered automation** across the world's most popular platforms.
14
15 Supported Channels:
16 Douyin, Xiaohongshu (Rednote), Kuaishou, Bilibili, WeChat Channels, WeChat Official Accounts, TikTok, YouTube, Facebook, Instagram, Threads, Twitter (X), Pinterest, LinkedIn
17
18 ## 🚀 Quick Start with AiToEarn (5 Ways)
19
20 | Option | Best for | Deployment needed? |
21 |--------|----------|-------------------|
22 | [① Use the Website](#use-web) | Everyone | ❌ No |
23 | [② Use in OpenClaw](#use-in-openclaw) | OpenClaw users | ❌ No |
24 | [③ Use in Claude / Cursor / Other AI Assistants](#use-in-claude) | AI tool users | ❌ No |
25 | [④ Docker One-Click Deploy](#use-docker) | Teams wanting self-hosted | ✅ Server needed |
26 | [⑤ Build from Source](#use-source) | Developers | ✅ Dev environment needed |
27
28 > 💡 **Options ②③④ require an API Key first.** See [How to Get an API Key](#get-api-key).
29
30 ## What's New
31
32 - **2026-06-23**: [2.5 version](https://github.com/yikart/AiToEarn/releases/tag/v2.5.0) — Relay configuration now happens in the Configuration UI and is split into Server Relay and AI Relay: Server Relay handles publishing platform authorization, while AI Relay lets users use AI models provided by the platform.
33 - **2026-05-21**: [2.4 version](https://github.com/yikart/AiToEarn/releases/tag/v2.4.0) — Draft generation now supports HappyHorse 1.0 and Seedance 2.0, with improved batch video/image-text draft generation, multi-model selection, reference images/videos, target-platform limits, and caption prompts; refreshed interface style and enhanced Twitter/X exploration and engagement.
34 - **2026-04-20**: OpenClaw now supports AiToEarn earning workflows, so you can receive and execute monetization tasks directly inside OpenClaw.
35 - **2026-03-26**: [2.1 version](https://www.aitoearn.ai/) — Content marketplace launched; added OpenClaw support for using AiToEarn directly within OpenClaw; added MCP protocol support for using AiToEarn in Claude, Cursor, and any MCP-compatible Agent or LLM.
36 - **2026-02-07**: [1.8.0 version](https://www.aitoearn.ai/) — Added offline business promotion solutions for restaurants, retail stores, hotels, beauty salons, gyms, and more.
37 - **2025-12-15**: "All In Agent" arrives! We've introduced a super AI agent that can automatically generate and publish content. [v1.4.3](https://github.com/yikart/AiToEarn/releases/tag/v1.4.3)
38 - **2025-11-28**: Support automatic updates within the application. Added AI functions: abbreviation, expansion, image creation, video creation, tag generation, etc. [v1.4.0](https://github.com/yikart/AiToEarn/releases/tag/v1.4.0)
39 - **2025-11-12**: The first open-source, fully usable version. [v1.3.2](https://github.com/yikart/AiToEarn/releases/tag/v1.3.2)
40 - **2025-09-16**: First international version, added support for Facebook, Instagram, Threads, Twitter, YouTube, TikTok, Pinterest. [v1.0.18](https://github.com/yikart/AiToEarn/releases/tag/v1.0.18)
41 - **2025-02-26**: First open-source release, initial support for one-click publishing to Xiaohongshu, Douyin, Kuaishou, and WeChat Channels. [v0.1.1](https://github.com/yikart/AiToEarn/releases/tag/v0.1.1)
42
43 <details>
44 <summary><h2 style="display:inline;margin:0">Table of Contents</h2></summary>
45
46 <br/>
47
48 1. [Quick Start with AiToEarn (5 Ways)](#-quick-start-with-aitoearn-5-ways)
49 2. [What's New](#whats-new)
50 3. [Key Features](#key-features)
51 4. [How to Get an API Key](#get-api-key)
52 5. [Contributing](#contributing)
53 6. [Contact](#contact)
54 7. [Recommended](#recommended)
55 </details>
56
57 ## Key Features
58
59 AiToEarn provides four core Agent capabilities around the creator's full monetization pipeline:
60
61 > **Monetize · Publish · Engage · Create**
62
63 ---
64
65 ### 💰 Monetize — Earn from Your Content
66
67 The core mission of AiToEarn: **help every creator earn money**.
68
69 Creators can sell content on the platform to complete brand promotion tasks. All settlements are results-driven, with three models:
70
71 | Model | Full Name | Meaning |
72 |-------|-----------|---------|
73 | **CPS** | Cost Per Sale | Settle by transaction amount |
74 | **CPE** | Cost Per Engagement | Settle by engagement count |
75 | **CPM** | Cost Per Mille | Settle by view count |
76
77 <img src="presentation/monetize-cn.png" width="30%">
78
79 ---
80
81 ### 📢 Publish — Content Publishing Agent
82
83 Distribute content to 10+ major platforms worldwide with one click — no more manual posting on each platform.
84
85 - **Multi-Platform Distribution**: Douyin, Kwai, Bilibili, Rednote, WeChat Channels, WeChat Official Accounts, TikTok, YouTube, Facebook, Instagram, Threads, X (Twitter), Pinterest, LinkedIn
86 - **Calendar Scheduler**: Plan and coordinate content publishing across all platforms like a calendar
87
88 <img src="presentation/publish-cn.png" width="30%"> <img src="presentation/channel-cn.png" width="30%">
89
90 > ▶ Watch Demo Video
91
92 <a href="https://www.youtube.com/watch?v=5041jEKaiU8">
93 <img src="https://img.youtube.com/vi/5041jEKaiU8/0.jpg" alt="Publish Demo Video" width="480">
94 </a>
95
96 ---
97
98 ### 💬 Engage — Content Engagement Agent
99
100 Automate engagement operations across all supported platforms via the AiToEarn browser extension.
101
102 - **Automated Actions**: Auto-like, bookmark, and follow — batch operations at scale
103 - **AI Smart Replies**: Use LLMs to generate targeted replies for each comment
104 - **Comment Mining**: Detect high-conversion signals like "link please" or "how to buy" and respond instantly
105 - **Brand Monitoring**: Track brand mentions in real-time and proactively join trending conversations
106
107 > ▶ Watch Demo Video
108
109 <a href="https://youtu.be/-QoHNrZBmp0">
110 <img src="./presentation/engage-thumbnail-cn.png" alt="Engage Demo Video" width="480">
111 </a>
112
113 ---
114
115 ### 🎨 Create — Content Creation Agent
116
117 We've rebuilt the content creation workflow with Agents. Just tell the Agent what you need — it handles everything from idea to finished product.
118
119 **Video Content**: The Agent automatically invokes video generation models (Grok, Veo, Seedance, etc.), video translation modules, and video editing modules to produce a complete video.
120
121 **Image & Text Content**: Supports top-tier image models like Nano Banana to create high-quality visual content automatically.
122
123 **Batch Generation**: Submit creation tasks in bulk — the Agent generates multiple pieces of content in parallel, perfect for matrix account operations and large-scale content distribution.
124
125 > ▶ Watch Demo Video
126
127 <a href="https://youtu.be/y900LxIrZT4">
128 <img src="./presentation/display-1.5.2png.png" alt="Create Demo Video" width="480">
129 </a>
130
131 ---
132
133 <h2 id="use-web">① Use the Website</h2>
134
135 The simplest way — just open your browser:
136
137 - 🇨🇳 China users: **[aitoearn.cn](https://aitoearn.cn/)**
138 - 🌍 International users: **[aitoearn.ai](https://aitoearn.ai/)**
139
140 ---
141
142 <h2 id="get-api-key">🔑 How to Get an API Key (Required for Steps Below)</h2>
143
144 > Options ②③④ all need an API Key. You only need to get it once.
145
146 **3 steps**:
147
148 1. Open [aitoearn.cn](https://aitoearn.cn/) (China) or [aitoearn.ai](https://aitoearn.ai/) (international), sign up and log in
149 2. Click **Settings** in the left menu
150 3. Go to **API Key**, click Create, and copy the generated key
151
152 <img src="presentation/app-screenshot/0.%20api-key/api-key-settings.png" alt="Get API Key" width="600">
153
154 > ⚠️ Keep your API Key safe. Do not share it with others.
155
156 ---
157
158 <h2 id="use-in-openclaw">② Use in OpenClaw</h2>
159
160 > Prerequisite: [Get an API Key](#get-api-key) first
161
162 **Install the plugin**
163
164 ```bash
165 npx -y @aitoearn/openclaw-plugin-cli
166 ```
167
168 On first run, select the environment and enter your API Key. Make sure they match: China uses an API Key from `aitoearn.cn`, and international uses one from `aitoearn.ai`. A mismatch returns 401.
169
170 After setup, you can receive and execute AiToEarn earning tasks directly inside OpenClaw:
171
172 <img src="presentation/openclaw-earn-demo.png" alt="Run AiToEarn earning tasks in OpenClaw" width="360">
173
174 ---
175
176 <h2 id="use-in-claude">③ Use in Claude / Cursor / Other AI Assistants</h2>
177
178 > Prerequisite: [Get an API Key](#get-api-key) first
179
180 AiToEarn works with any MCP-compatible AI assistant. Here's how to configure the most popular ones:
181
182 Choose the URL that matches your API Key. A mismatched environment and key returns 401:
183
184 | Environment | MCP URL | SSE URL |
185 |-------------|---------|---------|
186 | China | `https://aitoearn.cn/api/unified/mcp` | `https://aitoearn.cn/api/unified/sse` |
187 | International | `https://aitoearn.ai/api/unified/mcp` | `https://aitoearn.ai/api/unified/sse` |
188
189 <details open>
190 <summary><b>Claude Desktop</b></summary>
191
192 Find and edit `claude_desktop_config.json`, add:
193
194 ```json
195 {
196 "mcpServers": {
197 "aitoearn": {
198 "type": "http",
199 "url": "https://aitoearn.ai/api/unified/mcp",
200 "headers": {
201 "x-api-key": "your-api-key"
202 }
203 }
204 }
205 }
206 ```
207
208 </details>
209
210 <details>
211 <summary><b>Cursor</b></summary>
212
213 In Cursor's MCP settings, add:
214
215 ```
216 MCP URL: https://aitoearn.ai/api/unified/mcp
217 Auth Header: x-api-key: your-api-key
218 ```
219
220 </details>
221
222 <details>
223 <summary><b>Other AI Assistants (Generic Config)</b></summary>
224
225 Any MCP-compatible tool just needs two pieces of info:
226
227 | Setting | Value |
228 |---------|-------|
229 | **MCP URL** | `https://aitoearn.ai/api/unified/mcp` |
230 | **Auth Header** | `x-api-key: your-api-key` |
231
232 SSE transport is also available: `https://aitoearn.ai/api/unified/sse`
233
234 </details>
235
236 > 💡 For self-hosted instances, replace `aitoearn.ai` with your own address (e.g., `localhost:8080`).
237
238 ---
239
240 <h2 id="use-docker">④ Docker One-Click Deploy</h2>
241
242 > Prerequisite: [Docker](https://docs.docker.com/get-docker/) installed
243
244 For teams wanting to run AiToEarn on their own server. 3 commands, no manual database setup:
245
246 ```bash
247 git clone https://github.com/yikart/AiToEarn.git
248 cd AiToEarn
249 docker compose up -d
250 ```
251
252 Open **[http://localhost:8080](http://localhost:8080)** and you're ready to go.
253
254 #### Configure Relay (Strongly Recommended)
255
256 > **Why Relay?** Publishing content requires logging into social media accounts (TikTok, Instagram, YouTube, etc.), which need OAuth developer credentials. With Relay, you can use the official aitoearn.ai credentials — **no need to register as a developer on each platform**.
257
258 Open the deployed UI in your browser, go to **Configuration**, and configure these sections as needed:
259
260 - **Server → Relay**: for content publishing and social platform OAuth authorization.
261 - **AI → Relay**: for using AI models provided by the platform.
262
263 For OpenAI, Gemini, Anthropic, and other model providers, you can also fill in the platform-provided API key and API URL under **AI → Model providers**.
264
265 See [How to Get an API Key](#get-api-key). China keys must use `https://aitoearn.cn/api`, and international keys must use `https://aitoearn.ai/api`; mismatched environments return 401.
266
267 After saving, click **Save and restart** so the corresponding service reloads the configuration.
268
269 > 📖 Full deployment guide (production config, AI services, OAuth, storage, etc.): [DOCKER_DEPLOYMENT_EN.md](DOCKER_DEPLOYMENT_EN.md).
270
271 ---
272
273 <h2 id="use-source">⑤ Build from Source</h2>
274
275 <details>
276 <summary>🧪 Run backend & frontend manually (dev mode)</summary>
277
278 For local development and debugging. You can use Docker for MongoDB/Redis, or point to your own services.
279
280 #### 1. Start the backend services
281
282 ```bash
283 cd project/aitoearn-backend
284 pnpm install
285 # Copy config files for local development
286 cp apps/aitoearn-ai/config/config.yaml apps/aitoearn-ai/config/local.config.yaml
287 cp apps/aitoearn-server/config/config.yaml apps/aitoearn-server/config/local.config.yaml
288 pnpm nx serve aitoearn-ai
289 # in another terminal
290 pnpm nx serve aitoearn-server
291 ```
292
293 #### 2. Start the frontend `aitoearn-web`
294
295 ```bash
296 pnpm install
297 pnpm run dev
298 ```
299
300 </details>
301
302 <details>
303 <summary>🖥️ Start Electron desktop project</summary>
304
305 ```bash
306 # Clone the repo
307 git clone https://github.com/yikart/AttAiToEarn.git
308
309 # Enter directory
310 cd AttAiToEarn
311
312 # Install dependencies
313 npm install
314
315 # Compile sqlite (better-sqlite3 requires node-gyp and local Python)
316 npm run rebuild
317
318 # Start development
319 npm run dev
320 ```
321
322 The Electron project provides a desktop client for AiToEarn.
323
324 </details>
325
326 ## Contributing
327
328 Please see [Contributing Guide](./CONTRIBUTING.md) to get started.
329
330 ## Contact
331
332 If you run into usage difficulties, questions, or unexpected behavior, please open a [GitHub Issue](https://github.com/yikart/AiToEarn/issues) first so we can track and respond in one place.
333
334 - Telegram: [https://t.me/harryyyy2025](https://t.me/harryyyy2025)
335 - WeChat: Scan to add
336
337 <img src="presentation/wechat.jpg" alt="WeChat QR Code" width="200">
338
339 ## Recommended
340
341 - [MuseTalk](https://github.com/TMElyralab/MuseTalk)
342 - [video_spider](https://github.com/5ime/video_spider)
343 - [CosyVoice](https://github.com/FunAudioLLM/CosyVoice?tab=readme-ov-file)
344 - [facefusion](https://github.com/facefusion/facefusion)
345 - [NarratoAI](https://github.com/linyqh/NarratoAI)
346 - [MoneyPrinterTurbo](https://github.com/harry0703/MoneyPrinterTurbo)
347
347 lines MARKDOWN