API Reference

API Overview

The Agate API provides a comprehensive set of interfaces for building terminal-based applications. This reference covers all public APIs, interfaces, and utilities available in the framework.

Core Packages

`pkg/app`

The main application package containing the core Agate application structure.

import "github.com/agate-sh/agate/pkg/app"

Key types:

App - Main application instance
Config - Application configuration
Agent - Agent interface

`pkg/ui`

UI components and rendering utilities.

import "github.com/agate-sh/agate/pkg/ui"

Key types:

Component - Base UI component interface
Overlay - Overlay component for modal dialogs
Border - Border styling utilities

`pkg/shell`

Shell management and tmux integration.

import "github.com/agate-sh/agate/pkg/shell"

Key types:

Shell - Shell session management
TmuxManager - tmux integration utilities
Command - Command execution utilities

Quick Reference

Creating an Application

app := app.New()
app.SetTitle("My App")
app.Run()

Registering Agents

agent := &MyAgent{}
app.RegisterAgent(agent)

Configuration

config := app.Config()
config.SetTheme("dark")
config.EnableDebug(true)

Error Handling

All Agate APIs follow Go conventions for error handling:

if err := app.Run(); err != nil {
    log.Fatal(err)
}

API Documentation

API Reference

API Overview

Core Packages

`pkg/app`

`pkg/ui`

`pkg/shell`

Quick Reference

Creating an Application

Registering Agents

Configuration

Error Handling

Next Steps

Agent System API

UI Components API

​API Overview

​Core Packages

​pkg/app

​pkg/ui

​pkg/shell

​Quick Reference

​Creating an Application

​Registering Agents

​Configuration

​Error Handling

​Next Steps

Agent System API

UI Components API

API Overview

Core Packages

`pkg/app`

`pkg/ui`

`pkg/shell`

Quick Reference

Creating an Application

Registering Agents

Configuration

Error Handling

Next Steps