| title | CLI Reference |
|---|---|
| description | Command reference for Quackback development and operations |
| icon | terminal |
Command reference for Quackback development and operations.
bun run devStarts the development server at http://localhost:3000.
Options:
- Hot reloading enabled
- Source maps enabled
- OTP codes printed to console
bun run buildCreates optimized production build in .output/.
bun run previewPreview the production build locally. Run from apps/web/ directory.
bun run startStarts the production server. Requires bun run build first. Run from apps/web/ directory.
bun run db:migrateApplies pending database migrations. Safe to run multiple times.
bun run db:check-driftApplies every migration to a scratch database and fails if the result differs from the TypeScript schema in packages/db/src/schema/. Migrations are hand-written SQL; don't use db:generate. See Write a Migration.
bun run db:studioOpens visual database browser at https://local.drizzle.studio.
bun run db:seedPopulates database with demo workspace and sample data.
bun run db:resetbun run lintRuns ESLint checks. Exits with error if issues found.
cd apps/web && bun run typecheckRuns TypeScript compiler in check mode. No output if successful. Must be run from apps/web/ directory.
bun run testRuns Vitest unit tests. By default runs in watch mode.
bun run test path/to/test.tsRuns a specific test file.
bun run test:e2eRuns Playwright end-to-end tests in headless mode.
cd apps/web && bun run test:e2e:uiOpens Playwright's interactive test UI. Must be run from apps/web/ directory.
cd apps/web && bun run test:e2e:headedRuns E2E tests in visible browser windows. Must be run from apps/web/ directory.
bun run setupOne-time setup script:
- Checks prerequisites
- Installs dependencies
- Creates
.envfrom template - Generates auth secret
- Starts PostgreSQL
- Runs migrations
bun installInstalls all project dependencies.
docker compose up -dStarts the local development datastores (PostgreSQL, object storage, and a mail catcher) in the background. This compose file has no app service; for production use docker-compose.prod.yml.
docker compose logs -fFollow logs from all services.
docker compose -f docker-compose.prod.yml logs app --tail 100View the last 100 lines from the app in the production stack.
docker compose downStops and removes containers (preserves volumes).
docker compose down -vdocker compose build --no-cacheRebuilds Docker images from scratch.
# Copy template
cp .env.example .env
# Generate secret
openssl rand -base64 32bun run import intermediate --posts posts.csv --quackback-url https://feedback.example.com --quackback-key qb_...Imports posts, comments, votes, and notes from CSV files through the REST API. Run with --help for all options.
bun run db:generate-csvGenerates sample CSV data for testing imports.
bun run ai:backfillBackfill AI-generated data (embeddings, sentiment) for existing posts.
bun run merge:backfillGenerate duplicate-merge suggestions for existing posts.
| Command | Description |
|---|---|
bun run dev |
Start dev server |
bun run build |
Production build |
bun run db:migrate |
Run migrations |
bun run db:studio |
Database browser |
bun run db:seed |
Seed demo data |
bun run db:reset |
Reset database |
bun run lint |
Check code quality |
bun run test |
Run unit tests |
bun run test:e2e |
Run E2E tests |
bun run setup |
Initial setup |
bun run import |
Import data CLI |
# Ensure Bun is installed
curl -fsSL https://bun.sh/install | bash
# Restart shell or source profile
source ~/.bashrc# Fix script permissions
chmod +x scripts/*.sh# Find process
lsof -i :3000
# Kill it
kill -9 <PID>- Development Setup - Full setup guide
- Environment Variables - Configuration
- Docker Deployment - Production deployment