iflow-cli-sdk-rust 0.1.6

Rust SDK for iFlow CLI using Agent Client Protocol
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

# iFlow CLI Rust SDK

This directory contains the iFlow CLI SDK for Rust, which allows developers to interact with iFlow using the [Agent Client Protocol (ACP)](https://github.com/agentclientprotocol/agent-client-protocol).

## Project Overview

The iFlow CLI SDK for Rust provides a powerful interface for communicating with iFlow. It offers both simple query functions and a full bidirectional client for complex interactions. The SDK automatically manages the iFlow process lifecycle and supports both stdio and WebSocket communication.

### Key Features

- **Automatic Process Management**: SDK automatically starts and manages iFlow process
- **Stdio Communication**: Communicate with iFlow via stdio
- **WebSocket Communication**: Communicate with iFlow via WebSocket for better performance and reliability
- **Bidirectional Communication**: Real-time streaming messages and responses
- **Tool Call Management**: Fine-grained permission control for tool execution
- **Task Planning**: Receive and process structured task plans
- **Raw Data Access**: Debug and inspect protocol-level messages
- **Async/Await Support**: Modern async Rust with full type safety

## Building and Running

### Prerequisites

- Rust 1.70+
- iFlow CLI installed with `--experimental-acp` support (or use auto-start feature)

### Building

```bash
cargo build
```

### Testing

```bash
cargo test

# e2e tests
cargo test --test e2e_tests -- --nocapture
```

### Running Examples

```bash
# Simple query example
cargo run --example query

# Simple query with custom configuration example
cargo run --example query_with_config

# Interactive client example
cargo run --example basic_client

# Test response handling
cargo run --example test_response

# Explore API capabilities
cargo run --example explore_api

# Logging example
cargo run --example logging_example
```

### Running with logging

```bash
RUST_LOG=debug cargo run --example basic_client
```

## Development Conventions

- The SDK is organized into several modules:
  - `client` - Main IFlowClient implementation with stdio communication
  - `types` - Type definitions and message structures
  - `process_manager` - iFlow process lifecycle management
  - `query` - Convenience functions for simple queries
  - `error` - Error types and handling
  - `logger` - Message logging functionality
  - `websocket_transport` - Low-level WebSocket communication
  - `acp_protocol` - Implementation of the [Agent Client Protocol (ACP)](https://github.com/agentclientprotocol/agent-client-protocol)

- Uses the official `agent-client-protocol` crate for ACP implementation
- Follows Rust async/await patterns with Tokio runtime
- Provides both high-level convenience functions and low-level client control
- WebSocketConfig provides default parameters for reconnect_attempts and reconnect_interval, with auto-start mode support