readme + docs update
frdel committed
May 27, 2025 at 10:12 UTC
7a4946e5b5eb4be4d62f1619d252700f8979c97c
3 files changed
+23
-37
README.md
+9
-9
@@ -1,13 +1,12 @@
1
<div align="center">
2
3
-
4
-
3
# `Agent Zero`
4
7
-[](https://github.com/sponsors/frdel) [](https://x.com/Agent0ai) [](https://discord.gg/B8KZKNsPpj) [](https://www.youtube.com/@AgentZeroFW) [](https://www.linkedin.com/in/jan-tomasek/) [](https://warpcast.com/agent-zero)
8
-
5
+[](https://agent-zero.ai) [](https://github.com/sponsors/frdel) [](https://x.com/Agent0ai) [](https://discord.gg/B8KZKNsPpj) [](https://www.youtube.com/@AgentZeroFW) [](https://www.linkedin.com/in/jan-tomasek/) [](https://warpcast.com/agent-zero)
6
7
+[Introduction](#a-personal-organic-agentic-framework-that-grows-and-learns-with-you) •
8
[Installation](./docs/installation.md) •
9
+[Hacking Edition](#hacking-edition) •
10
[How to update](./docs/installation.md#how-to-update-agent-zero) •
11
[Documentation](./docs/README.md) •
12
[Usage](./docs/usage.md)
@@ -19,10 +18,6 @@
18
19
20
22
-See [www.agent-zero.ai](https://agent-zero.ai) for more info
23
-
24
-[](https://agent-zero.ai)
25
-
21
22
23
## A personal, organic agentic framework that grows and learns with you
@@ -87,11 +82,16 @@ See [www.agent-zero.ai](https://agent-zero.ai) for more info
82
83
- **Research** - `"Gather and summarize five recent AI papers about CoT prompting"`
84
85
+# Hacking Edition
86
+- Agent Zero also offers a Hacking Edition based on Kali linux with modified prompts for cybersecurity tasks
87
+- The setup is the same as the regular version, just use the frdel/agent-zero-run:hacking image instead of frdel/agent-zero-run
88
+
89
+
90
# ⚙️ Installation
91
92
Click to open a video to learn how to install Agent Zero:
93
94
-[](https://www.youtube.com/watch?v=cHDCCSr1YRI&t=24s)
94
+[](https://www.youtube.com/watch?v=L1_peV8szf8)
95
96
A detailed setup guide for Windows, macOS, and Linux with a video can be found in the Agent Zero Documentation at [this page](./docs/installation.md).
97
docs/installation.md
+14
-28
@@ -1,24 +1,14 @@
1
# Users installation guide for Windows, macOS and Linux
2
3
-[](https://www.youtube.com/watch?v=wWAqJpl3uQE)
3
+Click to open a video to learn how to install Agent Zero:
4
+
5
+[](https://www.youtube.com/watch?v=L1_peV8szf8)
6
7
The following user guide provides instructions for installing and running Agent Zero using Docker, which is the primary runtime environment for the framework. For developers and contributors, we also provide instructions for setting up the [full development environment](#in-depth-guide-for-full-binaries-installation).
8
7
-### Need updates from v0.7? 👉[How to update Agent Zero](#how-to-update-agent-zero)
9
10
## Windows, macOS and Linux Setup Guide
11
11
-### Prerequisites
12
-
13
-| Component | Minimum | Recommended |
14
-|-----------|---------|-------------|
15
-| RAM | 4GB | 8GB |
16
-| Storage | 10GB | 10GB |
17
-| CPU | 2 cores | 4 cores |
18
-| Docker | Required | Required |
19
-| Internet | Optional* | Required |
20
-
21
-Note*: Offline operation requires prompt adjustments
12
13
1. **Install Docker Desktop:**
14
- Docker Desktop provides the runtime environment for Agent Zero, ensuring consistent behavior and security across platforms
@@ -60,8 +50,6 @@ Note*: Offline operation requires prompt adjustments
50
<img src="res/setup/image-13.png" alt="docker installed" height="100"/>
51
<br><br>
52
63
-1.5. Create a Docker Hub account when prompted and sign in. This is required to pull the Agent Zero container image.
64
-
53
> [!IMPORTANT]
54
> **macOS Configuration:** In Docker Desktop's preferences (Docker menu) → Settings →
55
> Advanced, enable "Allow the default Docker socket to be used (requires password)."
@@ -70,6 +58,8 @@ Note*: Offline operation requires prompt adjustments
58
59
2. **Run Agent Zero:**
60
61
+- Note: Agent Zero also offers a Hacking Edition based on Kali linux with modified prompts for cybersecurity tasks. The setup is the same as the regular version, just use the frdel/agent-zero-run:hacking image instead of frdel/agent-zero-run.
62
+
63
2.1. Pull the Agent Zero Docker image:
64
- Search for `frdel/agent-zero-run` in Docker Desktop
65
- Click the `Pull` button
@@ -105,6 +95,8 @@ Note*: Offline operation requires prompt adjustments
95
- Click the `Run` button next to the `frdel/agent-zero-run` image
96
- Open the "Optional settings" menu
97
- Set the port to `0` in the second "Host port" field (for automatic port assignment)
98
+
99
+Optionally you can map local folders for file persistence:
100
- Under "Volumes", configure:
101
- Host path: Your chosen directory (e.g., `C:\agent-zero-data`)
102
- Container path: `/a0`
@@ -304,27 +296,21 @@ For developers or users who need to run Agent Zero directly on their system,see
296
297
# How to update Agent Zero
298
307
-1. **If you come from the previous version of Agent Zero (pre-0.7.1):**
299
+1. **If you come from the previous version of Agent Zero:**
300
- Your data is safely stored across various directories and files inside the Agent Zero folder.
309
-- To update to the new Docker runtime version, you need to save the following files and directories:
301
+- To update to the new Docker runtime version, you might want to backup the following files and directories:
302
- `/memory` - Agent's memory
311
- - `/knowledge` - Custom knowledge base
312
- - `/instruments` - Custom instruments and functions
313
- - `/prompts` - Custom prompts files (if any has been created)
314
- - `/work_dir` - Working directory
315
- - `.env` - Your API keys
303
+ - `/knowledge` - Custom knowledge base (if you imported any custom knowledge files)
304
+ - `/instruments` - Custom instruments and functions (if you created any custom)
305
- `/tmp/settings.json` - Your Agent Zero settings
306
+ - `/tmp/chats/` - Your chat history
307
- Once you have saved these files and directories, you can proceed with the Docker runtime [installation instructions above](#windows-macos-and-linux-setup-guide) setup guide.
308
- Reach for the folder where you saved your data and copy it to the new Agent Zero folder set during the installation process.
309
- Agent Zero will automatically detect your saved data and use it across memory, knowledge, instruments, prompts and settings.
310
311
> [!IMPORTANT]
322
-> Make sure to use the same embedding model you were using before, otherwise
323
-> you will have to re-index all of Agent Zero's memory, therefore deleting all
324
-> your custom knowledge and memory.
325
->
326
-> If you have issues loading your settings, you can try to delete the `/tmp/settings.json`
327
-> file and let Agent Zero generate a new one.
312
+> If you have issues loading your settings, you can try to delete the `/tmp/settings.json` file and let Agent Zero generate a new one.
313
+> The same goes for chats in `/tmp/chats/`, they might be incompatible with the new version
314
315
2. **Update Process (Docker Desktop)**
316
- Go to Docker Desktop and stop the container from the "Containers" tab
docs/res/easy_ins_vid.png
Binary files /dev/null and b/docs/res/easy_ins_vid.png differ