Skip to main content
New protocol version released: This page may contain outdated information.
Get started with the HAIP CLI in minutes. This guide will walk you through the essential commands and help you test your HAIP server.

Prerequisites

Step 1: Verify Installation

First, let’s make sure the CLI is working:

Step 2: Check Server Health

Before connecting, let’s check if your HAIP server is running:
Expected output:

Step 3: Connect to Server

Connect to your HAIP server:
The connection will remain active until you press Ctrl+C.

Step 4: Send Messages

Send your first message:

Step 5: Call Tools

Test tool integration:

Step 6: Start a Run

Start a new conversation run:

Step 7: Monitor Events

Monitor server events in real-time:

Step 8: Test Performance

Test your server’s performance:

Complete Example Session

Here’s a complete example session:

Environment Configuration

Set up environment variables for convenience:
Now you can use shorter commands:

Common Patterns

Testing Server Connectivity

Debugging Issues

Performance Testing

Next Steps

Now that you’re familiar with the basics:

Troubleshooting

Connection Issues

Authentication Issues

Performance Issues