Skip to content

Latest commit

 

History

History

usage

README.md

@pi-plugins/usage

Check subscription usage and rate limits in pi with a command and a compact status widget.

Install

pi install npm:@pi-plugins/usage

To try it for one session without changing your settings:

pi -e npm:@pi-plugins/usage

Usage

Authenticate a supported provider in pi, then run:

/usage

The command prints a report in the chat with one section per provider: usage bars, percentages, and reset times where available. Missing credentials or failed requests are shown inline in the provider's section. For Claude and OpenAI Codex, the section heading also shows the plan and the signed-in account's email, so it is easy to tell which account is active when switching between several. The report is kept in the session transcript and is not sent to the model.

When the selected model belongs to a supported provider, a compact widget shows its limits above the editor.

Supported providers

The plugin uses the credentials you have already configured in pi, or Claude Code's login for the claude-cli provider.

Provider Pi provider Authentication
Claude anthropic Subscription sign-in with /login.
Claude Code claude-cli Claude Code's sign-in with claude auth login.
OpenAI Codex openai-codex Subscription sign-in with /login.
GLM Coding zai API key.
GLM Coding (China) zai-coding-cn API key.

The claude-cli provider from @pi-plugins/claude-cli bills the account the claude CLI is signed in to, so its limits come from Claude Code's login in $CLAUDE_CONFIG_DIR/.credentials.json (default ~/.claude/.credentials.json). The plugin only reads that login and never renews it, since Claude Code renews it on its next request. With the provider loaded, /usage shows a Claude Code section and leaves out the Claude section unless pi has its own Claude sign-in. On macOS Claude Code keeps its login in the Keychain, which the plugin doesn't read yet.

Configuration

Optionally create <agent-dir>/extensions/usage.json, typically ~/.pi/agent/extensions/usage.json. The defaults are:

{
  "showWidget": true
}
Setting Description
showWidget Show rate-limit bars above the editor. Set to false to hide them; /usage remains available.