zerobyte/AGENTS.md

AGENTS.md

Important instructions

• Never create migration files manually. Always use the provided command to generate migrations
• If you realize an automated migration is incorrect, make sure to remove all the associated entries from the _journal.json and the newly created files located in app/drizzle/ before re-generating the migration
• The dev server is running at http://localhost:3000. Username is admin and password is password

Project Overview

Zerobyte is a backup automation tool built on top of Restic that provides a web interface for scheduling, managing, and monitoring encrypted backups. It supports multiple volume backends (NFS, SMB, WebDAV, SFTP, local directories) and repository backends (S3, Azure, GCS, local, and rclone-based storage).

Type Checking

# Run type checking and generate React Router types
bun run tsc

Testing

# Run all tests
bun run test

# Run a specific test file
bunx dotenv-cli -e .env.test -- bun test --preload ./app/test/setup.ts path/to/test.ts

Building

# Build for production
bun run build

Database Migrations

# Generate new migration from schema changes
bun gen:migrations

# Generate a custom empty migration
bunx drizzle-kit generate --custom --name=fix-timestamps-to-ms

API Client Generation

bun run gen:api-client

Code Quality

# Format
bunx oxfmt format --write <path>

# Lint
bun run lint