init
Some checks failed
Remove old artifacts / remove-old-artifacts (push) Has been cancelled

This commit is contained in:
wol
2025-08-04 00:20:29 +08:00
commit 03f2c49b7e
1173 changed files with 102921 additions and 0 deletions

61
docs/core/concepts.md Normal file
View File

@@ -0,0 +1,61 @@
---
title: "Concepts"
description: "Understand the core terms and features that make Eigent unique."
icon: "key"
---
## Workers
Autonomous agents tailored to specific roles that run tasks independently or together. Think of them as individual members of your team, like a "Researcher," a "Programmer," or a "Writer."
Each Worker is designed with specific capabilities and can be customized to handle particular types of tasks efficiently.
![Workers concept illustration](/docs/images/concepts_worker.png)
## Workforce
A coordinated team of Workers that collaborate to complete complex workflows. Think of it as your AI project team.
The Workforce orchestrates multiple Workers, ensuring they work together seamlessly to achieve your goals.
![Workforce collaboration illustration](/docs/images/concepts_workforce.gif)
## Workspace
A live window into a Worker's process where you can watch or take control. For example, a terminal, a browser, or a file viewer.
Workspaces provide real-time visibility into what your Workers are doing, allowing you to monitor progress and intervene when needed.
![Workspace interface illustration](/docs/images/concepts_workspace.gif)
## Tasks & Subtasks
You define a mission (task), the Workforce breaks it into components (subtasks), and assigns them to the appropriate Workers.
This hierarchical approach ensures complex projects are broken down into manageable pieces and executed efficiently.
![Tasks and subtasks breakdown illustration](/docs/images/concepts_tasks_subtasks.gif)
## Chat
Your primary interface for communicating with your Workforce. You use it to define your main Task, sharing files and interacting with agents in real time.
The Chat interface serves as your command center, where you can give instructions, ask questions, and receive updates from your AI team.
![Chat interface illustration](/docs/images/concepts_chat.png)
## MCP
Model Context Protocol that allows Workers to use external tools. It connects your agents to databases, APIs, and documentation sources, empowering them to act across platforms.
MCP extends your Workers' capabilities by providing access to real-world data and tools, making them more powerful and versatile.
![MCP protocol illustration](/docs/images/concepts_mcp.png)
## Models
Different AI "brains" that power your Workers. Eigent allows you to choose from various models (like GPT-4.1 or Gemini 2.5 Pro), each with different strengths in speed, reasoning, and cost.
Choose the right model for each task based on your specific needs for performance, accuracy, or cost efficiency.
![AI models illustration](/docs/images/concepts_models.png)

91
docs/core/models.md Normal file
View File

@@ -0,0 +1,91 @@
---
title: Models
description: Configure and deploy your preferred LLM models with Eigent.
icon: server
---
Eigent supports flexible integration and deployment of top LLMs and multimodal models. You can follow the steps below to set up your preferred LLM models.
1. Click Settings
![click_settings](/docs/images/models_settings.png)
2. Close Eigent Cloud Version
![close_eigent](/docs/images/models_close.png)
3. Configure your APIKEY and Model Type
![configure_api](/docs/images/models_configure_models.png)
4. Configure the Google Search toolkit
![configure_searchtools](/docs/images/models_configure_tools.png)
![configure_searchtoolsapi](/docs/images/models_configure_tools_key.png)
You can refer to the following document for detailed information on how to configure **GOOGLE_API_KEY** and **SEARCH_ENGINE_ID :** https://developers.google.com/custom-search/v1/overview
Nowstart enjoying Eigent
## **Self-Host Model**
1. Configure your self-host model
First, you need to set up your local models and expose them as an **OpenAI-Compatible Server.**
```bash
#Vllm https://docs.vllm.ai/en/latest/getting_started/quickstart.html#openai-compatible-server
vllm serve Qwen/Qwen2.5-1.5B-Instruct
```
```python
#Sglang https://docs.sglang.ai/backend/openai_api_completions.html
from sglang.test.test_utils import is_in_ci
if is_in_ci():
from patch import launch_server_cmd
else:
from sglang.utils import launch_server_cmd
from sglang.utils import wait_for_server, print_highlight, terminate_process
server_process, port = launch_server_cmd(
"python3 -m sglang.launch_server --model-path qwen/qwen2.5-0.5b-instruct --host 0.0.0.0 --mem-fraction-static 0.8"
)
wait_for_server(f"http://localhost:{port}")
print(f"Server started on http://localhost:{port}")
```
```bash
#Ollama https://github.com/ollama/ollama
ollama pull qwen2.5:7b
```
2. Setting your model
![set_local_model](/docs/images/models_local_model.png)
3. Configure the Google Search toolkit
![configure_searchtools](/docs/images/models_configure_tools.png)
![configure_searchtoolsapi](/docs/images/models_configure_tools_key.png)
You can refer to the following document for detailed information on how to configure **GOOGLE_API_KEY** and **SEARCH_ENGINE_ID :** https://developers.google.com/custom-search/v1/overview
## **API KEY Reference**
Gemini: https://ai.google.dev/gemini-api/docs/api-key
OpenAI: https://platform.openai.com/api-keys
Anthropic: https://console.anthropic.com/
Qwen:https://www.alibabacloud.com/help/en/model-studio/get-api-key
Deepseek: https://platform.deepseek.com/api_keys
AWS Bedrock:https://github.com/aws-samples/bedrock-access-gateway/blob/main/README.md
Azure:https://azure.microsoft.com/products/cognitive-services/openai-service/

29
docs/core/tools.md Normal file
View File

@@ -0,0 +1,29 @@
---
title: Tools
description: Extend Eigent with MCP servers and tools
icon: plug
---
**Add your MCP server**
**You can follow the steps below to set up your model**
1. Click Settings
![click_settings](/docs/images/models_settings.png)
2. Click Add MCP Server
![add_mcp](/docs/images/tools_add_mcp.png)
3. Configure Your MCP Server and install
![configure_mcp](/docs/images/tools_configure_mcp.png)
4.Add external servers to your own Agent
- You can check the installed mcp server in the Added external servers column
![check_mcp](/docs/images/tools_check.png)
- After configuring your mcp server, you can add it to a Custom Agent.

216
docs/core/workforce.md Normal file
View File

@@ -0,0 +1,216 @@
---
title: Workforce
description: Understand core concepts and features that power Eigent.
icon: cubes
---
## Concept: What is a Workforce?
Workforce is CAMEL-AI's multi-agent teamwork engine.
Instead of relying on a single agent, Workforce lets you organize a *team* of specialized agents—each with its own strengths—under a single, coordinated system. You can quickly assemble, configure, and launch collaborative agent "workforces" for any task that needs parallelization, diverse expertise, or complex workflows.
With Workforce, agents plan, solve, and verify work together—like a project team in an organization, but fully automated.
<aside>
**📌 Key advantages of Workforce:**
- Instantly scale from single-agent to multi-agent workflows
- Built-in coordination, planning, and failure recovery
- Ideal for hackathons, evaluations, code review, brainstorming, and more
- Configure roles, toolsets, and communication patterns for *any* scenario
</aside>
## System Design
### **Architecture: How Workforce Works**
Workforce uses a **hierarchical, modular design** for real-world team problem-solving.
![Workforce](/docs/images/workforce.jpg)
See how the coordinator and task planner agents orchestrate a multi-agent workflow:
- **Workforce:** The “team” as a whole.
- **Worker nodes:** Individual contributors—each node can contain one or more agents, each with their own capabilities.
- **Coordinator agent:** The “project manager”—routes tasks to worker nodes based on their role and skills.
- **Task planner agent:** The “strategy lead”—breaks down big jobs into smaller, doable subtasks and organizes the workflow.
### **Communication: A Shared Task Channel**
Every Workforce gets a **shared task channel** when its created.
**How it works:**
- All tasks are posted into this channel.
- Worker nodes “listen” and accept their assigned tasks.
- Results are posted back to the channel, where theyre available as dependencies for the next steps.
*This design lets agents build on each others work and ensures no knowledge is lost between steps.*
### **Failure Handling: Built-In Robustness**
Workforce is designed to handle failures and recover gracefully.
If a worker fails a task, the coordinator agent will:
- **Decompose and retry:** Break the task into even smaller pieces and reassign.
- **Escalate:** If the task keeps failing, create a new worker designed for that problem.
To prevent infinite loops, if a task has failed or been decomposed more than a set number of times (default: 3), Workforce will automatically halt that workflow.
<aside>
**📌 Tip:** Workforce automatically stops stuck workflows—so you dont waste compute or get caught in agent loops!
</aside>
## Worker Nodes
Eigent comes with a set of pre-configured agents, each designed for a specific domain of expertise. These agents are equipped with a curated set of toolkits to make them effective right out of the box.
### DeveloperAgent
*A skilled coding assistant that can write and execute code, run terminal commands, and verify solutions to complete tasks.*
**Equipped Toolkits:**
- HumanToolkit
- TerminalToolkit
- NoteTakingToolkit
- WebDeployToolkit
### SearchAgent
*Can search the web, extract webpage content, simulate browser actions, and provide relevant information to solve the given task.*
**Equipped Toolkits:**
- SearchToolkit
- HybridBrowserToolkit
- HumanToolkit
- NoteTakingToolkit
- TerminalToolkit
### DocumentAgent
*A document processing assistant for creating, modifying, and managing various document formats, including presentations.*
**Equipped Toolkits:**
- FileWriteToolkit
- PPTXToolkit
- HumanToolkit
- MarkItDownToolkit
- ExcelToolkit
- NoteTakingToolkit
- TerminalToolkit
- GoogleDriveMCPToolkit
- SearchToolkit
### Multi-ModalAgent
*A multi-modal processing assistant for analyzing and generating media content like audio and images.*
**Equipped Toolkits:**
- VideoDownloaderToolkit
- AudioAnalysisToolkit
- ImageAnalysisToolkit
- OpenAIImageToolkit
- HumanToolkit
- TerminalToolkit
- NoteTakingToolkit
- SearchToolkit
## Toolkit Reference
Toolkits are the collections of functions that give your agents their powers. Here is a reference for the toolkits used by the pre-configured agents.
*(in alphabetical order)*
### [AudioAnalysisToolkit](https://docs.camel-ai.org/reference/camel.toolkits.audio_analysis_toolkit)
*Provides tools for audio processing and analysis.*
This toolkit allows an agent to process audio files. It can take an audio file (from a local path or URL) and transcribe the speech into text. It can also answer specific questions about the content of an audio file, enabling agents to extract information from podcasts, meetings, or voice notes.
### [ExcelToolkit](https://docs.camel-ai.org/reference/camel.toolkits.excel_toolkit)
*Enables agents to create, read, and manipulate Excel spreadsheets.*
This toolkit provides comprehensive functions for interacting with Excel files (`.xlsx/.xls/. csv`). Agents can create new workbooks, add or delete worksheets, read data from specific cells or ranges, write data to the spreadsheet, and convert data into Markdown formatted table.
### [FileWriteToolkit](https://docs.camel-ai.org/reference/camel.toolkits.file_write_toolkit)
*A toolkit for creating, writing, and modifying text in files.*
This toolkit gives an agent the ability to create and write to files on the local file system (macOS, Linux, Windows). It provides support for writing to various file formats (Markdown, DOCX, PDF, and plaintext), replacing text in existing files, automatic filename uniquification to prevent overwrites, custom encoding and enhanced formatting options for specialized formats.
### [GoogleDriveMCPToolkit](https://docs.camel-ai.org/reference/camel.toolkits.google_drive_mcp_toolkit)
*Connects to Google Drive to manage files and folders.*
This toolkit allows agents to interact with a user's Google Drive. It can read files and folders from Google Drive. It acts as a bridge between the agent's local environment and cloud storage.
### [HumanToolkit](https://docs.camel-ai.org/reference/camel.toolkits.human_toolkit)
*Allows an agent to pause its task and ask the user for help.*
This is a critical toolkit for handling situations that require human intervention. When an agent is stuck, needs credentials, or requires a subjective decision, it can use this toolkit to send a prompt to the user and wait for a response before continuing its task.
### [HybridBrowserToolkit](https://docs.camel-ai.org/reference/camel.toolkits.hybrid_browser_toolkit.ws_wrapper)
*Provides a powerful, stateful browser for web navigation and interaction.*
This toolkit gives an agent a fully-featured web browser that it can control programmatically. Unlike simple web scraping, this toolkit maintains a session, allowing the agent to click, type, hover, screenshot, and live *Take Control* from the UI.
### [ImageAnalysisToolkit](https://docs.camel-ai.org/reference/camel.toolkits.image_analysis_toolkit)
*Provides tools for understanding the content of images.*
This toolkit enables an agent to "see" and interpret images. It can generate a detailed text description of an image or answer specific questions about what an image contains. This is crucial for tasks that involve visual data, such as describing products, analyzing charts, or identifying objects in a photo.
### [MarkItDownToolkit](https://docs.camel-ai.org/reference/camel.toolkits.markitdown_toolkit)
*A specialized toolkit for converting content into clean Markdown.*
This toolkit is designed to scrape content from a list of local files and convert each into a structured Markdown format. The conversion is performed in parallel for efficiency. Supported file formats include: PDF, Office, EPUB, HTML, Images (ORC), Audio, Text, ZIP.
### [NoteTakingToolkit](https://docs.camel-ai.org/reference/camel.toolkits.note_taking_toolkit)
*A toolkit for managing and interacting with Markdown note files.*
This toolkit provides tools for creating, reading, appending to, and listing notes. All notes are stored as **`.md`** files in a dedicated working directory and are tracked in a registry. An agent can use it to write down any important information. Other agents can then read these notes to get context and build upon previous work, facilitating effective collaboration.
### [OpenAIImageToolkit](https://docs.camel-ai.org/reference/camel.toolkits.openai_image_toolkit)
*Generates images from text prompts using OpenAI's DALL-E models.*
This toolkit allows an agent to create new images based on a descriptive text prompt. It leverages models like DALL-E 3 to generate high-quality visuals, which can then be saved locally. This is essential for creative tasks, generating illustrations for documents, or any workflow requiring original image content.
### [PPTXToolkit](https://docs.camel-ai.org/reference/camel.toolkits.pptx_toolkit)
*Enables agents to create and write Microsoft PowerPoint presentations.*
This toolkit provides a suite of functions for building PowerPoint (`.pptx`) files. An agent can create a new presentation, add title and content slides, format text, create lists, and insert tables and images. It allows for the automated creation of professional-looking presentations.
### [SearchToolkit](https://docs.camel-ai.org/reference/camel.toolkits.search_toolkit)
*Provides access to various web search engines.*
This toolkit is the primary tool for web research. It allows an agent to search information on engines like Google, Wikipedia, Bing, and Baidu. The agent can submit a query and receive a list of relevant URLs and snippets, which it can then use as a starting point for deeper investigation with the `HybridBrowserToolkit`.
### [TerminalToolkit](https://docs.camel-ai.org/reference/camel.toolkits.terminal_toolkit)
*A toolkit for terminal operations across multiple operating systems.*
This toolkit gives an agent access to a command-line interface. It supports terminal operations such as searching for files by name or content, executing shell commands, and managing terminal sessions.
### [VideoDownloaderToolkit](https://docs.camel-ai.org/reference/camel.toolkits.video_download_toolkit)
*Allows an agent to download and process videos from popular platforms.*
This toolkit enables an agent to download video content from URLs (e.g., from YouTube) and optionally split them into chunks. The saved video can then be analyzed by other toolkits, such as the `AudioAnalysisToolkit` for transcription, or `ImageAnalysisToolkit` for object detection.
### [WebDeployToolkit](https://docs.camel-ai.org/reference/camel.toolkits.web_deploy_toolkit)
*Provides tools to deploy web content on a local server.*
This toolkit allows the `DeveloperAgent` to instantly host web applications or static files. It can serve a single HTML file or an entire folder (like a built React app) on a local port, making it easy to preview and test web development work.

92
docs/docs.json Normal file
View File

@@ -0,0 +1,92 @@
{
"$schema": "https://mintlify.com/docs.json",
"name": "Eigent Documentation",
"theme": "aspen",
"defaultPage": "/get_started/welcome",
"logo": {
"light": "images/logo-light.png",
"dark": "images/logo-dark.png",
"href": "https://www.eigent.ai"
},
"favicon": "images/favicon.png",
"colors": {
"primary": "#1d1d1d",
"light": "#F5F4F0",
"dark": "#363AF5"
},
"background": {
"color": {
"light": "#F5F4F0",
"dark": "#1d1d1d"
}
},
"styling": {
"logo": {
"width": "auto",
"height": "100%"
}
},
"navbar": {
"links": [
{
"icon": "github",
"label": "GitHub",
"href": "https://github.com/eigent-ai/eigent"
}
],
"primary": {
"type": "button",
"label": "Get Started",
"href": "https://www.eigent.ai/download"
}
},
"navigation": {
"tabs": [
{
"tab": "Documentation",
"groups": [
{
"group": "Get Started",
"pages": [
"/get_started/welcome",
"/get_started/installation",
"/get_started/quick_start"
]
},
{
"group": "Core",
"pages": [
"/core/concepts",
"/core/workforce",
"/core/models",
"/core/tools"
]
},
{
"group": "Troubleshooting",
"pages": [
"/troubleshooting/support",
"/troubleshooting/bug"
]
}
]
}
],
"global": {
"anchors": [
{
"anchor": "Download Here",
"href": "https://www.eigent.ai",
"icon": "gift"
}
]
}
},
"footer": {
"socials": {
"github": "https://github.com/eigent-ai/eigent",
"twitter": "https://x.com/Eigent-AI",
"linkedin": "https://www.linkedin.com/company/eigent-ai/"
}
}
}

View File

@@ -0,0 +1,49 @@
---
title: Installation
description: Getting Eigent set up on your computer is simple. Follow these steps to begin.
icon: wrench
---
<Steps>
<Step title="Download Eigent">
Head to our official website to download the latest version.
- Download for macOS
- Download for Windows
<Warning>
**macOS Prerequisite**
Please ensure you are running macOS 11 (Big Sur) or a newer version to install Eigent.
</Warning>
</Step>
<Step title="Install the Application">
- **On macOS:** Open the downloaded `.dmg` file and drag the Eigent icon into your Applications folder.
- **On Windows:** Run the downloaded `.exe` installer and follow the on-screen instructions.
</Step>
</Steps>
Once installed, launch Eigent and log in to get started!
## Next Steps
You're all set! Now that Eigent is installed, here are a few places you can go to learn more:
<CardGroup>
<Card
title="Quick Start"
icon="rocket"
href="/get_started/quick_start">
Jump right in and learn how to launch your first task.
</Card>
<Card
title="Key Concepts"
icon="key"
href="/core/concepts">
Understand the core terms and features that make Eigent unique.
</Card>
<Card
title="Support"
icon="question-circle"
href="/troubleshooting/support">
Find answers to frequently asked questions.
</Card>
</CardGroup>

View File

@@ -0,0 +1,219 @@
---
title: Quick Start
description: Get started with Eigent in just a few minutes!
icon: rocket
---
This guide will walk you through building your first multi-agent workforce using Eigent.
## Create Your First Task
Once opened, you'll land on the **Task** page. Its a clean space designed to turn your ideas into action. Let's break down what you see.
![Layout](/docs/images/quickstart_firsttask.png)
### The Top Bar
At the very top of the window is your main navigation bar. You'll access:
- **Dashboard**: your home base for creating and viewing History and Ongoing tasks.
- Project Archives: a detailed log of all your past tasks, including the token usage.
- Ongoing Tasks
- **Settings:** where you can configure the app to your liking.
![Task Hub](/docs/images/quickstart_thetopbar.png)
### The Main View
Your workspace is split into two panels:
**Message Box (Left):** where you'll chat with your AI workforce to start a job.
- Before running the task, you can Add, Edit, or Delete any subtask or Back to Edit your request, then resume. When tasks complete, you can use Replay to re-run the flow.
![Message](/docs/images/quickstart_themainview.gif)
- You can pause anytime—hit **Pause**, edit via **Back to Edit**, then resume. When tasks complete, use **Replay** to re-run the flow.![Message 2](/docs/images/quickstart_pause.gif)
**Canvas (Right):** where your AI agents get to work.
- **Before a Task:** You'll see your pre-built agents and and their tools. You can also click **+ New Worker** to add your own. These workers will always be on standby for your task.
- **During a Task:** The Canvas shows the live status of all subtasks (`Done / In Progress / Unfinished`). Click any subtask to view detailed logs (reasoning steps, tool calls, results). More on this below.
![Task in Progress](/docs/images/quickstart_canvas_inprogress.png)
- **Canvas Toolbar:** At the bottom of the Canvas, you'll see a toolbar. This is where you manage your views of agents. You can switch between different task views, such as **Home**, **Agent Folder**, or a specific worker's **Workspace**.
![Add Worker](/docs/images/quickstart_canvas_bottom.png)
### Agent Folder
This is the filing cabinet for your workforce. Any files your agents create or use (like documents, spreadsheets, code, pictures, or presentations) are automatically saved here. These files are also stored locally on your computer and/or in your cloud for easy access.
![Agent Folder](/docs/images/quickstart_agentfolder.png)
#### 📌 Note on File Storage
You can always find your task files in a dedicated folder on your machine.
- **Windows:** `C:\Users\[YourUsername]\eigent\[YourEmailPrefix]\task_[TaskID]`
- **Mac:** `/Users/[YourUsername]/eigent/[YourEmailPrefix]/task_[TaskID]`
Cloud version users: outputs are also saved in your cloud workspace according to your subscription tier. Visit the Support page for more details.
### Pre-built Agents
Eigent comes with four ready-to-work agents. Each is equipped with a specific set of tools and shines at specific tasks—click to explore:
1. **Developer Agent** writes, debugs and executes code
2. **Search Agent** fetches and gathers info from the web
3. **Multimodal Agent** ideals with images, videos and more
4. **Document Agent** reads, writes and manages files (Markdown, PDF, Word, etc.)
![Pre-build Agents](/docs/images/quickstart_prebuiltagents.gif)
### Add your own workers
Click **“+ Add Workers”**, provide:
- **Name** (required)
- **Description** (optional): the role of your customized agent
- **Agent Tool**: install any tool available from our MCP Servers to give your agent the exact skills it needs.
![Add Your Own Workers](/docs/images/quickstart_addworker.gif)
## Start Your First Task
Now that you have a workforce, let's put it to work.
### Step 1: Define Your Goal
Type your task in the top Message Box. Be as descriptive as you like. For example, ask Eigent to conduct an UK healthcare market research . You can attach files (like docs, data, images) by clicking the **paperclip icon** in the Message Box.Then, hit **Send**.
### Step 2: Review Subtask Flow
Once you send your task, our **Coordinator Agent** and **Task Agent** kick in to break it into subtasks. Youll see:
- **Workforce CoT Box**: shows agents “Chain-of-Thought.” This tells you *how* the AI interpreted your request and its reasoning path.
- **Task Status Box**: displays subtasks with controls. You can **add**, **edit**, or **delete** any subtask to make sure the plan is perfect. If you're not happy with the plan, just click **"Back to edit"** to refine your initial request.
### Step 3: Lauch the Task
Once you're happy with the plan, hit **Start Task.** Eigent will automatically assign each subtask to the best agent for the job based on the tools they have.
![Launch the Task](/docs/images/quickstart_lauchtask.gif)
## Watch Agents Work
Once the task starts, your agents will run in parallel on the Canvas:
- Click a subtask to view logs:
- **Reasoning Steps:** The agent's logic for how it's approaching the subtask.
- **Tool Calls:** Which specific tool the agent is using (e.g., `search_google`, `load_files`).
- **Task Results:** The output or conclusion of the subtask.
- Hover over tasks to see status details
![Watch Agents Work](/docs/images/quickstart_subtasklog.gif)
Click on an agent icon to open its **Workspace**:
- Example 1: open **Search Agent**, launch embedded browser
- Use **“Take Control”** to take over browsing (e.g., accept cookies), then return control to the agent
![Search Agent](/docs/images/quickstart_takecontrol.gif)
- Example 2: open **Developer Agent**, lauch **Terminal**
![Developer Agent](/docs/images/quickstart_terminal.gif)
<aside>
** 📌 Tip: Managing Your View**
You can customize your monitoring experience easily. Workspace toolbar includes scroll, full-screen, and layout toggles (single/dual pane).
</aside>
### **Human in the Loop**
Sometimes, an agent may needs your input to proceed with the subtask (e.g., confirmation or extra data). In this case, a request will pop up in the **Message Box**. Simply type your response and send it.
<aside>
**⚠️ Note on Timeouts**
The agent will wait for your input. If you don't respond within **30 seconds**, the task will automatically continue, potentially with incomplete information.
</aside>
## A Quick Tour of Settings
Click the gear icon in the top-right corner to open Settings. Heres a brief overview.
### **General**
- **Account:** Manage your subscription or log out.
- **Language:** Choose between English, Simplified Chinese, or your System Default.
- **Appearance:** Switch between Light mode. On macOS, a Transparent mode is also available.
![General](/docs/images/quickstart_settings_general.png)
### **Privacy**
Your privacy is important to us! Because Eigent agents operate on your desktop, they may need permissions to take screenshots or access local files to complete tasks. You can enable and manage all these permissions here.
![Privacy](/docs/images/quickstart_settings_privacy.png)
### **Models**
<aside>
**⚠️ Important: Cloud vs. Self-hosted**
Eigent can run in two modes. Your choice here affects how you are billed and what models are available.
</aside>
![Models](/docs/images/quickstart_settings_localmodel.png)
- **Cloud Version:** We provide pre-configured, state-of-the-art models, including GPT-4.1, GPT-4.1 mini and Gemini 2.5 Pro. Using these models is the easiest way to get started and will be billed to your account based on usage (credits).
- **Self-hosted Version:** You can connect your own models.
- **Cloud Models:** Connect your personal accounts from providers like OpenAI, Anthropic, Qwen, Deepseek and Azure by entering your own API key.
- **Local Models:** For advanced users, you can run models locally using Ollama, vLLM, or SGLang.
### **MCP Servers**
MCPs are the **tools** that give your agents their skills. We've pre-configured popular tools like Slack, Notion, Google Calendar, GitHub, and more in **MCP Market**, which you can install for your agents with a single click.
![MCP Markets](/docs/images/quickstart_settings_mcp.png)
For advanced users, you can click **Add MCP Server** to configure and install custom tools from third-party sources.
![MCP Servers](/docs/images/quickstart_settings_addmcp.png)
## Next Steps
Congratulations on running your first task! Here are a few recommended reads to deepen your understanding:
<CardGroup>
<Card
title="Key Concepts"
icon="key"
href="/core/concepts">
Get familiar with the terms we use, like Workforce, MCP, and more.
</Card>
<Card
title="Your Workforce"
icon="cubes"
href="/core/workforce">
Learn how to build and manage highly specialized custom agents.
</Card>
<Card
title="Models"
icon="server"
href="/core/models">
Discover how to connect your own local or cloud-based AI models.
</Card>
</CardGroup>

View File

@@ -0,0 +1,52 @@
---
title: Welcome
description: Learn about Eigent and Unlock Your Exceptional Productivity now
icon: wave
---
**Eigent** is the worlds first **Multi-agent Workforce** desktop application, empowering you to build, manage, and deploy a custom AI workforce that can turn your most complex workflows into automated tasks.
Built on CAMEL-AI's acclaimed open-source project (CAMEL with 13k⭐ on GitHub, #1 on GitHub Daily Trending), our system introduces a **Multi-Agent Workforce** that **boosts productivity** through parallel execution, customization, and privacy protection. Previously #1 opensource project on GAIA.
<img
src="/docs/images/thumbnail.png"
alt="Dynamic Workforce"
width="100%"
height="auto"
/>
## Core Features and Capabilities
<CardGroup>
<Card
title="Build Your Own Workforce"
icon="cubes">
Customize your AI “workers” (agents) according to your industry or personal workflow needs. You have full control to create specialized Worker nodes with domain-specific skills and toolkits, assembling a workforce tailored to you.
</Card>
<Card
title="Dynamic Multi-Agent Collaboration"
icon="people-group">
Eigent dynamically breaks down tasks and activates multiple agents to work **in parallel**, automating complex tasks much faster than traditional single-agent sequential workflows. This parallelism accelerates execution and handles flexible, multi-step scenarios with ease.
</Card>
<Card
title="Human-in-the-Loop"
icon="hand-pointer">
If a task gets stuck or encounters uncertainty, Eigent will automatically request human input. This safety net ensures critical decisions or errors are handled with human oversight, improving reliability.
</Card>
<Card
title="MCP Tools Integration (MCP)"
icon="plug">
Eigent comes with over 200 built-in **Model Context Protocol (MCP)** tools (for web browsing, code execution, etc.), and also lets you **install your own tools**. Equip agents with exactly the right tools for your scenarios even integrate internal APIs or custom functions to enhance their capabilities.
</Card>
<Card
title="100% Open Source"
icon="unlock">
Eigent is completely open-sourced. You can download, inspect, and modify the code, ensuring transparency and fostering a community-driven ecosystem for multi-agent innovation.
</Card>
<Card
title="Local Model Support"
icon="server">
Deploy Eigent locally with your preferred models. Your data stays on **your own device**, addressing privacy and security concerns. You can use personal API keys or local LLMs so that sensitive information never leaves your environment.
</Card>
</CardGroup>

View File

@@ -0,0 +1,57 @@
---
title: Bug
description: "Follow these simple steps to report bugs and help improve our product for everyone:"
---
<img
src="/docs/images/bug_report.gif"
alt="Bug Report"
width="100%"
height="auto"
/>
### Step 1: Access the Bug Report Feature
1. Locate the **Bug Report** button in the top section of the desktop interface, positioned to the right of your project name
2. Click the **Bug Report** button to initiate the reporting process
### Step 2: Download Log Files
- Upon clicking the Bug Report button, log files will be automatically downloaded to your device
- These log files contain technical information that helps our development team diagnose issues more effectively
### Step 3: Complete the Bug Report Form
- A bug report web form will automatically open in your default browser
- Please provide the following information:
- **Bug Description**: Write a clear description of the issue you encountered
- **Screenshot Upload**: Attach relevant screenshots that demonstrate the problem
- **Log File Upload**: Upload the log files that were downloaded in Step 2
### Step 4: Join Our Community for Real-time Support
### For English-speaking Users:
- Join our **CAMEL-AI Discord** **🤖eigent** channel : https://discord.gg/HgSesTVC for bug discussions and community support
- Get direct assistance from our team and community members
### For Chinese-speaking Users:
- Add our WeChat assistant: **CamelAIOrg** to join the **bug fix group** for Chinese community support
- Communicate with our Chinese-speaking support team
### Alternative: GitHub Issues
Developers and technical users are welcome to report issues directly through our GitHub issues:
- **Repository URL**: https://github.com/eigent-ai/eigent
- Submit detailed issues with reproduction steps
## Important Notes
- Always include log files when reporting bugs for faster resolution
- Provide as much detail as possible in your bug description
- Screenshots help our team understand visual issues more quickly
- Our community channels provide the fastest response times for urgent issues
Thank you for helping us improve our product through your feedback and bug reports!

View File

@@ -0,0 +1,93 @@
---
title: Support
description: Find answers to frequently asked questions.
---
For account and billing questions, email our support team at [info@eigent.ai](mailto:info@eigent.ai).
Eigent offers flexible plans for every type of user, from individuals to large enterprises. Our services are divided into two main categories: Cloud and Self-Hosted.
### Cloud Service
Our Cloud Service is a subscription-based offering that gives you access to Eigent's powerful AI models and infrastructure without any setup.
- **Free:** Perfect for getting started. Includes **500 Credits** per month.
- **Plus:** For more frequent users. Includes **2,000 Credits** per month.
- **Pro:** For power users who need advanced capabilities. Includes **10,000 Credits** per month.
- **Add-On Packs:** If you run out of Credits, you can purchase an Add-On Pack at any time to top up your account.
> *Credits never expire within the billing cycle and you can topup at any time.*
>
> *Unused Credits from your monthly plan allowance do not roll over to the next month.*
> *Credits from Add-On Packages will carry over to subsequent billing cycles.*
>
>
> *See your Credits Usage directly in Settings Account [Manage](https://www.eigent.ai/dashboard).*
>
### Self-Hosted Service
For users who require more control, privacy, and customization, we offer self-hosted solutions. To view more open-source information, please visit [GitHub](https://github.com/eigent-ai/eigent).
- **Free:** Designed for individual users, open-source developers, small teams, or non-commercial projects. This plan requires you to host your own models and provide your own API keys.
- **Scalable:** Ideal for teams requiring enhanced reliability and support. This plan also allows for logo and brand customization.
- **Custom:** A bespoke solution for enterprise clients with specific needs for features, support, security and control.
For inquiries about our Scalable and Custom plans, please please refer to our [**License**](https://github.com/eigent-ai/eigent) or email us at **info@eigent.ai**.
## Credits & Billing
### How Credits work?
- 1USD=100Credits for topups.
- Credits are the currency you use to power your tasks in Eigent's Cloud Service. Every action that uses our cloud service consumes Credits.
### Free Credits and Trials
- New signups get **1000** bonus Credits.
- To reward active users, we grant **200** Credits every day you use the app. Unused amounts dont roll over to the next day.
- All paid subscription plans (Plus and Pro) come with a **7-day free trial**. You can cancel anytime within this period at no charge.
### **Upgrading or Toppingup**
- Click **User** icon in the Eigent webpage.
- Click **Account Settings** to open your personal account page.
- Click **Upgrade** to move to a higher tier with more monthly Credits.
- Click **+ Add Credits** to purchase an Add-On Pack when you've used up your monthly allowance.
![Support Dashboard](/docs/images/support_dashboard.png)
### Invitation Code
Just below your plan card youll see your exclusive invitation code. Share it with a friend! Both of you automatically receive **500Credits** once they register.
### Credits Usage
Scroll to credits usage dashboard to view:
- **Total Credits**: Your current available balance.
- **Daily Refreshed Credits:** Your 200Credit daily bonus countdown. These daily credits are used first before your main balance is touched.
- **Credits History:** This is a log of all transactions on your account. You can see how Credits were added (e.g., `monthly`, `invite`, `register`) and how they were spent (`consume`).
**Note on Balance**
Your balance is calculated based on the total credits added minus the total consumed within your current billing cycle.
If your balance becomes negative, it will be displayed as **0**. This means your service may be restricted until new Credits are added to your account.
### Billing Cycle and Cancellations
- For free users, your monthly cycle starts on the date you registered. For subscribers, it starts on the date of your first successful subscription.
- Daily active credits are used first (no rollover), followed by monthly pack credits (no rollover to next month), and finally, top-up pack credits (which don't expire).
- You can cancel any subscription or Add-On Pack purchase within 7 days for a full refund.
- Plan resets to Free and billing cycle resets to registration date.
- Credits balance recomputed according to Freetier rules.
- How do I cancel my subscription? Please contact **infot@eigent.ai.**
- You can download invoices from the payment confirmation email sent to your registered email address.
For any questions about your bill or account status, email us anytime at [info@eigent.ai](mailto:info@eigent.ai).