返回 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 ## Special Thanks ❤️
19
20 <table align="center">
21 <tr>
22 <td align="center" width="120">
23 <a href="https://metaso.cn/minimax-h3/?s=ATE"><img src="docs/sponsors/metaso-logo.png" alt="Metaso" width="100"></a><br>
24 <a href="https://metaso.cn/minimax-h3/?s=ATE"><strong>Metaso</strong></a>
25 </td>
26 <td align="left">
27 Thanks to <a href="https://metaso.cn/minimax-h3/?s=ATE">Metaso</a> for sponsoring this project!<br>
28 <strong>MiniMax H3 Video Generation API | Metaso</strong><br>
29 Metaso offers cost-effective MiniMax H3 video generation: <strong>768P for just RMB 0.09/sec and 2K for just RMB 0.15/sec</strong>. It supports native 2K and synchronized audio and video; its API is compatible with the <strong>OpenAI protocol</strong>, and it also supports <strong>ComfyUI</strong>—no GPU deployment required.<br>
30 🎁 Sign up through the <a href="https://metaso.cn/minimax-h3/?s=ATE">exclusive AiToEarn link</a> to receive complimentary credits and special offers.<br>
31 For business inquiries, please add WeChat: metasota12
32 </td>
33 </tr>
34 <tr>
35 <td align="center" width="120">
36 <a href="https://go.apimart.ai/gh-aitoearn"><img src="docs/sponsors/apimart-logo.png" alt="APIMart" width="100"></a><br>
37 <a href="https://go.apimart.ai/gh-aitoearn"><strong>APIMart</strong></a>
38 </td>
39 <td align="left">
40 Thanks to APIMart for sponsoring this project! APIMart is a low-cost API platform for AI image &amp; video generation — GPT-Image-2 from <strong>$0.006/image</strong>, <strong>160+ images per dollar</strong>. One async API covers both image and video: submit a task, get an ID, fetch results via polling or callback. Batch tens of thousands of images without timeouts, switch models without changing code. Pay-as-you-go with no monthly fee — <a href="https://go.apimart.ai/gh-aitoearn">sign up here</a> to get started.
41 </td>
42 </tr>
43 </table>
44
45 ## 🚀 Quick Start with AiToEarn (5 Ways)
46
47 | Option | Best for | Deployment needed? |
48 |--------|----------|-------------------|
49 | [① Use the Website](#use-web) | Everyone | ❌ No |
50 | [② Use in OpenClaw](#use-in-openclaw) | OpenClaw users | ❌ No |
51 | [③ Use in Claude / Cursor / Other AI Assistants](#use-in-claude) | AI tool users | ❌ No |
52 | [④ Docker One-Click Deploy](#use-docker) | Teams wanting self-hosted | ✅ Server needed |
53 | [⑤ Build from Source](#use-source) | Developers | ✅ Dev environment needed |
54
55 > 💡 **Options ②③④ require an API Key first.** See [How to Get an API Key](#get-api-key).
56
57 ## What's New
58
59 - **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; also introduced the [Open Platform](https://docs.aitoearn.cn/).
60 - **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.
61 - **2026-04-20**: OpenClaw now supports AiToEarn earning workflows, so you can receive and execute monetization tasks directly inside OpenClaw.
62 - **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.
63 - **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.
64 - **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)
65 - **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)
66 - **2025-11-12**: The first open-source, fully usable version. [v1.3.2](https://github.com/yikart/AiToEarn/releases/tag/v1.3.2)
67 - **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)
68 - **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)
69
70 <details>
71 <summary><h2 style="display:inline;margin:0">Table of Contents</h2></summary>
72
73 <br/>
74
75 1. [Quick Start with AiToEarn (5 Ways)](#-quick-start-with-aitoearn-5-ways)
76 2. [What's New](#whats-new)
77 3. [Key Features](#key-features)
78 4. [How to Get an API Key](#get-api-key)
79 5. [Contributing](#contributing)
80 6. [Contact](#contact)
81 7. [Recommended](#recommended)
82 </details>
83
84 ## Key Features
85
86 AiToEarn provides four core Agent capabilities around the creator's full monetization pipeline:
87
88 > **Monetize · Publish · Engage · Create**
89
90 ---
91
92 ### 💰 Monetize — Earn from Your Content
93
94 The core mission of AiToEarn: **help every creator earn money**.
95
96 Creators can sell content on the platform to complete brand promotion tasks. All settlements are results-driven, with three models:
97
98 | Model | Full Name | Meaning |
99 |-------|-----------|---------|
100 | **CPS** | Cost Per Sale | Settle by transaction amount |
101 | **CPE** | Cost Per Engagement | Settle by engagement count |
102 | **CPM** | Cost Per Mille | Settle by view count |
103
104 <img src="presentation/monetize-cn.png" width="30%">
105
106 ---
107
108 ### 📢 Publish — Content Publishing Agent
109
110 Distribute content to 10+ major platforms worldwide with one click — no more manual posting on each platform.
111
112 - **Multi-Platform Distribution**: Douyin, Kwai, Bilibili, Rednote, WeChat Channels, WeChat Official Accounts, TikTok, YouTube, Facebook, Instagram, Threads, X (Twitter), Pinterest, LinkedIn
113 - **Calendar Scheduler**: Plan and coordinate content publishing across all platforms like a calendar
114
115 <img src="presentation/publish-cn.png" width="30%"> <img src="presentation/channel-cn.png" width="30%">
116
117 > ▶ Watch Demo Video
118
119 <a href="https://www.youtube.com/watch?v=5041jEKaiU8">
120 <img src="https://img.youtube.com/vi/5041jEKaiU8/0.jpg" alt="Publish Demo Video" width="480">
121 </a>
122
123 ---
124
125 ### 💬 Engage — Content Engagement Agent
126
127 Automate engagement operations across all supported platforms via the AiToEarn browser extension.
128
129 - **Automated Actions**: Auto-like, bookmark, and follow — batch operations at scale
130 - **AI Smart Replies**: Use LLMs to generate targeted replies for each comment
131 - **Comment Mining**: Detect high-conversion signals like "link please" or "how to buy" and respond instantly
132 - **Brand Monitoring**: Track brand mentions in real-time and proactively join trending conversations
133
134 > ▶ Watch Demo Video
135
136 <a href="https://youtu.be/-QoHNrZBmp0">
137 <img src="./presentation/engage-thumbnail-cn.png" alt="Engage Demo Video" width="480">
138 </a>
139
140 ---
141
142 ### 🎨 Create — Content Creation Agent
143
144 We've rebuilt the content creation workflow with Agents. Just tell the Agent what you need — it handles everything from idea to finished product.
145
146 **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.
147
148 **Image & Text Content**: Supports top-tier image models like Nano Banana to create high-quality visual content automatically.
149
150 **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.
151
152 > ▶ Watch Demo Video
153
154 <a href="https://youtu.be/y900LxIrZT4">
155 <img src="./presentation/display-1.5.2png.png" alt="Create Demo Video" width="480">
156 </a>
157
158 ---
159
160 <h2 id="use-web">① Use the Website</h2>
161
162 The simplest way — just open your browser:
163
164 - 🇨🇳 China users: **[aitoearn.cn](https://aitoearn.cn/)**
165 - 🌍 International users: **[aitoearn.ai](https://aitoearn.ai/)**
166
167 ---
168
169 <h2 id="get-api-key">🔑 How to Get an API Key (Required for Steps Below)</h2>
170
171 > Options ②③④ all need an API Key. You only need to get it once.
172
173 **3 steps**:
174
175 1. Open [aitoearn.cn](https://aitoearn.cn/) (China) or [aitoearn.ai](https://aitoearn.ai/) (international), sign up and log in
176 2. Click **Settings** in the left menu
177 3. Go to **API Key**, click Create, and copy the generated key
178
179 <img src="presentation/app-screenshot/0.%20api-key/api-key-settings.png" alt="Get API Key" width="600">
180
181 > ⚠️ Keep your API Key safe. Do not share it with others.
182
183 ---
184
185 <h2 id="use-in-openclaw">② Use in OpenClaw</h2>
186
187 > Prerequisite: [Get an API Key](#get-api-key) first
188
189 **Install the plugin**
190
191 ```bash
192 npx -y @aitoearn/openclaw-plugin-cli
193 ```
194
195 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.
196
197 After setup, you can receive and execute AiToEarn earning tasks directly inside OpenClaw:
198
199 <img src="presentation/openclaw-earn-demo.png" alt="Run AiToEarn earning tasks in OpenClaw" width="360">
200
201 ---
202
203 <h2 id="use-in-claude">③ Use in Claude / Cursor / Other AI Assistants</h2>
204
205 > Prerequisite: [Get an API Key](#get-api-key) first
206
207 AiToEarn works with any MCP-compatible AI assistant. Here's how to configure the most popular ones:
208
209 Choose the URL that matches your API Key. A mismatched environment and key returns 401:
210
211 | Environment | MCP URL | SSE URL |
212 |-------------|---------|---------|
213 | China | `https://aitoearn.cn/api/unified/mcp` | `https://aitoearn.cn/api/unified/sse` |
214 | International | `https://aitoearn.ai/api/unified/mcp` | `https://aitoearn.ai/api/unified/sse` |
215
216 <details open>
217 <summary><b>Claude Desktop</b></summary>
218
219 Find and edit `claude_desktop_config.json`, add:
220
221 ```json
222 {
223 "mcpServers": {
224 "aitoearn": {
225 "type": "http",
226 "url": "https://aitoearn.ai/api/unified/mcp",
227 "headers": {
228 "x-api-key": "your-api-key"
229 }
230 }
231 }
232 }
233 ```
234
235 </details>
236
237 <details>
238 <summary><b>Cursor</b></summary>
239
240 In Cursor's MCP settings, add:
241
242 ```
243 MCP URL: https://aitoearn.ai/api/unified/mcp
244 Auth Header: x-api-key: your-api-key
245 ```
246
247 </details>
248
249 <details>
250 <summary><b>Other AI Assistants (Generic Config)</b></summary>
251
252 Any MCP-compatible tool just needs two pieces of info:
253
254 | Setting | Value |
255 |---------|-------|
256 | **MCP URL** | `https://aitoearn.ai/api/unified/mcp` |
257 | **Auth Header** | `x-api-key: your-api-key` |
258
259 SSE transport is also available: `https://aitoearn.ai/api/unified/sse`
260
261 </details>
262
263 > 💡 For self-hosted instances, replace `aitoearn.ai` with your own address (e.g., `localhost:8080`).
264
265 ---
266
267 <h2 id="use-docker">④ Docker One-Click Deploy</h2>
268
269 > Prerequisite: [Docker](https://docs.docker.com/get-docker/) installed
270
271 For teams wanting to run AiToEarn on their own server. 3 commands, no manual database setup:
272
273 ```bash
274 git clone https://github.com/yikart/AiToEarn.git
275 cd AiToEarn
276 docker compose up -d
277 ```
278
279 Open **[http://localhost:8080](http://localhost:8080)** and you're ready to go.
280
281 #### Configure Relay (Strongly Recommended)
282
283 > **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**.
284
285 Open the deployed UI in your browser, go to **Configuration**, and configure these sections as needed:
286
287 - **Server → Relay**: for content publishing and social platform OAuth authorization.
288 - **AI → Relay**: for using AI models provided by the platform.
289
290 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**.
291
292 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.
293
294 After saving, click **Save and restart** so the corresponding service reloads the configuration.
295
296 > 📖 Full deployment guide (production config, AI services, OAuth, storage, etc.): [DOCKER_DEPLOYMENT_EN.md](DOCKER_DEPLOYMENT_EN.md).
297
298 ---
299
300 <h2 id="use-source">⑤ Build from Source</h2>
301
302 <details>
303 <summary>🧪 Run backend & frontend manually (dev mode)</summary>
304
305 For local development and debugging. You can use Docker for MongoDB/Redis, or point to your own services.
306
307 #### 1. Start the backend services
308
309 ```bash
310 cd project/aitoearn-backend
311 pnpm install
312 # Copy config files for local development
313 cp apps/aitoearn-ai/config/config.yaml apps/aitoearn-ai/config/local.config.yaml
314 cp apps/aitoearn-server/config/config.yaml apps/aitoearn-server/config/local.config.yaml
315 pnpm nx serve aitoearn-ai
316 # in another terminal
317 pnpm nx serve aitoearn-server
318 ```
319
320 #### 2. Start the frontend `aitoearn-web`
321
322 ```bash
323 pnpm install
324 pnpm run dev
325 ```
326
327 </details>
328
329 <details>
330 <summary>🖥️ Start Electron desktop project</summary>
331
332 ```bash
333 # Clone the repo
334 git clone https://github.com/yikart/AttAiToEarn.git
335
336 # Enter directory
337 cd AttAiToEarn
338
339 # Install dependencies
340 npm install
341
342 # Compile sqlite (better-sqlite3 requires node-gyp and local Python)
343 npm run rebuild
344
345 # Start development
346 npm run dev
347 ```
348
349 The Electron project provides a desktop client for AiToEarn.
350
351 </details>
352
353 ## Contributing
354
355 Please see [Contributing Guide](./CONTRIBUTING.md) to get started.
356
357 ## Contact
358
359 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.
360
361 - Telegram: [https://t.me/harryyyy2025](https://t.me/harryyyy2025)
362 - WeChat: Scan to add
363
364 <img src="presentation/wechat.jpg" alt="WeChat QR Code" width="200">
365
366 ## Recommended
367
368 - [MuseTalk](https://github.com/TMElyralab/MuseTalk)
369 - [video_spider](https://github.com/5ime/video_spider)
370 - [CosyVoice](https://github.com/FunAudioLLM/CosyVoice?tab=readme-ov-file)
371 - [facefusion](https://github.com/facefusion/facefusion)
372 - [NarratoAI](https://github.com/linyqh/NarratoAI)
373 - [MoneyPrinterTurbo](https://github.com/harry0703/MoneyPrinterTurbo)
374
374 lines MARKDOWN