@samitouri / QOSami_Agents_Zero
Code Commits Issues Pulls Sessions CI/CD
main
main
md 60 lines 1.74 KB
Rendered Raw
1 # Plugins
2
3 Most people should start with the practical guide:
4 [Create a Small Plugin](../guides/create-plugin.md).
5
6 Plugin architecture and source-linked internals live in
7 [DeepWiki for Agent Zero](https://deepwiki.com/agent0ai/agent-zero). This page
8 stays intentionally small so the repository does not maintain a second plugin
9 manual.
10
11 ## What To Use
12
13 | Goal | Start here |
14 | --- | --- |
15 | Build your first plugin | [Create a Small Plugin](../guides/create-plugin.md) |
16 | Understand how plugins are loaded | [DeepWiki](https://deepwiki.com/agent0ai/agent-zero) |
17 | Decide what is safe to publish | [Sharing and Safety](sharing-and-safety.md) |
18 | Contribute a plugin upstream | [Contributing Guide](../guides/contribution.md) |
19
20 ## Minimum Local Plugin
21
22 A local plugin usually lives here:
23
24 ```text
25 /a0/usr/plugins/<plugin_name>/
26 ├── plugin.yaml
27 ├── README.md
28 └── webui/
29 ```
30
31 The smallest useful `plugin.yaml` looks like this:
32
33 ```yaml
34 name: my_plugin
35 title: My Plugin
36 description: A short sentence that explains what it does.
37 version: 1.0.0
38 ```
39
40 Ask Agent Zero to keep the first version small. A tiny plugin that does one
41 visible thing is easier to test, review, and share.
42
43 ## Sharing A Plugin
44
45 Before publishing a plugin:
46
47 - keep it in its own public repository;
48 - include a clear `README.md`;
49 - include a `LICENSE`;
50 - avoid secrets, local paths, and machine-specific files;
51 - explain what the plugin changes and how to remove it.
52
53 For Plugin Index submission, use the current instructions in the
54 [`agent0ai/a0-plugins`](https://github.com/agent0ai/a0-plugins) repository.
55
56 ## Related
57
58 - [Create a Small Plugin](../guides/create-plugin.md)
59 - [Sharing and Safety](sharing-and-safety.md)
60 - [DeepWiki for Agent Zero](https://deepwiki.com/agent0ai/agent-zero)