@@ -3,119 +3,151 @@ title: "Import Agents"
33description : " Learn how to import new agents to BeeAI"
44---
55
6- BeeAI provides multiple ways to work with agents in your local environment. This guide explains how to add and manage agents effectively.
6+ BeeAI provides multiple ways to add agents to your platform. This guide explains each method and when to use them.
7+
8+ ## Prerequisite
9+
10+ ### Docker Setup
11+
12+ Most import methods require Docker to be running:
13+ - ** macOS:** Install Docker Desktop or Rancher Desktop
14+ - ** Linux:** Install Docker Engine and QEMU
15+ - ** Windows:** Install Docker Desktop
16+
17+ ## Quick Start
18+
19+ Just want to get started? Try importing a ready-made agent:
20+
21+ ``` bash
22+ beeai add https://github.com/i-am-bee/beeai-platform-agent-starter.git
23+ ```
24+
25+ ## How It Works
26+
27+ BeeAI discovers and runs agents automatically using the Agent Communication Protocol (ACP). When you add an agent:
28+ 1 . ** Auto-discovery:** Agents running locally are automatically detected
29+ 2 . ** Containerization:** Remote agents are built into Docker containers
30+ 3 . ** Registration:** All agents appear in both CLI and web interface
731
832## Adding Agents
933
10- ### Auto-Discovery for Local Development
34+ ### Local Development (Recommended for Development)
1135
12- When developing ACP-compliant agents locally, BeeAI automatically discovers them without manual setup :
36+ When building ACP-compliant agents locally, BeeAI automatically discovers them:
1337
1438``` bash
15- # Example: Run an ACP agent on port 8000
39+ # Start your agent server
1640uv run my_agent.py
1741
18- # The agent automatically appears in BeeAI
19- beeai list # Your agent will be visible here
42+ # Your agent automatically appears in BeeAI
43+ beeai list # Shows your local agent
2044```
2145
22- <Info >
23- Auto-discovered agents appear in both the CLI and web UI automatically. No manual import needed!
24- </Info >
46+ Benefits:
47+ - Instant feedback during development
48+ - No build process needed
49+ - Changes reflected immediately
50+
51+ Requirements:
52+ - Agent must implement ACP protocol
53+ - Must be running on accessible port
2554
2655### From GitHub Repositories
2756
28- Import agents directly from GitHub repositories that contain proper Dockerfiles . Try this ready - to - go starter project :
57+ Import agents directly from public GitHub repositories :
2958
3059``` bash
31- beeai add " https://github.com/i-am-bee/beeai-platform-agent-starter "
32- ```
60+ # Basic import
61+ beeai add " https://github.com/username/my-agent.git "
3362
34- More import options:
63+ # With specific version
64+ beeai add " https://github.com/username/my-agent.git#v1.0.0"
3565
36- ``` bash
37- # Specify a version or branch
38- beeai add " https://github.com/i-am-bee/custom-agent.git#v1.0.0"
39- beeai add " https://github.com/i-am-bee/custom-agent.git#develop"
66+ # With specific branch
67+ beeai add " https://github.com/username/my-agent.git#develop"
4068
41- # Import from specific subdirectory
42- beeai add " https://github.com/i-am-bee/custom -agent.git#:agents/my-agent"
69+ # From subdirectory
70+ beeai add " https://github.com/username/my -agent.git#:agents/my-agent"
4371
4472# Combined version and path
45- beeai add " https://github.com/i-am-bee /multi-agent-repo.git#v2.1.0:agents/specialized-agent"
73+ beeai add " https://github.com/username /multi-agent-repo.git#v2.1.0:agents/specialized-agent"
4674```
4775
48- <Note >
49- ** Requirements for GitHub import:**
50- - Repository must contain a ` Dockerfile ` in the root or specified path
51- - Agent must follow ACP protocol standards
52- - Repository must be publicly accessible
53- </Note >
76+ Requirements:
77+ - Repository must contain a Dockerfile
78+ - Agent must follow ACP protocol
79+ - Repository must be publicly accessible
80+ - Docker must be running locally
5481
55- ### From Docker Images
82+ ### From Local Filesystem
5683
57- Add agents from pre-built Docker images :
84+ Build and add agents from your local machine :
5885
5986``` bash
60- # From GitHub Container Registry
61- beeai add ghcr.io/i-am-bee/beeai-platform/community/aider:latest
62-
63- # From Docker Hub
64- beeai add myuser/my-agent:v1.0
87+ # Add from current directory
88+ beeai add .
6589
66- # From private registry
67- beeai add registry.example.com/team/custom -agent:latest
90+ # Add from specific directory
91+ beeai add /path/to/my -agent
6892```
6993
70- ### From Local Filesystem
94+ ** For advanced users: ** If you need more control over the build process:
7195
72- Add local agents:
7396``` bash
74- # Build an add an agent from current directory
75- beeai add .
97+ # Build only (for testing)
98+ beeai build /path/to/my-agent --no-import
7699
77- # Build an add an agent from specific directory
78- beeai add /path/to/my-agent
100+ # Build with custom tag
101+ beeai build . --tag my-custom-agent:dev
102+
103+ # Add the built image separately
104+ beeai add beeai.local/my-agent-hash:latest
79105```
80106
81- This will build the agent and add it to your agent list.
107+ Requirements:
108+ - Directory must contain a Dockerfile
109+ - Docker must be running locally
82110
83- If the command above is failing, or you only need to build the agent image, you can run the steps separately:
111+ ### From Docker Images
112+
113+ Add pre-built Docker images:
84114
85115``` bash
86- # Build agent only
87- beeai build /path/to/my-agent
116+ # From GitHub Container Registry
117+ beeai add ghcr.io/i-am-bee/beeai-platform/community/aider:latest
88118
89- # Build with custom tag
90- beeai build . --tag my-custom- agent:dev
119+ # From Docker Hub
120+ beeai add myuser/ my-agent:v1.0
91121
92- # Build without importing (for testing)
93- beeai build . --no-import
122+ # From private registry
123+ beeai add registry.example.com/team/custom-agent:latest
94124```
95125
96- After a successful build you'll get a message like
97- ` ✅ Successfully built agent: beeai.local/path-to-my-agent-db09b8:latest ` , you can add this image to the platform
98- by ` beeai add beeai.local/path-to-my-agent-db09b8:latest `
126+ ## Managing Agents
99127
128+ ### Check Agent Status
100129
101- ## Removing Agents
130+ ``` bash
131+ beeai list
132+ ```
133+
134+ Shows all agents with their status, location, and any configuration issues.
102135
103- When you no longer need an agent:
136+ ### Remove Agents
104137
105138``` bash
106- # Remove by agent name
107139beeai remove < agent-name>
108140
109- # Alternative commands (aliases)
141+ # Alternative commands
110142beeai uninstall < agent-name>
111143beeai delete < agent-name>
112144beeai rm < agent-name>
113145```
114146
115- ## Checking Agent Status
116-
117- You can check the status of your agents at any time:
147+ ### Get Agent Details
118148
119149``` bash
120- beeai list
150+ beeai info < agent-name >
121151```
152+
153+ Shows documentation, capabilities, and configuration options.
0 commit comments