<h1 align="center">
🦛 HippoX
</h1>
<h4 align="center">
A reliable AI agent engine.
A skill-driven AI agent engine that automatically loads and executes skills simply by writing a `SKILL.md` file to describe them. It is not bound to any frontend—CLI, TCP, HTTP, and WebSocket can all be used.
</h4>
<p align="center">
<a href="https://github.com/0xhappyboy/hippo/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache2.0-d1d1f6.svg?style=flat&labelColor=1C2C2E&color=BEC5C9&logo=googledocs&label=license&logoColor=BEC5C9" alt="License"></a>
</p>
<p align="center">
<a href="./README_zh-CN.md">简体ä¸æ–‡</a> | <a href="./README.md">English</a>
</p>
## Basic Usage
```rust
tracing_subscriber::fmt().init();
i18n::init();
.unwrap_or(true),
enable_tcp: env::var("HIPPO_ENABLE_TCP")
.unwrap_or_else(|_| "false".to_string())
.parse::<bool>()
.unwrap_or(false),
enable_http: env::var("HIPPO_ENABLE_HTTP")
.unwrap_or_else(|_| "false".to_string())
.parse::<bool>()
.unwrap_or(false),
enable_websocket: env::var("HIPPO_ENABLE_WS")
.unwrap_or_else(|_| "false".to_string())
.parse::<bool>()
.unwrap_or(false),
enable_grpc: false,
};
hippox.start(config).await?;
```
## SKill Scheduling Model
<img src="./resources/scheduler_en.png" width="100%">
## Atomic Skill List
| mysql_query | Execute SELECT query on MySQL database | query (string, required), params (array), limit (integer) | database |
| mysql_execute | Execute INSERT/UPDATE/DELETE on MySQL | query (string, required), params (array) | database |
| mysql_list_tables | List all tables in MySQL database | none | database |
| postgres_query | Execute SELECT query on PostgreSQL database | query (string, required), params (array), limit (integer) | database |
| postgres_execute | Execute INSERT/UPDATE/DELETE on PostgreSQL | query (string, required), params (array) | database |
| postgres_list_tables | List all tables in PostgreSQL database | schema (string) | database |
| redis_set | Set a key-value pair in Redis | key (string, required), value (string, required), ttl (integer) | database |
| redis_get | Get a value from Redis by key | key (string, required) | database |
| redis_del | Delete a key from Redis | key (string, required) | database |
| redis_keys | Find keys matching a pattern in Redis | pattern (string) | database |
| redis_hset | Set a field in a Redis hash | key (string, required), field (string, required), value (string, required) | database |
| redis_hget | Get a field from a Redis hash | key (string, required), field (string, required) | database |
| sqlite_query | Execute SELECT query on SQLite database | query (string, required), params (array), limit (integer) | database |
| sqlite_execute | Execute INSERT/UPDATE/DELETE on SQLite | query (string, required), params (array) | database |
| sqlite_list_tables | List all tables in SQLite database | none | database |
| github_get_repo | Get information about a GitHub repository | owner (string, required), repo (string, required) | github |
| github_create_issue | Create an issue in a GitHub repository | owner, repo, title (required), body, labels | github |
| github_list_issues | List issues from a GitHub repository | owner, repo, state, limit | github |
| github_star_repo | Star a GitHub repository | owner (required), repo (required) | github |
| github_search_repos | Search GitHub repositories by query | query (required), limit | github |
| github_get_user | Get GitHub user information | username (required) | github |
| github_list_prs | List pull requests from a GitHub repository | owner, repo, state, limit | github |
| csv_read | Read and parse CSV file content | path (required), has_header, delimiter, limit | document |
| csv_write | Write structured data to a CSV file | path (required), headers (required), rows (required), delimiter | document |
| excel_read | Read data from Excel (.xlsx) files | path (required), sheet, has_header, limit | document |
| excel_write | Write data to Excel (.xlsx) files | path (required), headers (required), rows (required), sheet_name | document |
| markdown_read | Read and parse Markdown file content | path (required), extract_frontmatter | document |
| markdown_write | Write or generate Markdown content to a file | path (required), content (required), append | document |
| xml_parse | Parse XML content from a file or string | source (required), is_path, xpath | document |
| xml_to_json | Convert XML content to JSON format | source (required), is_path, pretty | document |
| file_copy | Copy or move a file | source (required), destination (required), move | file |
| file_delete | Delete a file or empty directory | path (required), recursive | file |
| file_list | List contents of a directory | path (required), show_hidden, detail | file |
| file_read | Read content from a file | path (required), max_size | file |
| file_write | Write content to a file | path (required), content (required), append | file |
| calculator | Evaluate mathematical expressions | expression (required), precision | math |
| unit_converter | Convert between different units of measurement | value (required), from (required), to (required), precision | math |
| math_power | Calculate power, square root, or cube root | base, exponent, sqrt, cbrt, precision | math |
| math_statistics | Calculate statistical values from a number set | numbers (required), operation (required), precision | math |
| send_dingding | Send a message via DingDing robot | text (required), at_mobiles, at_all, msg_type, title | messaging |
| send_email | Send an email via SMTP server | to (required), subject (required), body (required), from, cc, bcc, is_html | messaging |
| send_feishu | Send a message via Feishu (Lark) bot | text, msg_type, title, content, image_key, at_mobiles, at_all | messaging |
| send_telegram | Send a message via Telegram Bot | chat_id (required), text (required), parse_mode, disable_notification | messaging |
| send_wecom | Send a message via WeCom (Enterprise WeChat) | text (required), msg_type, mentioned_list, mentioned_mobile_list | messaging |
| ftp_upload | Upload a file to FTP server | host, port, username, password, local_path (required), remote_path, mode | net |
| ftp_download | Download a file from FTP server | host, port, username, password, remote_path (required), local_path (required), mode | net |
| ftp_list | List directory contents on FTP server | host, port, username, password, directory | net |
| ftp_delete | Delete a file from FTP server | host, port, username, password, remote_path (required) | net |
| http_request | Send HTTP requests to web APIs | url (required), method, headers, body, timeout | net |
| read_url | Fetch and read content from a URL | url (required), method, headers, timeout, max_size, raw | net |
| tcp_send | Send data over TCP connection | host, port, data (required), encoding, timeout, delimiter, wait_response | net |
| tcp_receive | Receive data from TCP connection (server mode) | port (required), bind_address, buffer_size, timeout, encoding, send_response | net |
| udp_send | Send data over UDP | host, port, data (required), encoding, timeout | net |
| udp_receive | Receive UDP datagram | port (required), bind_address, buffer_size, timeout, encoding, send_response | net |
| udp_broadcast | Send UDP broadcast message | port (required), data (required), encoding, timeout | net |
| exec_command | Execute a system command | command, args, timeout, working_dir, env | system |
| system_info | Get system information (OS, CPU, memory, disk) | info_type | system |
| datetime | Get current date/time or convert timezone | operation, timezone, format | time |
## Envs
| HIPPOX_LANG | Language setting | en | zh, en |
| HIPPOX_PROVIDER | LLM provider | openai | openai, deepseek, anthropic, google |
| HIPPOX_ENABLE_CLI | Enable CLI interface | true | true, false |
| HIPPOX_ENABLE_TCP | Enable TCP server | false | true, false |
| HIPPOX_ENABLE_HTTP | Enable HTTP server | false | true, false |
| HIPPOX_ENABLE_WS | Enable WebSocket server | false | true, false |
| HIPPOX_SMTP_HOST | SMTP server hostname | None | smtp.gmail.com |
| HIPPOX_SMTP_PORT | SMTP server port | 587 | 465, 587 |
| HIPPOX_SMTP_USERNAME | SMTP authentication username | None | your@gmail.com |
| HIPPOX_SMTP_PASSWORD | SMTP authentication password | None | your eamil password |
| HIPPOX_SMTP_FROM | Default sender email address | None | bot@example.com |
| HIPPOX_TELEGRAM_BOT_TOKEN | Telegram Bot Token | None | 1234567890:xxxxxxxxxxxxxxxx |
| HIPPOX_DINGDING_ACCESS_TOKEN | dingding robot web hook token | None | 钉钉web hook token |
## Supported Protocols
| CLI | Terminal interaction |
| TCP | 127.0.0.1:8080 |
| HTTP | http://127.0.0.1:8081 |
| WebSocket | ws://127.0.0.1:8082 |
## Environment Variables
| HIPPO_LANG | en | Language setting (en/zh) |
| HIPPO_LLM_PROVIDER_KEY | None | LLM provider (openai/deepseek/anthropic/google) |
| HIPPO_ENABLE_CLI | true | Enable CLI interface |
| HIPPO_ENABLE_TCP | false | Enable TCP server on 127.0.0.1:8080 |
| HIPPO_ENABLE_HTTP | false | Enable HTTP server on http://127.0.0.1:8081 |
| HIPPO_ENABLE_WS | false | Enable WebSocket server on ws://127.0.0.1:8082 |