phi-agent 0.1.9

phi-agent — General-purpose AI Agent framework (builder factory, renderer, config, session management)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# Getting Started

5 minutes to your first phi-agent.

## Prerequisites

- [Rust](https://rustup.rs) (stable, edition 2024)
- An LLM API key (OpenAI-compatible endpoint)

## Install

```bash
cargo install phi-agent
```

## Option 1: CLI (recommended)

Start an interactive REPL:

```bash
phi
```

```
phi> What time is it?
🔧 get_time
2025-07-30 19:30:00

phi> /exit
```

Built-in shell tools, metrics, and thinking mode. Great for most users.

## Option 2: Code integration

Scaffold a project to build your own Agent:

```bash
phi init my-agent
cd my-agent
```

Set your API key and run:

```bash
cp .env.example .env
# Edit .env with your API key
cargo run
```

`phi init` generates a REPL with a `ClockTool` example. Open `src/main.rs`, model your own tool after `ClockTool`, register it — done.

See [Configuration](configuration.md) for all config options and [Custom Tools](custom-tool.md) for more examples.