Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.siya.com/llms.txt

Use this file to discover all available pages before exploring further.

Transform Siya into Your Personal Automation Engine

Hooks are Siya’s automation superpower - creating intelligent, event-driven workflows that respond to your actions in real-time. From auto-formatting code to deploying applications, hooks turn repetitive tasks into seamless, background magic.

​
Understanding Hooks

Event-Driven

Respond instantly to file changes, git operations, or Siya actions

Intelligent

Pattern matching and conditional logic for smart automation

Non-Blocking

Hooks run in parallel without interrupting your workflow

​
Creating Hooks

Multiple Ways to Create Powerful Automations

Choose the method that fits your style - from natural language to precise configuration

Just Tell Siya What You Want

The easiest way - describe your automation in plain English
1

Describe Your Need

Tell Siya what you want to automate
2

Siya Creates Hook

Siya generates the appropriate hook configuration
3

Instant Activation

Hook starts working immediately
"Run tests whenever I save a test file"
Siya understands context and creates appropriate patterns and commands

​
Hook Events

Rich Event System for Every Scenario

Hooks can respond to a wide variety of events in your development workflow

Available File Events

{
  "pattern": "src/**/*.ts",  // All TypeScript in src
  "pattern": "*.{js,jsx}",   // JS and JSX files
  "pattern": "!**/*.test.*", // Exclude test files
  "pattern": "docs/*.md"     // Markdown in docs
}

​
Hook Configuration

Fine-Tune Every Aspect of Your Automations

Comprehensive configuration options for precise control

Core Properties

{
  "name": "Smart executor",
  "event": "file:modified",
  "pattern": "**/*.ts",
  "command": "npm run process -- ${file}",
  
  // Execution options
  "parallel": true,           // Run commands in parallel
  "continueOnError": true,    // Don't stop on failure
  "timeout": 30000,          // 30 second timeout
  "retries": 2,              // Retry failed commands
  "retryDelay": 1000,        // Wait between retries
  "shell": "/bin/zsh",       // Specific shell
  "cwd": "${projectRoot}",   // Working directory
  "env": {                   // Environment variables
    "NODE_ENV": "test",
    "DEBUG": "true"
  }
}

Notification Channels

{
  "notifications": {
    "channels": {
      "desktop": true,
      "sound": true,
      "email": "dev@company.com",
      "slack": "#dev-alerts",
      "webhook": "https://api.company.com/hooks"
    },
    "events": {
      "start": false,    // Don't notify on start
      "success": true,   // Notify on success
      "failure": true,   // Always notify failures
      "timeout": true    // Notify on timeout
    }
  }
}

Custom Messages

{
  "notifications": {
    "templates": {
      "success": "✅ ${name} completed in ${duration}ms",
      "failure": "❌ ${name} failed: ${error}",
      "timeout": "⏱️ ${name} timed out after ${timeout}ms"
    },
    "includeOutput": true,
    "maxOutputLength": 500
  }
}

​
Hook Examples

Real-World Automation Patterns

Production-ready hook configurations for common scenarios

Code Quality Automation

{
  "hooks": [
    {
      "name": "Format on save",
      "event": "file:modified",
      "pattern": "src/**/*.{js,ts,jsx,tsx}",
      "command": "prettier --write ${file}",
      "enabled": true
    },
    {
      "name": "Lint and fix",
      "event": "file:modified",
      "pattern": "**/*.{js,ts}",
      "commands": [
        "eslint --fix ${file}",
        "tsc --noEmit --skipLibCheck"
      ],
      "continueOnError": true,
      "debounce": 1000
    },
    {
      "name": "Update imports",
      "event": "file:renamed",
      "pattern": "src/**/*.{ts,tsx}",
      "command": "node scripts/update-imports.js ${oldFile} ${newFile}"
    }
  ]
}

{
  "hooks": [
    {
      "name": "Test affected",
      "event": "file:modified",
      "pattern": "src/**/*.{js,ts}",
      "condition": "!file.includes('.test.')",
      "command": "jest --findRelatedTests ${file} --coverage",
      "notifications": {
        "failure": "desktop"
      }
    },
    {
      "name": "E2E on feature complete",
      "event": "git:push",
      "condition": "branch.startsWith('feature/')",
      "commands": [
        "npm run build",
        "npm run test:e2e -- --headless"
      ],
      "timeout": 300000
    }
  ]
}

{
  "hooks": [
    {
      "name": "Generate API docs",
      "event": "file:modified",
      "pattern": "src/api/**/*.ts",
      "command": "typedoc --entryPoints ${file} --out docs/api",
      "debounce": 5000
    },
    {
      "name": "Update README",
      "event": "siya:task:complete",
      "condition": "task.includes('feature')",
      "command": "node scripts/update-readme.js"
    }
  ]
}

​
Hook Management

Monitor and Control Your Automation Fleet

Tools and commands for managing your hooks effectively

Hook Commands

"Show all my hooks"
"List active hooks"
"What hooks are running?"
Siya provides natural language control over all hook operations
Ask “Show hook dashboard” for a real-time view of your automations
Use "dryRun": true to test hooks without executing commands

​
Advanced Hook Patterns

Master-Level Automation Techniques

Sophisticated patterns for complex automation scenarios
{
  "hooks": [
    {
      "name": "Format chain start",
      "event": "file:modified",
      "pattern": "**/*.js",
      "command": "prettier --write ${file}",
      "emitOnSuccess": "format:complete"
    },
    {
      "name": "Lint after format",
      "event": "format:complete",
      "command": "eslint --fix ${file}",
      "emitOnSuccess": "lint:complete"
    },
    {
      "name": "Test after lint",
      "event": "lint:complete",
      "command": "jest --findRelatedTests ${file}",
      "emitOnSuccess": "test:complete"
    }
  ]
}

​
Hook Security

Secure Automation Practices

Keep your automations safe and controlled

Security Best Practices

Do's

  • Validate all inputs
  • Use environment variables for secrets
  • Limit command scope
  • Regular security audits
  • Principle of least privilege
  • Log all executions

Don'ts

  • Hardcode credentials
  • Execute untrusted input
  • Disable security features
  • Grant excessive permissions
  • Skip validation
  • Ignore security warnings
{
  "hookSecurity": {
    "defaultPermissions": "restricted",
    "allowedCommands": [
      "npm", "yarn", "git", "prettier", "eslint"
    ],
    "blockedPatterns": [
      "**/secrets/**",
      "**/*.key",
      "**/*.pem"
    ],
    "requireConfirmation": [
      "rm -rf",
      "deploy:production",
      "database:migrate"
    ],
    "sandboxMode": {
      "enabled": true,
      "allowNetwork": false,
      "allowFileWrite": ["./tmp", "./dist"]
    }
  }
}

​
Future of Hooks

The Evolution of Intelligent Automation

Exciting developments coming to Siya’s hook system

Coming Soon

Enhanced Capabilities
  • Visual hook builder
  • Hook marketplace
  • AI-powered hook suggestions
  • Cross-project hook sharing
Advanced Features
  • Distributed execution
  • Hook versioning
  • A/B testing for hooks
  • Performance analytics

Experimental

Next-Gen Automation
  • Predictive triggering
  • Self-healing hooks
  • Natural language conditions
  • Voice-activated hooks
Integration Expansion
  • Cloud platform hooks
  • IoT device triggers
  • Calendar integration
  • Biometric triggers

​
Summary

Automation Mastery Unlocked

Hooks transform Siya from an AI assistant into a complete automation platform. By responding intelligently to events in your workflow, hooks eliminate repetitive tasks and enforce best practices automatically. Whether you’re formatting code, running tests, or deploying applications, hooks work tirelessly in the background to keep your development process smooth and efficient.

Next: Advanced Topics

Master advanced Siya techniques

Hook Library

Browse community hook examples
Automate everything. Focus on what matters.