Returns a specification to start this module under a supervisor.

See Supervisor.

@spec create_session(GenServer.server(), Copilot.Types.SessionConfig.t()) ::
  {:ok, pid()} | {:error, any()}

Create a new conversation session.

Returns {:ok, session_pid} where session_pid is a Copilot.Session GenServer.

@spec delete_session(GenServer.server(), String.t()) :: :ok | {:error, any()}

Delete a session and its data from disk.

@spec get_auth_status(GenServer.server()) ::
  {:ok, Copilot.Types.GetAuthStatusResponse.t()} | {:error, any()}

Get current authentication status.

@spec get_foreground_session_id(GenServer.server()) ::
  {:ok, String.t() | nil} | {:error, any()}

Get the foreground session ID.

@spec get_last_session_id(GenServer.server()) ::
  {:ok, String.t() | nil} | {:error, any()}

Get the last session ID.

@spec get_session_metadata(GenServer.server(), String.t()) ::
  {:ok, map()} | {:error, any()}

Get metadata for a session by ID.

@spec get_state(GenServer.server()) ::
  :disconnected | :connecting | :connected | :error

Get the current connection state.

@spec get_status(GenServer.server()) ::
  {:ok, Copilot.Types.GetStatusResponse.t()} | {:error, any()}

Get CLI status including version and protocol information.

@spec list_models(GenServer.server()) ::
  {:ok, [Copilot.Types.ModelInfo.t()]} | {:error, any()}

List available models. Results are cached after the first call.

@spec list_sessions(GenServer.server()) ::
  {:ok, [Copilot.Types.SessionMetadata.t()]} | {:error, any()}

List all available sessions.

@spec ping(GenServer.server(), String.t() | nil) ::
  {:ok, Copilot.Types.PingResponse.t()} | {:error, any()}

Send a ping to the server.

Returns {:ok, %PingResponse{}} or {:error, reason}.

@spec resume_session(
  GenServer.server(),
  String.t(),
  Copilot.Types.ResumeSessionConfig.t()
) ::
  {:ok, pid()} | {:error, any()}

Resume an existing session by ID.

Returns {:ok, session_pid}.

@spec set_foreground_session_id(GenServer.server(), String.t()) ::
  :ok | {:error, any()}

Set the foreground session ID.

@spec set_session_fs_provider(GenServer.server(), map()) :: :ok | {:error, any()}

Sets the session filesystem provider configuration.

Options

• :initial_cwd - Optional initial working directory.
• :session_state_path - Optional path for session state persistence.
• :conventions - Optional list of convention strings.

@spec start(GenServer.server()) :: :ok | {:error, any()}

Start the CLI server and establish a JSON-RPC connection.

@spec start_link(
  Copilot.Types.CopilotClientOptions.t(),
  keyword()
) :: GenServer.on_start()

Start the Copilot client GenServer.

Options

All fields from Copilot.Types.CopilotClientOptions are supported. Pass name: <name> in gen_opts to register the process.

@spec stop(GenServer.server()) :: :ok

Stop the CLI server and clean up all sessions.

@spec subscribe_lifecycle(
  GenServer.server(),
  (Copilot.Types.SessionLifecycleEvent.t() -> any())
) ::
  reference()

Subscribe to session lifecycle events.

Returns a reference that can be used with unsubscribe_lifecycle/2.