docs.rs failed to build hippox-0.4.6
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build:
hippox-0.3.9
🔗 Quick Links
| Resource | Link |
|---|---|
| 🌐 Website | https://hippox.vercel.app/ |
| 📖 Documentation | https://hippox-docs-en.vercel.app/ |
| 📦 Crates.io | https://crates.io/crates/hippox |
| 💻 GitHub | https://github.com/0xhappyboy/hippo |
Hippox Core Working Principle
How skill loaders and schedulers work
Architectural Layering
┌─────────────────────────────────────────────────────────────┐
│ User Layer │
│ handle_natural_language() │
│ handle_skill_md() │
└─────────────────────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────┐
│ Workflow Layer │
│ WorkflowExecutor (ReAct / Batch / Chain / PlanAndExecute) │
└─────────────────────────────────────────────────────────────┘
│
▼
┌──────────────────────────────────────────────────────────────┐
│ Scheduling Layer │
│ SkillScheduler (LLM Interaction, Skill Selection, Fallback)│
└──────────────────────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────┐
│ Execution Layer │
│ Executor (Parse LLM Response, Route to Skills) │
└─────────────────────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────┐
│ Registry Layer │
│ Registry (Skill Registration, Instance Configs) │
└─────────────────────────────────────────────────────────────┘
Data Stream
1. Initialize Hippox
├── Load configuration (instance configs)
├── Generate skills_registry (cached)
├── Generate instances_registry (cached)
└── Generate welcome_message (cached)
2. First Conversation
├── is_first_message = false → true
├── Send welcome_message (includes both registries)
└── LLM knows all skills and instances
3. Subsequent Conversations
├── is_first_message = true → no longer sent
└── Reuse cached registries
Workflow Model
| Mode | Enum Value | Core Features | LLM Calls | Use Cases |
|---|---|---|---|---|
| ReAct | WorkflowMode::ReAct | Think → Act → Observe loop, LLM decides next step after each execution | 1 per skill + 1 final response | Open-ended tasks, dynamic decision making, error recovery |
| Batch | WorkflowMode::Batch | Execute multiple independent skills in parallel | 1 (generates batch plan) | Independent operations, bulk processing |
| Chain | WorkflowMode::Chain | Sequential execution with variable passing ({{variable}} syntax) | 1 (generates chain) | Linear pipelines, data transformation chains |
| PlanAndExecute | WorkflowMode::PlanAndExecute | One-time planning with conditional branching, variable references ({"$ref":"var"}), error handling (retry/skip/fail) | 1 plan + optional dynamic decisions | Complex workflows, conditional logic, deterministic tasks |
Atomic Skill Unit List
| Category | Skills | Description |
|---|---|---|
| File System | 5 skills | Read, write, delete, list, copy files |
| Archive | 5 skills | Create/extract ZIP/TAR archives, compress files |
| Math | 4 skills | Expression calculator, power/root, statistics, unit conversion |
| Crypto/Random | 10 skills | MD5, SHA256, SHA512, file hash, Base64 encode/decode, random number/string/uuid/password |
| Time | 1 skill | Get current date/time |
| Network | 20 skills | HTTP requests, URL fetch, ICMP/TCP/batch ping, DNS lookup/reverse/batch/test, IP info/validate/range/local, TCP/UDP send/receive/broadcast, FTP upload/download/list/delete |
| OS Management | 18 skills | Reboot, shutdown, sleep, lock, logout, hibernate, uptime, load average, hostname, time, user info, disk/memory/CPU/network/battery info, desktop notification |
| Process | 6 skills | List, kill (by PID/name), check running, get PID, detailed process info |
| System | 7 skills | System info, exec command, port scan/lookup/test, clipboard get/set/clear |
| Document | 11 skills | Markdown, CSV, XML, Excel, PDF read/write/parse |
| Messaging | 5 skills | Email, Telegram, DingTalk, Feishu, WeCom |
| Database | 12 skills | PostgreSQL, MySQL, Redis, SQLite query/execute/list |
| Text Processing | 4 skills | Diff, sort, deduplicate, filter |
| Regex | 4 skills | Match, find, replace, extract |
| K8s | 18 skills | Pod/deployment/service/node/namespace/event/configmap/secret/ingress/statefulset management, logs, exec, scale, restart, port-forward, apply YAML, delete |
| Docker | 5 skills | List, start/stop, logs, inspect, exec |
| GitHub | 7 skills | Get repo, create/list issues, star, search, get user, list PRs |
| Task Scheduler | 3 skills | Schedule, unschedule, list tasks |
| Image Processing | 6 skills | Resize, convert, info, rotate, crop, compress |