cli

Overview ¶

Package cli provides a client interface that wraps the kode CLI binary to provide the same programming interface as the chat package.

This package allows clients to interact with the kode CLI as a pure binary dependency via stdin/stdout using --json mode. The CLI converts events to Go function callbacks, making it feel identical to using the chat package directly.

Usage Example (CLI Binary):

import "github.com/xhd2015/kode-ai/cli"

// Create a client (identical interface to chat.NewClient)
client, err := cli.NewClient(cli.Config{
	Model: "gpt-4o",
	Token: "your-api-token",
})
if err != nil {
	panic(err)
}

// Use the client with functional options (identical to chat package)
response, err := client.Chat(ctx, "Hello, world!",
	cli.WithSystemPrompt("You are a helpful assistant"),
	cli.WithMaxRounds(3),
	cli.WithTools("list_dir", "read_file"),
	cli.WithEventCallback(func(event cli.Event) {
		fmt.Printf("Event: %s - %s\n", event.Type, event.Content)
	}),
	cli.WithToolCallback(func(ctx context.Context, call cli.ToolCall) (cli.ToolResult, bool, error) {
		// Custom tool handling - this now works with the stream protocol!
		if call.Name == "custom_tool" {
			return cli.ToolResult{
				Content: map[string]interface{}{
					"result": "Custom tool executed successfully",
				},
			}, true, nil
		}
		return cli.ToolResult{}, false, nil // Let builtin tools handle it
	}),
)

Usage Example (WebSocket Server):

import "github.com/xhd2015/kode-ai/cli"

// Connect to a WebSocket chat server
response, err := cli.ChatWithServer(ctx, "http://localhost:8080", types.Request{
	Message: "Hello, world!",
	SystemPrompt: "You are a helpful assistant",
	Tools: []string{"list_dir", "read_file"},
	EventCallback: func(event types.Message) {
		fmt.Printf("Event: %s - %s\n", event.Type, event.Content)
	},
	ToolCallback: func(ctx context.Context, stream types.StreamContext, call types.ToolCall) (types.ToolResult, bool, error) {
		// Custom tool handling via WebSocket stream protocol
		if call.Name == "custom_tool" {
			return types.ToolResult{
				Content: map[string]interface{}{
					"result": "Custom tool executed successfully",
				},
			}, true, nil
		}
		return types.ToolResult{}, false, nil // Let builtin tools handle it
	},
})

Key Features:

- Drop-in replacement for the chat package - Uses kode CLI binary with --json mode for communication - Supports all the same functional options (WithSystemPrompt, WithTools, etc.) - Provides event callbacks for real-time event processing - Supports custom tool callbacks via bidirectional stream protocol - Pure binary dependency - no need to import chat package dependencies - WebSocket server support for distributed chat systems

The client communicates with the kode CLI process via stdin/stdout using JSON messages. Events from the CLI are parsed and converted to Go function callbacks. Tool callbacks use a bidirectional stream protocol where the CLI sends tool_call_request messages and waits for tool_call_response messages, providing a seamless integration experience.

The ChatWithServer function connects to a WebSocket server running the chat-server subcommand, allowing for distributed chat systems where the AI processing happens on a remote server while maintaining the same programming interface.