cai-tui 0.1.0

Terminal UI for Coding Agent Insights
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

//! CAI TUI - Terminal UI
//!
//! Interactive terminal interface for querying and exploring AI coding history.
//!
//! # Features
//!
//! - Query input with history navigation
//! - Scrollable results table with sorting
//! - Real-time status updates
//! - Keyboard shortcuts (q=quit, /=search, etc.)
//!
//! # Example
//!
//! ```rust,no_run
//! use cai_tui::run;
//!
//! // Create a storage implementation (MemoryStorage, SqliteStorage, etc.)
//! // and pass it to the run function
//! // let storage = ...;
//! // run(storage).await?;
//! ```

#![warn(missing_docs, unused_crate_dependencies)]

pub use cai_core::Result;

mod app;
mod event;
mod ui;

pub use app::{App, AppState, Column, Mode, SortOrder};
pub use event::{Event, EventHandler};

use cai_storage::Storage;
use std::sync::Arc;
use tokio::sync::RwLock;

/// Run the TUI application
///
/// # Errors
///
/// Returns an error if the terminal setup fails or a runtime error occurs
pub async fn run<S>(storage: Arc<S>) -> Result<()>
where
    S: Storage + 'static,
{
    // Initialize terminal
    let mut terminal = ui::init_terminal()?;

    // Create application
    let app = App::new(storage);
    let mut app = Arc::new(RwLock::new(app));

    // Create event handler
    let event_handler = EventHandler::new(100);

    // Run application
    let res = ui::run_app(&mut terminal, &mut app, event_handler).await;

    // Restore terminal
    ui::restore_terminal(terminal)?;

    // Convert error type
    res.map_err(|e| cai_core::Error::Message(e.to_string()))
}