User Guide
Complete documentation for using Colibri to manage your ebook library
3 min read
Welcome to the Colibri User Guide. This comprehensive documentation covers everything you need to know about using Colibri to manage your ebook library, from basic operations to advanced features.
Getting Started with Your Library
Once you have Colibri installed and configured, you’re ready to start building your digital library. This guide will walk you through all the features available to help you organize, discover, and enjoy your ebook collection.
Essential Features
| Feature | Description | Guide |
|---|---|---|
| Uploading Books | Import ebooks into your library | Add EPUB, MOBI, and PDF files |
| Library Management | Browse and organize your collection | Navigate, filter, and sort books |
| Collections | Create custom reading lists | Group books by theme, status, or any criteria |
| Search | Find books quickly | Full-text search across your library |
Enrichment & Metadata
| Feature | Description | Guide |
|---|---|---|
| Metadata Enrichment | Enhance book information | Fetch data from 14+ metadata providers |
| Reviews & Ratings | Rate and review books | Track your reading experience |
Administration
| Feature | Description | Guide |
|---|---|---|
| Authentication | Secure access to your library | Passkeys, OAuth, and API keys |
| Settings | Configure your instance | Customize behavior and preferences |
Command Line Interface
For power users and automation, Colibri provides a comprehensive CLI tool.
- CLI Overview - Installation and basic usage
- Works Commands - Manage books and editions
- Creators Commands - Manage authors and contributors
- Publishers Commands - Manage publishers
- Storage Commands - Work with S3 storage
- Users Commands - User administration
- OAuth Commands - API integrations
API Reference
Colibri exposes a type-safe API for programmatic access.
- API Overview - Introduction to the API
- tRPC Reference - Detailed endpoint documentation
Plugins
Extend Colibri with plugins for additional functionality.
- Plugins Overview - Plugin system documentation
Quick Reference
Supported Ebook Formats
| Format | Extension | Features |
|---|---|---|
| EPUB | .epub | Full metadata extraction, cover images, TOC |
| MOBI | .mobi, .azw, .azw3 | Kindle format support, ASIN extraction |
.pdf | Metadata extraction, page count |
Keyboard Shortcuts
| Shortcut | Action |
|---|---|
/ or Cmd+K | Open search |
Escape | Close dialogs |
Enter | Confirm action |
User Roles
| Role | Capabilities |
|---|---|
| Admin | Full system access, user management, settings |
| Adult | Full library access, personal collections |
| Child | Filtered content, age-appropriate access |
Best Practices
Organizing Your Library
- Use consistent metadata: Take time to verify and correct book metadata after import
- Create meaningful collections: Organize by reading status, genre, or personal categories
- Enable auto-enrichment: Let Colibri fetch metadata automatically during import
- Regular backups: Export your library data periodically
Performance Tips
- Batch imports: Import multiple books at once rather than one at a time
- Use the CLI for large operations: The CLI is optimized for bulk tasks
- Configure caching: Enable metadata caching to reduce API calls
Getting Help
- Troubleshooting: Common issues and solutions
- GitHub Issues: Report bugs or request features
- Contributing: Help improve Colibri