This repository contains the official ZoeAI plugins.
To install the plugins, simply place them in the backend/plugins/ folder and start the server.
wikipedia.py
Objective Search for articles on Wikipedia.
Functions:
| Function | Description |
|---|---|
search_wikipedia(query, lang, sentences, summary_only) |
Searches and returns content (summary or full) of articles. |
news.py
Objective Access latest news via NewsAPI.
Configuration
Add the API key to config.toml:
[tools]
news_api_key = "YOUR_KEY_HERE"Functions:
| Function | Description |
|---|---|
get_top_news(category, country) |
Gets the top news by category/country. |
search_news(...search parameters...) |
Advanced news search. |
get_available_sources(category, lang, country) |
Lists available news sources. |
system.py
Objective Interact with the file system and terminal.
Configuration (config.toml)
The following configuration is required to run the plugin:
[tools. terminal]
system_user = "zoe"
safe_mode = trueIf necessary, create a user
zoeto create an isolated environment or use your current user for convenience and better integration.
Functions:
| Function | Description |
|---|---|
list_directory(path) |
Lists the contents of a directory. |
list_directory_tree(path) |
Displays a directory tree structure. |
get_xdg_dirs() |
Gets the user's XDG directories. |
read_file(file_path) |
Reads the contents of a text file. |
read_pdf(file_path) |
Reads the textual content of a PDF. |
write_file(file_path, content) |
Writes content to a text file. |
run_command(command) |
Executes a terminal command. |
get_file_info(file_path) |
Gets information about a file/directory. |
create_directory(dir_path) |
Creates a new directory. |
run_python_script(script_path, args) |
Runs a Python script (requires safe_mode = false). |