GitHub Copilot Home Assistant Integration

Key Features

Installation

Via HACS (Recommended)

1. Open HACS in Home Assistant.
2. Go to Integrations and click the + button.
3. Search for GitHub Copilot.
4. Click Install, then restart Home Assistant.
5. Configure via Settings → Devices & Services → Add Integration.

Manual Installation

1. Copy the custom_components/github_copilot directory to your Home Assistant custom_components directory.
2. Restart Home Assistant.
3. Configure via Settings → Devices & Services → Add Integration.

GitHub Copilot Bridge Add-on

Installing the Copilot CLI inside the Home Assistant Core container can be difficult on Home Assistant OS. The GitHub Copilot Bridge add-on solves this by running the CLI in a dedicated container that the integration connects to over the internal network.

Add-on Highlights

• 🐳 Containerized Copilot CLI server on port 8000 (internal network only)
• 🔄 Automatic retry mechanism — up to 5 restart attempts on failures
• 🔐 Token-based authentication via environment variables (no interactive prompts)
• 🏗️ Multi-architecture support: amd64 and aarch64
• ✅ SHA256 checksum verification for CLI binary integrity
• 🛡️ Hardened auth probe with timeout protection

Installing the Add-on

1. Go to Settings → Add-ons → Add-on Store.
2. Click the ⋮ menu and choose Repositories.
3. Add: https://github.com/tserra30/Github-Copilot-SDK-integration
4. Find GitHub Copilot Bridge in the store and click Install.
5. In the add-on Configuration tab, set your GitHub token:

   github_token: "ghp_yourTokenHere"

6. Start the add-on and check the Log tab to confirm success.

Finding the Add-on URL

The integration connects to the add-on via its internal hostname (shown in the add-on Info tab). The URL format is:

http://<hostname>:8000
# Example:
http://a1b2c3d4-github-copilot-bridge:8000

Note: Home Assistant generates the hostname from the add-on slug by replacing all underscores (_) with hyphens (-). Always use hyphens — using underscores will cause DNS resolution to fail.

Configuration

1. Go to Settings → Devices & Services → Add Integration.
2. Search for GitHub Copilot and select it.
3. Fill in the fields:
   • GitHub Token — Personal access token with Copilot permissions. Optional when using the Bridge add-on (the add-on manages its own authentication).
   • Model — The AI model to use (default: GPT-4o).
   • Copilot CLI URL *(optional)* — URL of the Bridge add-on, e.g. http://a1b2c3d4-github-copilot-bridge:8000. Leave empty to use a locally installed Copilot CLI.

Getting a GitHub Token

1. Ensure you have an active GitHub Copilot subscription.
2. Generate a PAT from GitHub Developer Settings.
3. Grant the necessary Copilot permissions.
4. Keep the token secure — never share it publicly.

Example Automation

automation:
  - alias: "Morning briefing with Copilot"
    trigger:
      - platform: time
        at: "07:00:00"
    action:
      - service: conversation.process
        data:
          text: "Good morning! What should I know today?"
          agent_id: conversation.github_copilot

Supported Models

Choose from a wide variety of LLMs via the Copilot SDK:

• GPT-4o
• GPT-4o-mini
• GPT-4
• GPT-4 Turbo
• GPT-4.1
• GPT-3.5 Turbo
• GPT-5
• o3-mini
• o1
• o1-mini
• Claude 3.5 Sonnet
• Claude 4.5 Sonnet
• Claude 4.5 Haiku
• Claude 4.6 Opus

Troubleshooting

"Unable to connect to Copilot CLI"

This means the Copilot CLI is not reachable. Two options:

• Option A (Recommended) — Install and start the GitHub Copilot Bridge add-on, then enter its URL in the Copilot CLI URL field.
• Option B — Install the Copilot CLI manually inside the Home Assistant Core container and authenticate it with copilot auth login.

Authentication Errors

• Verify your GitHub token is valid and has Copilot permissions.
• Ensure your GitHub Copilot subscription is active.
• Try regenerating your personal access token.

SDK Installation Issues (Home Assistant OS)

This integration uses a patched github-copilot-sdk 0.1.22+ha wheel installed automatically from the repository's wheels/ directory. It is a universal py3-none-any wheel with protocol v3 support — no glibc version constraints. This resolves the manylinux_2_28 incompatibility seen with SDK versions 0.1.23+.

Slow Responses

• Try a faster model such as GPT-3.5 Turbo or GPT-4o-mini.
• Check your network latency.
• Reduce concurrent requests.

For more help, open an issue on GitHub.

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for guidelines on how to propose changes, run the linter, and submit pull requests.