README
¶
copilot-show
copilot-show is a command-line tool to inspect various information from the GitHub Copilot CLI, such as quotas, models, and tools.
It is built on top of github.com/github/copilot-sdk/go.
Installation
Install via go install (ensure your GOPATH/bin is in PATH):
go install github.com/apstndb/copilot-show@latest
Or using mise:
mise use -g go:github.com/apstndb/copilot-show@latest
Usage
Run the tool with a subcommand to inspect specific resources.
Available subcommands:
quota: Show Copilot Premium Interactions usage and entitlement.models: Show available models and their multipliers.tools: Show available tools.usage: Show billing usage report from GitHub API, with model multipliers and entitlement joined from the models list and quota snapshots.stats: Show local usage statistics aggregated from session history.turns: Show turn-by-turn usage statistics for a session.sessions: List recent Copilot CLI sessions.history: Show event history for a session.
Common Options
Use --format yaml (or -f yaml) to get detailed raw data in YAML format.
Use --table-mode ascii or --table-mode markdown to change the table rendering style.
Examples
Quota Information
Shows the current usage and entitlement of Copilot Premium Interactions.
copilot-show quota
Example Output:
--- Quota Information ---
┌──────────────────────┬─────────────┬──────┬────────────┬─────────┐
│ METRIC │ ENTITLEMENT │ USED │ OVERAGE │ USAGE % │
├──────────────────────┼─────────────┼──────┼────────────┼─────────┤
│ chat │ 0 │ 0 │ Disallowed │ - │
│ completions │ 0 │ 0 │ Disallowed │ - │
│ premium_interactions │ 300 │ 65 │ Disallowed │ 21.7% │
└──────────────────────┴─────────────┴──────┴────────────┴─────────┘
Last Updated: 2026-03-12T20:41:07+09:00
Plan Reference (Approximate Monthly Entitlement):
- Copilot Free: 50
- Copilot Pro / Business: 300
- Copilot Enterprise: 1,000
- Copilot Pro+: 1,500
Month Progress (UTC): 38.8%
...
List Models
Lists available AI models with details like context size and billing multipliers.
copilot-show models
List Tools
Lists built-in tools available to Copilot.
copilot-show tools
Usage Report
Shows detailed billing usage for premium requests from the GitHub API (requires gh CLI).
Displays grouped results by Period and SKU with subtotals, multipliers, and entitlement information (in UI v2).
Supports relative date/month/year by specifying negative values (e.g., -d -1 for yesterday).
Multiple periods can be shown with the --last flag.
The Period column can be sorted in ascending or descending order with the --sort-order flag (default is desc).
# Current month (default)
copilot-show usage
# Yesterday's report
copilot-show usage -d -1
# Last 7 days daily report
copilot-show usage -d -1 --last 7
# Last 3 months monthly reports
copilot-show usage -m 0 --last 3
Stats
Aggregates usage statistics from local session history (~/.copilot/session-state/*/events.jsonl).
Useful for understanding which models are consuming your quota.
copilot-show stats [-a]
Turns
Displays turn-by-turn usage statistics for a specific session.
copilot-show turns [sessionID]
YAML Output
All commands support -f yaml flag to output detailed data in YAML format.
copilot-show quota -f yaml
Hidden Subcommands
The following commands are hidden by default but can be executed by specifying their names:
agents: List available Copilot agentscurrent-model: Show the currently selected model IDcurrent-agent: Show the currently selected agentmode: Show the current agent modeplan: Read the current plan fileworkspace: List files in the workspaceread-file <path>: Read a specific file from the workspaceping: Check connection to the serverstatus: Show CLI version and authentication statussessions: List all sessions with PID informationhistory [sessionID]: Show conversation history (from local event logs)
License
MIT License
Documentation
¶
There is no documentation for this package.