Skip to content

CLI Reference

Manage databases, branches, and schema from the command line.

Getting Started

# Initialize project
cinch init myproject && cd myproject

# Check status
cinch status

Commands

Project & Database

  • cinch init - Initialize new project
  • cinch db - Database operations (list, create, use, delete)

Schema Management

Branching & Tenancy

Code Generation

Quick Reference

Task Command
Initialize project cinch init myapp
Create table cinch table create users name:TEXT email:TEXT
Query data cinch query "SELECT * FROM users"
Create branch cinch branch create feature-auth --switch
Merge to main cinch branch merge-into-main feature-auth
Multi-tenant query cinch query "SELECT * FROM users" --tenant customer_a
Generate SDK cinch codegen generate python models/

Common Workflows

Feature Development

# Create feature branch
cinch branch create add-products --switch

# Make changes
cinch table create products name:TEXT price:REAL category:TEXT
cinch insert products --data '{"name": "Laptop", "price": 999.99, "category": "electronics"}'

# Test changes
cinch query "SELECT * FROM products"

# Merge when ready
cinch branch switch main
cinch branch merge-into-main add-products

Multi-Tenant Setup

# Create tenants
cinch tenant create customer_a
cinch tenant create customer_b

# Add tenant-specific data
cinch insert users --tenant customer_a --data '{"name": "John", "email": "john@customer-a.com"}'
cinch insert users --tenant customer_b --data '{"name": "Jane", "email": "jane@customer-b.com"}'

# Query per tenant
cinch query "SELECT * FROM users" --tenant customer_a

Global Options

  • --help - Show command help
  • --tenant TENANT - Target specific tenant (for data operations)
  • --format FORMAT - Output format: table, json, csv (for queries)

Need Help?

cinch --help              # General help
cinch <command> --help    # Command-specific help

Next Steps