🚀 Quick Start

📦 Installation

Run this command:


cargo add hippox

Or add to Cargo.toml:


[dependencies]
hippox = { version = "0.4.0", features = ["full"] }

🔑 Set API Key


export OPENAI_API_KEY=sk-your-key-here

💻 First Program

Create main.rs:


use hippox::{Hippox, ConfigInitMethod, ModelProvider};
 
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let hippox = Hippox::new(
"./skills",
ModelProvider::OpenAI,
Some(std::env::var("OPENAI_API_KEY")?),
None,
ConfigInitMethod::Env,
).await?;
 
    let response = hippox
        .handle_natural_language("Say hello", None)
        .await;
 
    println!("{}", response);
    Ok(())
 
}

🏃 Run


cargo run

📝 Create a Skill

Create skills/greeter/SKILL.md:


name: greeter
description: A friendly greeting skill
parameters:
 
- name: name
  type: string
  required: false
  default: "World"
 
---
 
# Greeter Skill
 
Greet the user with "Hello, {name}!"

Next: Read the Workflow Modes documentation.