@aiderdesk/extensions

TypeScript type definitions and examples for building AiderDesk extensions.

Installation

npm install @aiderdesk/extensions
# or
yarn add @aiderdesk/extensions
# or
pnpm add @aiderdesk/extensions

Usage

Import both types and runtime values from a single entry point:

import type { Extension, ExtensionContext, ToolDefinition } from '@aiderdesk/extensions';
import { ToolApprovalState } from '@aiderdesk/extensions';
import { z } from 'zod';

export default class MyExtension implements Extension {
  async onLoad(context: ExtensionContext) {
    context.log('Extension loaded!', 'info');
    
    // Runtime values are available too
    const approval = ToolApprovalState.Always;
  }
}

Note: The package provides both TypeScript type definitions and runtime JavaScript values (like enum values) from the same entry point. You can use import type for type-only imports, or regular imports for runtime values.

Example Extensions

This directory contains example extensions demonstrating various capabilities of the AiderDesk extension system.

Documentation

For comprehensive documentation on creating and using extensions, see the Extensions documentation:

• Extensions Overview - What extensions can do
• Creating Extensions - How to build extensions
• Installation Guide - Install extensions globally or per-project
• API Reference - Complete API documentation
• Events Reference - All available events
• Examples Gallery - Browse all examples

Example Extensions

Quick Start

1. Install an Extension

The easiest way to install extensions is using the CLI:

# Interactive selection - choose from all available extensions
npx @aiderdesk/extensions install

# Install a specific extension by ID
npx @aiderdesk/extensions install sound-notification

# Install to global extensions (available to all projects)
npx @aiderdesk/extensions install sound-notification --global

# Install from a URL (e.g., your own repository)
npx @aiderdesk/extensions install https://raw.githubusercontent.com/username/my-extension/main/my-extension.ts

Alternatively, manually copy extension files:

# Global extensions (available to all projects)
cp extensions/sound-notification.ts ~/.aider-desk/extensions/

# Project-specific extensions
cp extensions/sound-notification.ts .aider-desk/extensions/

2. Hot Reload

Extensions are automatically reloaded when files change. No restart needed!