pocketbase

What this skill does

# PocketBase Skill - Comprehensive Reference

## Overview

This skill provides modular, searchable documentation for PocketBase development. Use the table of contents below to navigate to specific topics. The researcher-pocketbase agent can efficiently search and extract information from the reference files based on your query. PocketBase is an open source backend in 1 file. It provides a realtime database, authentication, file storage, an admin dashboard and is extendable to much more.

## Quick Navigation

### For Newcomers
→ Start with [Getting Started](references/core/getting_started.md) for initial setup and basic concepts
→ Review [Collections](references/core/collections.md) to understand data modeling
→ See [Authentication](references/core/authentication.md) for user management
→ Check [API Rules & Filters](references/core/api_rules_filters.md) for security

### For Implementation
→ Browse [Schema Templates](references/templates/schema_templates.md) for pre-built data models
→ Use [Records API](references/api/api_records.md) for CRUD operations
→ Implement [Real-time](references/api/api_realtime.md) for live updates
→ Follow [Files Handling](references/core/files_handling.md) for file uploads
→ Read [Working with Relations](references/core/working_with_relations.md) for data relationships

### For Production
→ See [Going to Production](references/core/going_to_production.md) for deployment
→ Review [Security Rules](references/security_rules.md) for access control
→ Check [API Reference](references/api_reference.md) for complete API documentation

### For Advanced Users
→ Explore [Go Extensions](references/go/go_overview.md) for custom functionality
→ Study [Event Hooks](references/go/go_event_hooks.md) for automation
→ Learn [Database Operations](references/go/go_database.md) for advanced queries
→ Plan data migrations with [Data Migration Workflows](references/core/data_migration.md)

---

## Table of Contents

### Core Concepts & Setup
| Topic | Description | When to Use |
|-------|-------------|-------------|
| [Getting Started](references/core/getting_started.md) | Initial setup, quick start, basic concepts | First time using PocketBase, initial configuration |
| [CLI Commands](references/core/cli_commands.md) | PocketBase CLI, serve, migrate, admin, superuser | Development workflow, server management, migrations |
| [Collections](references/core/collections.md) | Collection types, schema design, rules, indexes | Designing data models, creating collections |
| [Authentication](references/core/authentication.md) | User registration, login, OAuth2, JWT tokens | Building user accounts, login systems |
| [API Rules & Filters](references/core/api_rules_filters.md) | Security rules, filtering, sorting, query optimization | Controlling data access, writing efficient queries |
| [Files Handling](references/core/files_handling.md) | File uploads, thumbnails, CDN, security | Managing file uploads, image processing |
| [Working with Relations](references/core/working_with_relations.md) | One-to-many, many-to-many, data relationships | Building complex data models, linking collections |
| [Going to Production](references/core/going_to_production.md) | Deployment, security hardening, monitoring, backups | Moving from development to production |
| [Data Migration Workflows](references/core/data_migration.md) | Import/export strategies, scripts, and tooling | Planning and executing data migrations |

---

### API Reference
| Endpoint | Description | Reference File |
|----------|-------------|----------------|
| Records API | CRUD operations, pagination, filtering, batch operations | [api_records.md](references/api/api_records.md) |
| Realtime API | WebSocket subscriptions, live updates, event handling | [api_realtime.md](references/api/api_realtime.md) |
| Files API | File uploads, downloads, thumbnails, access control | [api_files.md](references/api/api_files.md) |
| Collections API | Manage collections, schemas, rules, indexes | [api_collections.md](references/api/api_collections.md) |
| Settings API | App configuration, CORS, SMTP, general settings | [api_settings.md](references/api/api_settings.md) |
| Logs API | Access logs, authentication logs, request logs | [api_logs.md](references/api/api_logs.md) |
| Crons API | Background jobs, scheduled tasks, automation | [api_crons.md](references/api/api_crons.md) |
| Backups API | Database backups, data export, disaster recovery | [api_backups.md](references/api/api_backups.md) |
| Health API | System health, metrics, performance monitoring | [api_health.md](references/api/api_health.md) |

---

### SDKs & Development Tools
| SDK | Description | Reference File |
|-----|-------------|----------------|
| JavaScript SDK | Frontend integration, React, Vue, vanilla JS | [js_sdk.md](references/sdk/js_sdk.md) |
| Go SDK | Server-side integration, custom apps | [go_sdk.md](references/sdk/go_sdk.md) |
| Dart SDK | Mobile app integration (Flutter, etc.) | [dart_sdk.md](references/sdk/dart_sdk.md) |

---

### Go Extension Framework
| Topic | Description | Reference File |
|-------|-------------|----------------|
| Go Overview | Project structure, basic concepts, getting started | [go_overview.md](references/go/go_overview.md) |
| Event Hooks | Before/After hooks, custom logic, automation | [go_event_hooks.md](references/go/go_event_hooks.md) |
| Routing | Custom API endpoints, middleware, handlers | [go_routing.md](references/go/go_routing.md) |
| Database | Query builder, transactions, advanced queries | [go_database.md](references/go/go_database.md) |
| Records | Record CRUD, validation, custom fields | [go_records.md](references/go/go_records.md) |
| Collections | Dynamic schemas, collection management | [go_collections.md](references/go/go_collections.md) |
| Migrations | Schema changes, version control, deployment | [go_migrations.md](references/go/go_migrations.md) |
| Jobs & Scheduling | Background tasks, cron jobs, queues | [go_jobs_scheduling.md](references/go/go_jobs_scheduling.md) |
| Sending Emails | SMTP configuration, templated emails | [go_sending_emails.md](references/go/go_sending_emails.md) |
| Rendering Templates | HTML templates, email templates, PDFs | [go_rendering_templates.md](references/go/go_rendering_templates.md) |
| Console Commands | CLI commands, migrations, maintenance | [go_console_commands.md](references/go/go_console_commands.md) |
| Realtime | Custom realtime logic, event handling | [go_realtime.md](references/go/go_realtime.md) |
| File System | File storage, CDN, external storage providers | [go_filesystem.md](references/go/go_filesystem.md) |
| Logging | Structured logging, monitoring, debugging | [go_logging.md](references/go/go_logging.md) |
| Testing | Unit tests, integration tests, test helpers | [go_testing.md](references/go/go_testing.md) |
| Miscellaneous | Advanced features, utilities, tips | [go_miscellaneous.md](references/go/go_miscellaneous.md) |
| Record Proxy | Dynamic record behavior, computed fields | [go_record_proxy.md](references/go/go_record_proxy.md) |

---

### Reference Materials
| File | Description | Contents |
|------|-------------|----------|
| [Security Rules](references/security_rules.md) | Comprehensive security patterns | Owner-based access, role-based access, API rules |
| [Schema Templates](references/templates/schema_templates.md) | Pre-built data models | Blog, E-commerce, Social Network, Forums, Task Management |
| [API Reference](references/api_reference.md) | Complete API documentation | All endpoints, parameters, examples |

---

### Development Resources
| Resource | Description | Location |
|----------|-------------|----------|
| Scripts | Executable utilities for development | `scripts/` directory |
| Assets | Templates and configuration files | `assets/` directory |
| Docker Config | Production-ready Docker setup | `assets/docker-compose.yml` |
| Caddy Config | Automatic HTTPS configuration | `assets/Caddyfile` |
| Frontend Template