Skip to content

copilot.mdx

Latest commit

 

History

History
134 lines (103 loc) · 5.05 KB

copilot.mdx

File metadata and controls

134 lines (103 loc) · 5.05 KB
Raw
id copilot
title GitHub Copilot
sidebar_label GitHub Copilot

What

Display your GitHub Copilot usage statistics and quota information including premium interactions, inline completions, and chat usage. This segment was inspired by Elio Struyf's GitHub Copilot Usage Tauri application.

Authentication

This segment requires authentication with GitHub to access Copilot usage data. Use the built-in OAuth device code flow:

oh-my-posh auth copilot

This will:

  1. Display a device code and verification URL
  2. Open your browser to GitHub's authorization page
  3. Prompt you to enter the device code
  4. Store the access token securely for future use

The token is stored securely and will be used automatically by the segment.

Sample Configuration

import Config from "@site/src/components/Config.js";

<Config data={{ type: "copilot", style: "diamond", leading_diamond: "\ue0b6", trailing_diamond: "\ue0b4", foreground: "#111111", background: "#fee898", template: " \uec1e {{ .Premium.Percent.Gauge }} ", cache: { duration: "5m", strategy: "session", }, options: { http_timeout: 1000, }, }} />

Options

Name Type Default Description
http_timeout int 20 The default timeout for HTTP requests in milliseconds

Template (info)

:::note default template

 \uec1e {{ .Premium.Percent.Gauge }}

:::

Properties

Name Type Description
.Premium CopilotUsage Premium interactions usage data
.Premium.Used int Number of premium interactions used
.Premium.Limit int Total premium interactions available
.Premium.Percent Percentage Percentage of premium quota used (0-100)
.Premium.Remaining Percentage Percentage of premium quota remaining (0-100)
.Premium.Unlimited bool Whether premium quota is unlimited
.Inline CopilotUsage Inline completions usage data
.Inline.Used int Number of inline completions used
.Inline.Limit int Total inline completions available
.Inline.Percent Percentage Percentage of inline quota used (0-100)
.Inline.Remaining Percentage Percentage of inline quota remaining (0-100)
.Inline.Unlimited bool Whether inline quota is unlimited
.Chat CopilotUsage Chat usage data
.Chat.Used int Number of chat interactions used
.Chat.Limit int Total chat interactions available
.Chat.Percent Percentage Percentage of chat quota used (0-100)
.Chat.Remaining Percentage Percentage of chat quota remaining (0-100)
.Chat.Unlimited bool Whether chat quota is unlimited
.BillingCycleEnd string End date of current billing cycle

Percentage Methods

The Percentage type provides additional functionality beyond just the numeric value:

Method Returns Description
.Gauge() string Visual gauge showing remaining capacity using 5 bar blocks (▰▰▰▰▱)
.GaugeUsed() string Visual gauge showing used capacity using 5 bar blocks (▰▱▱▱▱)
.String() string Numeric percentage value (e.g., "75" for use in templates)

Example gauge visualization (shows remaining capacity):

  • 0% used (100% remaining): ▰▰▰▰▰
  • 20% used (80% remaining): ▰▰▰▰▱
  • 40% used (60% remaining): ▰▰▰▱▱
  • 60% used (40% remaining): ▰▰▱▱▱
  • 80% used (20% remaining): ▰▱▱▱▱
  • 100% used (0% remaining): ▱▱▱▱▱

Example gaugeUsed visualization (shows used capacity):

  • 0% used: ▱▱▱▱▱
  • 20% used: ▰▱▱▱▱
  • 40% used: ▰▰▱▱▱
  • 60% used: ▰▰▰▱▱
  • 80% used: ▰▰▰▰▱
  • 100% used: ▰▰▰▰▰

Example template with gauge:

"template": "{{ .Premium.Percent.Gauge() }} {{ .Premium.Used }}/{{ .Premium.Limit }}"

Example template showing used capacity:

"template": "{{ .Premium.Percent.GaugeUsed() }} {{ .Premium.Used }}/{{ .Premium.Limit }}"