> ## Documentation Index
> Fetch the complete documentation index at: https://copilot-api.nick3.top/llms.txt
> Use this file to discover all available pages before exploring further.

# copilot-api check-usage — view quota in terminal

> View GitHub Copilot usage and remaining quota in the terminal without starting the proxy. Useful before long sessions or when debugging quota exhaustion.

The `check-usage` command fetches your GitHub Copilot usage and quota information and prints it to the terminal. It authenticates with your stored credentials and queries the Copilot API, so you can inspect your quota at any time without starting the proxy server.

## Usage

```bash theme={null}
npx @nick3/copilot-api@latest check-usage
```

## Options

`check-usage` does not have command-specific options. The global options apply:

| Option             | Default | Description                                                                  |
| ------------------ | ------- | ---------------------------------------------------------------------------- |
| `--api-home`       | none    | Path to the data directory where tokens are stored. Sets `COPILOT_API_HOME`. |
| `--oauth-app`      | none    | OAuth app identifier. Sets `COPILOT_API_OAUTH_APP`.                          |
| `--enterprise-url` | none    | GitHub Enterprise hostname. Sets `COPILOT_API_ENTERPRISE_URL`.               |

## When to use check-usage

Use `check-usage` when you want a quick terminal view of your remaining quota before starting a long session or when troubleshooting unexpectedly rejected requests.

If the proxy server is already running, you have two additional ways to inspect quota:

* **`GET /usage`** — Returns a JSON snapshot of all loaded accounts and their remaining quota. Useful for programmatic checks or integrations.
* **Admin UI** (`/admin`) — Displays account status, quota, and full request history in a browser.

<Tip>
  If you manage multiple accounts, run `check-usage` to verify each account has sufficient quota before routing traffic. To see per-account quota from the CLI while the server is stopped, use `auth ls -q` instead.
</Tip>