Documentation
Everything you need to know about pbar.io - Beautiful Progress Tracking for developers.
Quick Start →
Get up and running in under a minute. No signup required.
API Reference →
Complete REST API documentation with examples.
Explore the Docs
Getting Started
Quick installation, your first progress bar, and basic concepts. Perfect for beginners.
API Reference
Complete REST API documentation. All endpoints, parameters, and response formats.
Integrations
Python, JavaScript, Shell scripts, CI/CD pipelines. Drop-in replacements for tqdm and more.
Examples
Real-world use cases: ML training, data pipelines, file uploads, deployments, and more.
Core Concepts
Understand hierarchical progress, expiration policies, rate limiting, and architecture.
Why pbar.io?
No Setup Required
Start tracking progress instantly. No account, no API keys, no configuration.
Universal Access
View progress from anywhere - browsers, terminals, mobile devices. Share with a URL.
Terminal Native
Beautiful ANSI colors in terminals. Works perfectly with curl, wget, and CLI tools.
Privacy First
No tracking, no cookies, no personal data. IP addresses are hashed for rate limiting.
Implementation Status
| Feature | Status | Notes |
|---|---|---|
| REST API | ✅ Available | Full CRUD operations |
| Python Client | ✅ Available | pip install pbar-io |
| Python tqdm Integration | ✅ Available | Drop-in replacement |
| Hierarchical Progress Bars | ✅ Available | Parent-child relationships |
| Auto-completion | ✅ Available | Completes at 100% |
| Terminal Rendering | ✅ Available | ANSI colors, curl support |
| Shell/Bash Integration | ✅ Available | Direct API calls |
| JavaScript/TypeScript Client | 🚧 Coming Soon | npm package planned |
| React Hooks | 🚧 Coming Soon | useProgressBar hook |
| Rate Limiting | 🚧 Planned | 100/hr create, 5000/hr update |
| Authentication | 🚧 Planned | API keys for paid tier |
| Rich Progress Integration | 📋 Backlog | Python rich library |
Common Use Cases
- Long-running scripts - Monitor batch jobs, data processing, backups
- CI/CD pipelines - Track build and deployment progress
- Machine learning - Monitor training epochs and validation
- File uploads/downloads - Share progress with users
- Database migrations - Track schema and data updates
Need Help?
Can't find what you're looking for? Here are some ways to get help:
- •Check the Examples for real-world use cases
- •Read about Core Concepts for deeper understanding
- •Email us at support@pbar.io for assistance