mirror of
https://github.com/eigent-ai/eigent.git
synced 2026-05-05 15:30:48 +00:00
update readme
This commit is contained in:
CamelAIorg
parent
f6dd426830
commit
74c53d3c5c
18 changed files with 1006 additions and 591 deletions
|
|
@ -10,7 +10,7 @@ This guide will walk you through building your first multi-agent workforce using
|
|||
|
||||
Once opened, you'll land on the **Task** page. It’s a clean space designed to turn your ideas into action. Let's break down what you see.
|
||||
|
||||
|
||||
|
||||
|
||||
### The Top Bar
|
||||
|
||||
|
|
@ -21,7 +21,7 @@ At the very top of the window is your main navigation bar. You'll access:
|
|||
- Ongoing Tasks
|
||||
- **Settings:** where you can configure the app to your liking.
|
||||
|
||||
|
||||
|
||||
|
||||
### The Main View
|
||||
|
||||
|
|
@ -29,24 +29,22 @@ 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.
|
||||
|
||||
|
||||
|
||||
- You can pause anytime—hit **Pause**, edit via **Back to Edit**, then resume. When tasks complete, use **Replay** to re-run the flow.
|
||||
- You can pause anytime—hit **Pause**, edit via **Back to Edit**, then resume. When tasks complete, use **Replay** to re-run the flow.
|
||||
|
||||
**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.
|
||||
|
||||
|
||||
- **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**.
|
||||
|
||||
|
||||
|
||||
### 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.
|
||||
|
||||
|
||||
|
||||
<aside>
|
||||
|
||||
|
||||
|
||||
#### 📌 Note on File Storage
|
||||
|
|
@ -68,7 +66,7 @@ Eigent comes with four ready-to-work agents. Each is equipped with a specific se
|
|||
3. **Multimodal Agent** – ideals with images, videos and more
|
||||
4. **Document Agent** – reads, writes and manages files (Markdown, PDF, Word, etc.)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Add your own workers
|
||||
|
|
@ -79,7 +77,7 @@ Click **“+ Add Workers”**, provide:
|
|||
- **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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Start Your First Task
|
||||
|
|
@ -101,7 +99,7 @@ Once you send your task, our **Coordinator Agent** and **Task Agent** kick in to
|
|||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
## Watch Agents Work
|
||||
|
||||
|
|
@ -113,19 +111,19 @@ Once the task starts, your agents will run in parallel on the Canvas:
|
|||
- **Task Results:** The output or conclusion of the subtask.
|
||||
- Hover over tasks to see status details
|
||||
|
||||
|
||||
|
||||
|
||||
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
|
||||
|
||||
|
||||
|
||||
|
||||
- Example 2: open **Developer Agent**, lauch **Terminal**
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside>
|
||||
|
||||
|
|
@ -158,13 +156,13 @@ Click the gear icon in the top-right corner to open Settings. Here’s a brief o
|
|||
- **Language:** Choose between English, Simplified Chinese, or your System Default.
|
||||
- **Appearance:** Switch between Light mode. On macOS, a Transparent mode is also available.
|
||||
|
||||
|
||||
|
||||
|
||||
### **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.
|
||||
|
||||
|
||||
|
||||
|
||||
### **Models**
|
||||
|
||||
|
|
@ -176,7 +174,7 @@ Eigent can run in two modes. Your choice here affects how you are billed and wha
|
|||
|
||||
</aside>
|
||||
|
||||
|
||||
|
||||
|
||||
- **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.
|
||||
|
|
@ -189,16 +187,33 @@ Eigent can run in two modes. Your choice here affects how you are billed and wha
|
|||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
For advanced users, you can click **Add MCP Server** to configure and install custom tools from third-party sources.
|
||||
|
||||
|
||||
|
||||
|
||||
## Next Steps
|
||||
|
||||
Congratulations on running your first task! Here are some great next reads:
|
||||
Congratulations on running your first task! Here are a few recommended reads to deepen your understanding:
|
||||
|
||||
- **Key Concepts:** Get familiar with the terms we use, like Workforce, MCP, and more.
|
||||
- **Your Workforce:** Learn how to build and manage highly specialized custom agents.
|
||||
- **Models:** Discover how to connect your own local or cloud-based AI models.
|
||||
<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>
|
||||
Loading…
Add table
Add a link
Reference in a new issue