convex-cli

# Convex CLI Guide

Convex is a serverless backend platform with a built-in real-time database. This guide provides essential workflows and quick references for common Convex operations.

## Quick Start

```bash
# Check CLI installation
convex --version

# Authenticate with Convex
convex login

# Initialize new project
convex init

# Start local development
convex dev

# Deploy to production
convex deploy

# View deployment status
convex deployments list
```

## Common Workflows

### Workflow 1: Local Development Setup

```bash
# Login and initialize
convex login
convex init

# Start dev server with hot reload
convex dev

# Dev server runs at http://localhost:3210
# Changes to functions auto-reload
# Dashboard shows data and logs in real-time
```

### Workflow 2: Develop and Deploy Functions

```bash
# Create function in convex/queries/ or convex/mutations/

# Test function locally
convex run queries/getUser --args '{"id": "123"}'

# Deploy to production
convex deploy --typecheck

# Monitor logs
convex logs --prod --follow
```

### Workflow 3: Environment Configuration

```bash
# Set API keys for current environment
convex env set API_KEY sk_test_123
convex env set DATABASE_URL postgres://...

# Set production secrets
convex env set SECRET_KEY value --prod

# List all variables
convex env list
```

### Workflow 4: Data Import & Export

```bash
# Export data before major changes
convex export --all --output backup.json

# Import seed data
convex import users seed-users.json

# Batch import multiple tables
convex import --all data/

# Backup production data
convex export --all --prod --output prod-backup.json
```

### Workflow 5: Debugging Production Issues

```bash
# Stream production logs
convex logs --prod --follow

# Filter logs by function
convex logs --function myFunction --level error

# Test function in production
convex run queries/getUser --args '{"id": "123"}' --prod

# View all function executions
convex dashboard --logs
```

## Decision Tree

**When to us