Refractored.GitHub.Copilot.SDK.Helpers 1.0.0

Refractored.GitHub.Copilot.SDK.Helpers

Reusable helper utilities for the GitHub Copilot SDK for .NET. This library provides common functionality for CLI-based Copilot applications.

Installation

dotnet add package Refractored.GitHub.Copilot.SDK.Helpers

Features

CliChecker

Checks if the Copilot CLI is installed and the user is authenticated.

using Refractored.GitHub.Copilot.SDK.Helpers;

// Check status with console output
var status = await CliChecker.CheckCopilotStatusAsync();

// Or check silently (no console output)
var status = await CliChecker.CheckCopilotStatusSilentAsync();

if (!CliChecker.IsReady(status))
{
    Console.WriteLine("Copilot is not ready!");
    return;
}

ModelSelector

Fetches available models from the Copilot CLI and allows selection.

using Refractored.GitHub.Copilot.SDK.Helpers;

// Interactive selection via console
var model = await ModelSelector.SelectModelAsync();

// Get all available models
var models = await ModelSelector.GetModelsFromCliAsync();

// Get the default (first) model
var defaultModel = await ModelSelector.GetDefaultModelAsync();

// Select by index (0-based)
var model = await ModelSelector.SelectModelByIndexAsync(2);

ChatHelper

Helper methods for streaming chat interactions.

using GitHub.Copilot.SDK;
using Refractored.GitHub.Copilot.SDK.Helpers;

// Stream response to console with colored output
await ChatHelper.SendMessageAndStreamResponse(session, "Hello, Copilot!");

// Get complete response as string
var response = await ChatHelper.SendMessageAndGetResponseAsync(session, "What is 2+2?");

// Use callbacks for custom handling
await ChatHelper.SendMessageWithCallbacksAsync(
    session,
    "Explain async/await",
    onDelta: text => Console.Write(text),
    onComplete: () => Console.WriteLine("\n[Done]"),
    onError: err => Console.WriteLine($"Error: {err}")
);

Prerequisites

• .NET 8.0, .NET 9.0, or .NET 10.0
• GitHub Copilot CLI installed and configured
• GitHub Copilot access on your GitHub account

Installing Copilot CLI

# macOS/Linux (Homebrew)
brew install copilot-cli

# Windows (WinGet)
winget install GitHub.Copilot

# npm (requires Node.js 22+)
npm install -g @github/copilot

# macOS/Linux (install script)
curl -fsSL https://gh.io/copilot-install | bash

Authentication

Either:

• Run copilot, then type /login and follow prompts
• Set GH_TOKEN environment variable with a token that has "Copilot Requests" permission

Full Example

using GitHub.Copilot.SDK;
using Refractored.GitHub.Copilot.SDK.Helpers;

// Check prerequisites
var status = await CliChecker.CheckCopilotStatusAsync();
if (!CliChecker.IsReady(status))
    return;

// Select a model
var model = await ModelSelector.SelectModelAsync();
if (model == null)
    return;

// Start client and create session
using var client = new CopilotClient();
await client.StartAsync();

using var session = await client.CreateSessionAsync(new SessionConfig
{
    Model = model,
    Streaming = true
});

// Chat!
await ChatHelper.SendMessageAndStreamResponse(session, "Hello, Copilot!");

License

MIT License - see LICENSE file.