genbox.yaml Schema

version: 4

project:
  name: myapp                    # Required: Project name
  description: My application    # Optional: Description
  structure: monorepo            # Required: Project structure

apps:
  frontend:
    path: ./web                  # Required: Relative path
    type: frontend               # Required: App type
    port: 3000                   # Port (or $detect)
    framework: nextjs            # Framework (or $detect)
    runner: pm2                  # How to run: pm2, docker, node
    description: Customer website
 
    commands:                    # Build/run commands
      install: pnpm install
      dev: pnpm dev
      build: pnpm build
      start: pnpm start
 
    connects_to:                 # Dependencies
      api:
        mode: local              # local, staging, production
        env:
          NEXT_PUBLIC_API_URL: http://localhost:3050
 
    env:                         # Env var files to load
      - .env
      - .env.local

provides:
  mongodb:
    type: database
    image: mongo:7
    port: 27017
    data_dir: /data/db          # Optional: Data directory
    env:                         # Container env vars
      MONGO_INITDB_ROOT_USERNAME: root
      MONGO_INITDB_ROOT_PASSWORD: secret
 
  redis:
    type: cache
    image: redis:7-alpine
    port: 6379
 
  rabbitmq:
    type: queue
    image: rabbitmq:3-management
    port: 5672
    additional_ports:
      management: 15672

environments:
  staging:
    description: Staging environment
    urls:
      api: https://api.staging.example.com
      admin: https://admin.staging.example.com
    env:
      MONGODB_URI: ${STAGING_MONGODB_URI}
 
  production:
    description: Production (read-only)
    urls:
      api: https://api.example.com
    safety:
      read_only: true
      require_confirmation: true

profiles:
  quick:
    description: Frontend only, staging backend
    size: small
    apps:
      - frontend
    default_connection: staging
 
  full:
    description: Full stack with local DB
    extends: quick              # Inherit from another profile
    size: large
    apps:
      - frontend
      - backend
    default_connection: local
    database:
      mode: copy
      source: staging
      exclude:
        - logs
        - sessions
 
  api-dev:
    description: Backend development
    size: medium
    apps:
      - backend
    connections:
      backend:
        mongodb: local
        redis: staging

defaults:
  size: medium
  branch: main
  database:
    mode: copy
    source: staging
  connection_mode: local
  install_claude_code: true
  inject_claude_auth: true

hooks:
  post_checkout:
    - command: pnpm install
      workdir: ${APP_PATH}
 
  post_create:
    - command: ./scripts/setup.sh
      run_as: root
 
  pre_start:
    - command: pnpm build
      workdir: /home/dev/myapp/web
 
  post_start:
    - command: docker-compose up -d
      workdir: /home/dev/myapp/api
      condition: apps.api
 
  pre_destroy:
    - command: ./scripts/cleanup.sh

repos:
  main:
    url: git@github.com:org/main.git
    path: /home/dev/myapp
    branch: main
    apps:
      - frontend
      - backend
 
  shared:
    url: git@github.com:org/shared-libs.git
    path: /home/dev/shared
    branch: main
 
git_auth:
  method: ssh                   # ssh or token
  ssh_key_path: ~/.ssh/id_rsa

strict:
  enabled: true
  allow_detect: true           # Allow $detect markers
  warnings_as_errors: false    # Treat warnings as errors