Developer Documentation

These docs are for contributors and maintainers. They cover internal architecture, implementation details, and design decisions.

For user-facing documentation, see the main docs.

Core Modules

• Project Discovery - Finding project root from any directory
• Change Management - Versioned changes with forward/revert
• Configuration - Multi-source config resolution
• Runner - SQL file execution with checksums
• Settings - Project-wide configuration
• State - Encrypted local state storage

Features

• Database Explorer - Schema introspection
• SQL Terminal - Interactive REPL
• Templates - Eta templating engine
• Secrets - Encrypted secret storage
• Vault - Team-shared encrypted secrets
• Locking - Concurrency control
• Teardown - Database reset operations
• Data Transfer - Cross-database data transfer
• Config Sharing - Exporting and importing configs

Integration

• SDK - Programmatic API
• CLI Architecture - citty command tree and how to add commands
• CI/CD - Pipeline patterns
• Identity - Audit and cryptographic identity

Reference

• Data Model - Types and schemas
• Logger - Event-based logging
• Versioning - Schema migrations