Struct Client 

pub struct Client { /* private fields */ }

Copilot client for managing connections and sessions.

The client manages the connection to the Copilot CLI server and provides methods to create and manage conversation sessions.

Example

use copilot_sdk::{Client, ClientOptions, SessionConfig};

#[tokio::main]
async fn main() -> copilot_sdk::Result<()> {
    // Create client with options
    let client = Client::new(ClientOptions::default())?;

    // Start the client
    client.start().await?;

    // Create a session
    let session = client.create_session(SessionConfig::default()).await?;

    // Send a message and collect response
    let response = session.send_and_collect("Hello!", None).await?;
    println!("{}", response);

    // Stop the client
    client.stop().await;
    Ok(())
}

Implementations

impl Client

pub fn new(options: ClientOptions) -> Result<Self>

Create a new Copilot client with the given options.

pub fn builder() -> ClientBuilder

Create a client builder for fluent configuration.

pub async fn start(&self) -> Result<()>

Start the client and connect to the server.

pub async fn stop(&self) -> Vec<StopError>

Stop the client gracefully.

pub async fn force_stop(&self)

Force stop the client immediately.

pub async fn state(&self) -> ConnectionState

Get the current connection state.

pub async fn create_session( &self, config: SessionConfig, ) -> Result<Arc<Session>>

Create a new Copilot session.

pub async fn resume_session( &self, session_id: &str, config: ResumeSessionConfig, ) -> Result<Arc<Session>>

Resume an existing session.

pub async fn list_sessions(&self) -> Result<Vec<SessionMetadata>>

List all available sessions.

pub async fn delete_session(&self, session_id: &str) -> Result<()>

Delete a session.

pub async fn get_last_session_id(&self) -> Result<Option<String>>

Get the ID of the most recently used session.

pub async fn ping(&self, message: Option<String>) -> Result<PingResponse>

Send a ping to verify connection health.

pub async fn get_status(&self) -> Result<GetStatusResponse>

Get CLI status including version and protocol information.

pub async fn get_auth_status(&self) -> Result<GetAuthStatusResponse>

Get current authentication status.

pub async fn list_models(&self) -> Result<Vec<ModelInfo>>

List available models with their metadata.

Results are cached after the first call. Use [clear_models_cache] to force a refresh.

Errors

Returns an error if not authenticated or if the request fails.

pub async fn clear_models_cache(&self)

Clear the cached models list, forcing a fresh fetch on next list_models() call.

pub async fn get_foreground_session_id( &self, ) -> Result<GetForegroundSessionResponse>

Get the foreground session ID and workspace path.

pub async fn set_foreground_session_id( &self, session_id: &str, ) -> Result<SetForegroundSessionResponse>

Set the foreground session ID.

pub async fn on<F>(&self, handler: F) -> impl FnOnce()

where F: Fn(&SessionLifecycleEvent) + Send + Sync + 'static,

Register a handler for client-level lifecycle events.

Lifecycle events include session created, deleted, updated, foreground, and background. Returns an unsubscribe closure that removes the handler when called.

pub async fn get_session(&self, session_id: &str) -> Option<Arc<Session>>

Get a session by ID.