@eliware/openai-balance
v15.0.1
Published
Show the current OpenAI credit balance in one terminal line.
Maintainers
Readme
@eliware/openai-balance

Show the current OpenAI credit balance in one terminal line.
Table of Contents
- Features
- Requirements
- Setup
- Usage
- Development
- Testing
- Troubleshooting
- Security
- Configuration
- Operations
- Commands
- Exit codes
- Support
- Links
- License
Features
Read the current credit balance or print credit history from an OpenAI billing endpoint.
Requirements
Use Node.js 26 or later. Provide an endpoint and a bearer token with access to billing data.
Setup
Install the package with npm install @eliware/openai-balance.
Usage
Set the required configuration.
Run npx @eliware/openai-balance.
Read the usage guide and release notes.
Development
Read documentation, examples, and specifications.
Testing
Run npm test for aggregate validation.
Run npm run lint for lint checks.
Run npm run format:check to check formatting.
Run npm run pack to check package contents.
Troubleshooting
Read the troubleshooting guide when a command fails.
Security
Keep the bearer token secret. Use a placeholder token in examples.
Configuration
Set ENDPOINT and AUTH_HEADER in the shell or in a .env file.
Read the configuration guide for file paths and value order.
Operations
The command makes one HTTPS request. It does not change account data. It stops the active request after SIGINT, SIGTERM, or SIGHUP.
Commands
Run openai-balance --help to show command options.
Run openai-balance --version to show the version.
Use --summary, --json, --nano-dollars, or --combined to select output.
Do not combine --nano-dollars with --combined.
Exit codes
The command returns 0 after success. The command returns 1 after a configuration, authentication, request, or data error. It returns 129 after SIGHUP, 130 after SIGINT, and 143 after SIGTERM.
Support
For help, questions, or to chat with the author and community, visit:



