Module Reference

Stacks.js is split across first-party framework packages under the @stacksjs/ scope. The pinned source manifest inventories 90 versioned package manifests across the repository; that count describes packaging scope, not protocol conformance or production fitness. Framework packages generally:

• Exposes a defined interface — The TypeScript types serve as the specification
• Is independently usable — Use any module in any TypeScript project
• Follows consistent patterns — Shared conventions across all modules
• Supports driver-based extensibility — Implement custom backends where applicable

Core Framework Modules

Application & Configuration

HTTP & Routing

Database & ORM

Authentication & Security

Caching & Performance

Queue & Background Jobs

Events & Real-Time

Email & Communication

Storage & Files

AI & Intelligence

Frontend & UI

CLI & Developer Tools

Build & Deployment

Desktop & Mobile

Dashboard & Admin

Content & Commerce

Analytics & Monitoring

Search & Discovery

Date, Time & Formatting

Data Structures & Utilities

Testing & Quality

Networking & DNS

Documentation

Error Handling

Version Control

Social & External Services

Plugin System

Configuration Reference

All configuration files are located in config/ and use TypeScript for type safety.

CLI Command Reference

Development

buddy dev                    # Start development server with hot reload
buddy dev --port 3001        # Use custom port
buddy dev --https            # Enable HTTPS
buddy serve                  # Start production server
buddy tinker                 # Interactive REPL
buddy repl                   # Alternative REPL command

Building & Testing

buddy build                  # Build for production
buddy build --analyze        # Build with bundle analysis
buddy test                   # Run test suite
buddy test:watch             # Run tests in watch mode
buddy test:coverage          # Run with coverage report
buddy lint                   # Run linters
buddy lint:fix               # Fix linting issues
buddy typecheck              # Check TypeScript types
buddy types:generate         # Generate type definitions

Database

buddy migrate                # Run pending migrations
buddy migrate:fresh          # Drop all and re-migrate
buddy migrate:rollback       # Rollback last batch
buddy migrate:status         # Show migration status
buddy seed                   # Run database seeders
buddy db:wipe                # Drop all tables
buddy db:backup              # Backup database
buddy make:migration         # Create migration file
buddy make:model             # Create model with migration
buddy make:seeder            # Create seeder file

Code Generation

buddy make:controller        # Create controller
buddy make:model             # Create model
buddy make:action            # Create action
buddy make:middleware        # Create middleware
buddy make:event             # Create event
buddy make:listener          # Create listener
buddy make:job               # Create job
buddy make:notification      # Create notification
buddy make:component         # Create STX component
buddy make:command           # Create CLI command

Cache & Queue

buddy cache:clear            # Clear application cache
buddy cache:table            # Create cache database table
buddy queue:work             # Start queue worker
buddy queue:listen           # Listen for jobs (dev)
buddy queue:restart          # Restart queue workers
buddy queue:failed           # List failed jobs
buddy queue:retry            # Retry failed jobs
buddy queue:flush            # Flush failed jobs
buddy schedule:run           # Run scheduled tasks
buddy schedule:list          # List scheduled tasks

Broadcasting & Real-Time

buddy broadcast:serve        # Start WebSocket server
buddy broadcast:serve --host=0.0.0.0  # Bind to all interfaces
buddy broadcast:serve --port=6001     # Custom port
buddy broadcast:serve --tls           # Enable TLS
buddy broadcast:status       # Show WebSocket server status
buddy broadcast:channels     # List active channels
buddy broadcast:connections  # List active connections

Cloud & Deployment

buddy deploy                 # Deploy application
buddy deploy --env=staging   # Deploy to staging
buddy cloud:up               # Provision infrastructure
buddy cloud:down             # Tear down infrastructure
buddy cloud:status           # Show infrastructure status
buddy cloud:ssh              # SSH into server
buddy cloud:logs             # View cloud logs
buddy cloud:secret           # Manage secrets

Security & Keys

buddy key:generate           # Generate application key
buddy dev:cert               # Generate dev SSL certificate
buddy dev:cert --trust       # Trust the certificate

Publishing & Release

buddy release                # Create new release
buddy release:patch          # Patch version bump
buddy release:minor          # Minor version bump
buddy release:major          # Major version bump
buddy publish                # Publish packages
buddy changelog              # Generate changelog

AI Assistant

buddy ai                     # Start AI assistant
buddy ai:chat                # Interactive chat mode
buddy ai:generate            # Generate code with AI
buddy ai:review              # AI code review

Utilities

buddy doctor                 # Check system health
buddy upgrade                # Upgrade Stacks
buddy config:show            # Show configuration
buddy config:validate        # Validate configuration
buddy route:list             # List all routes
buddy storage:link           # Create storage symlink
buddy profile                # Profile application
buddy profile:cpu            # CPU profiling
buddy profile:memory         # Memory profiling

Search

buddy search:index           # Index searchable models
buddy search:flush           # Flush search index
buddy search:import          # Import data to search

i18n

buddy i18n:extract           # Extract translatable strings
buddy i18n:check             # Check for missing translations
buddy i18n:sync              # Sync translation files

SEO

buddy seo:sitemap            # Generate sitemap
buddy seo:check              # Check SEO configuration

Module Usage Examples

Actions Pattern

import { Action } from '@stacksjs/actions'

export default new Action({
  name: 'CreateUser',
  description: 'Create a new user account',

  rules: {
    email: 'required|email|unique:users',
    password: 'required|min:8',
  },

  async handle({ email, password }) {
    return await User.create({ email, password })
  }
})

Events & Listeners

// Event definition
import { Event } from '@stacksjs/events'

export const UserRegistered = new Event({
  name: 'UserRegistered',
  listeners: ['SendWelcomeEmail', 'NotifyAdmins'],
})

// Dispatching
await UserRegistered.dispatch({ user })

Scheduled Tasks

// config/scheduler.ts
export default {
  tasks: [
    {
      command: 'cache:clear',
      schedule: '0 0 * * *', // Daily at midnight
    },
    {
      job: 'CleanupTempFiles',
      schedule: '*/30 * * * *', // Every 30 minutes
    },
  ]
}

Health Checks

// config/health.ts
export default {
  checks: [
    'database',
    'cache',
    'queue',
    'storage',
    {
      name: 'custom',
      check: async () => {
        // Custom health check logic
        return { healthy: true }
      }
    }
  ]
}

Plugin System

// plugins/my-plugin.ts
import { Plugin } from '@stacksjs/plugins'

export default new Plugin({
  name: 'my-plugin',

  boot() {
    // Plugin initialization
  },

  register() {
    // Register services
  }
})