Skip to content
anouk

Quickstart

From install to a live extension in six steps.

Around ten minutes, no backend to deploy. The user supplies their own provider key at runtime.

  1. 1

    Install the CLI

    Install anouk globally from npm so the anouk command is on your PATH.

    npm install -g anouk
  2. 2

    Scaffold an extension

    Generate a Manifest V3 project with the AI service, config manager, and settings panel pre-wired.

    anouk init my-ai-extension
    cd my-ai-extension
  3. 3

    Build the bundle

    esbuild bundles src/* to dist/. This is the folder you load into the browser.

    npm install
    npm run build
  4. 4

    Load it unpacked

    Open chrome://extensions, enable Developer mode, choose "Load unpacked", and select the dist/ folder.

    # chrome://extensions → Developer mode → Load unpacked → dist/
  5. 5

    Set your provider

    Open the extension's settings panel and enter a provider URL, API key, and model. Values persist in chrome.storage.local.

    // providerUrl: https://api.openai.com/v1/chat/completions
    // apiKey: sk-...
    // model: gpt-4o-mini
  6. 6

    Call the model

    From a content script or background worker, import AIService and make a call. Anouk handles config, cache, queue, and the request.

    import { AIService } from 'anouk';
    
    const out = await AIService.call(
      'Summarize this in one sentence',
      document.body.innerText,
      `summary_${location.href}`
    );

Already have an extension?

Skip the scaffold. Install the runtime and import only the pieces you need.

npm install anouk

import { AIService, configManager, settingsPanel } from 'anouk';