Wtyczki

Napisz własną wtyczkę, aby rozszerzyć aicippy-code.

Wtyczki umożliwiające wyłączenie aicippy-code poprzez podjęcie różnych zdarzeń i zachowanie. Można utworzyć wtyczkę, aby sprawdzić nowe funkcje, integrować się z usługami lub sprawdzaniem zachowania aicippy-code.

Aby znaleźć się z przykładami, przejrzyj wtyczki utworzone przez społeczność.

Użyj wtyczki

Istnieją dwa sposoby ładowania wtyczek.

Z plików lokalnych

Miejsce plików JavaScript lub TypeScript w katalogu wtyczki.

.aicippy-code/plugins/ - Wtyczki na poziomie projektu
~/.config/aicippy-code/plugins/ - Wtyczki globalne

Pliki w tych katalogach są automatycznie ładowane podczas uruchamiania.

Z npm

szczegółowy pakiet npm w pliku konfiguracyjnym.

{
  "$schema": "./schema/aicippy-code.json",
  "plugin": ["opencode-helicone-session", "opencode-wakatime", "@my-org/custom-plugin"]
}

Obsługiwane są zarówno pakiety zwykłe, jak i pakiety npm o określonym zakresie.

Przeglądaj dostępną wtyczkę w ekosystemie.

Sposób instalacji wtyczek

wtyczki npm są instalowane automatycznie przy użyciu Bun podczas uruchamiania. Pakiety i ich zależności są buforowane w ~/.cache/aicippy-code/node_modules/.

Wtyczki lokalne są ładowane bezpośrednio z katalogu wtyczek. Aby uzyskać dostęp do zewnętrznych pakietów, musisz zainstalować package.json w swoim katalogu konfiguracyjnym (zobacz Zależności) lub opublikować wtyczkę w npm i dodaj ją do swojej konfiguracji.

Kolejność ładowania

Wtyczki są ładowane ze wszystkich źródeł, a wszystkie hooki napisane po kolei. Kolejność ładowania do:

Konfiguracja globalna (~/.config/aicippy-code/aicippy-code.json)
Konfiguracja projektu (aicippy-code.json)
Globalny katalog wtyczek (~/.config/aicippy-code/plugins/)
Katalog wtyczek projektu (.aicippy-code/plugins/)

Zduplikowane pakiety npm o tej samej nazwie i wersji są ładowane raz. Równie ważny jest dostęp lokalny i zewnętrzny npm o dodatkowych nazwach, które są zewnętrzne.

Utwórz wtyczkę

Wtyczka do moduł JavaScript/TypeScript, który eksportuje jeden lub więcej wtyczek funkcje. dostępna funkcja korzystania z obiektu kontekstu i głównego obiektu hooks.

Zależności

Lokalne narzędzie i narzędzie, które można wykorzystać z zewnętrznych pakietów npm. Dodaj package.json do swojego katalogu konfiguracyjnego z zależnościami.

{
  "dependencies": {
    "shescape": "^2.1.0"
  }
}

aicippy-code uruchomienie bun install przy uruchomieniu, aby je uruchomić. Twoje dodatkowe funkcje będą dostępne po zaimportowaniu.

import { escape } from "shescape"

export const MyPlugin = async (ctx) => {
  return {
    "tool.execute.before": async (input, output) => {
      if (input.tool === "bash") {
        output.args.command = escape(output.args.command)
      }
    },
  }
}

Podstawowa struktura

export const MyPlugin = async ({ project, client, $, directory, worktree }) => {
  console.log("Plugin initialized!")

  return {
    // Hook implementations go here
  }
}

Funkcja dostępu do:

project: Aktualne informacje o projekcie.
directory: Bieżący katalog roboczy.
worktree: Ścieżka eksploatacyjna Git.
client: Klient SDK z aicippy-code do sztucznej inteligencji.
$: API obudowy Buna do wykonywania oprogramowania.

Obsługa TypeScriptu

W przypadku wtyczek TypeScript możesz importować typy z pakietu wtyczek:

import type { Plugin } from "@aicippy-code/plugin"

export const MyPlugin: Plugin = async ({ project, client, $, directory, worktree }) => {
  return {
    // Type-safe hook implementations
  }
}

Wydarzenia

Wtyczki mogą subskrybować zdarzenia, jak zastosować poniżej sekcji Przykłady. Oto lista różnych działań.

Wydarzenia dowodzenia

command.executed

Plik Wydarzenia

file.edited
file.watcher.updated

Wydarzenia instalacyjne

installation.updated

Wydarzenia LSP

lsp.client.diagnostics
lsp.updated

Wydarzenia w wiadomościach

message.part.removed
message.part.updated
message.removed
message.updated

Wydarzenia związane z uprawnieniami

permission.asked
permission.replied

Wydarzenia serwerowe

server.connected

Wydarzenia sesyjne

session.created
session.compacted
session.deleted
session.diff
session.error
session.idle
session.status
session.updated

Wydarzenia do zrobienia

todo.updated

Wydarzenia shell

shell.env

Wydarzenia narzędziowe

tool.execute.after
tool.execute.before

Wydarzenia TUI

tui.prompt.append
tui.command.execute
tui.toast.show

Przykłady

Oto kilka dostępnych wtyczek, które można udostępnić do aicippy-code.

Wysyłaj powiadomienia

Wysyłaj powiadomienia, gdy wystąpią określone zdarzenia:

export const NotificationPlugin = async ({ project, client, $, directory, worktree }) => {
  return {
    event: async ({ event }) => {
      // Send notification on session completion
      if (event.type === "session.idle") {
        await $`osascript -e 'display notification "Session completed!" with title "opencode"'`
      }
    },
  }
}

Używamy osascript do uruchamiania AppleScript na macOS. Tutaj możesz przejść do wysyłania pozostałości.

ochrona .env

Zablokuj aicippy-code czytanie plików .env:

export const EnvProtection = async ({ project, client, $, directory, worktree }) => {
  return {
    "tool.execute.before": async (input, output) => {
      if (input.tool === "read" && output.args.filePath.includes(".env")) {
        throw new Error("Do not read .env files")
      }
    },
  }
}

Wstrzyknij zmienne środowiskowe

Wstrzyknij zmienne konsekwencje dla wszystkich wykonań (narzędzia AI i terminale użytkownika):

export const InjectEnvPlugin = async () => {
  return {
    "shell.env": async (input, output) => {
      output.env.MY_API_KEY = "secret"
      output.env.PROJECT_ROOT = input.cwd
    },
  }
}

Niestandardowe narzędzia

Wtyczki mogą również dodawać niestandardowe narzędzia do opencode:

import { type Plugin, tool } from "@aicippy-code/plugin"

export const CustomToolsPlugin: Plugin = async (ctx) => {
  return {
    tool: {
      mytool: tool({
        description: "This is a custom tool",
        args: {
          foo: tool.schema.string(),
        },
        async execute(args, context) {
          const { directory, worktree } = context
          return `Hello ${args.foo} from ${directory} (worktree: ${worktree})`
        },
      }),
    },
  }
}

Pomocnik tool tworzy narzędzie użytkowe, które może wywołać kod aicippy-code. Pobierane schematu Zoda i narzędzie wyszukiwania za pomocą:

description: Co robi do narzędzia
args: Schemat Zoda dla narzędzi argumentów
execute: Funkcja uruchamiania po wywołaniu narzędzia

Twoje narzędzie będzie dostępne dla otwartego kodu wraz z narzędziami użytkowymi.

Logowanie

użyj client.app.log() zamiast console.log do rejestracji strukturalnego:

export const MyPlugin = async ({ client }) => {
  await client.app.log({
    body: {
      service: "my-plugin",
      level: "info",
      message: "Plugin initialized",
      extra: { foo: "bar" },
    },
  })
}

Poziomy: debug, info, warn, error. Aby uzyskać szczegółowe informacje, zobacz dokumentację pakietu SDK.

Haki zagęszczające

Dostosuj kontekst dołączony podczas kompaktowania sesji:

import type { Plugin } from "@aicippy-code/plugin"

export const CompactionPlugin: Plugin = async (ctx) => {
  return {
    "experimental.session.compacting": async (input, output) => {
      // Inject additional context into the compaction prompt
      output.context.push(`
## Custom Context

Include any state that should persist across compaction:
- Current task status
- Important decisions made
- Files being actively worked on
`)
    },
  }
}

Hak experimental.session.compacting jest uruchamiany, zanim LLM wygeneruje podsumowanie kontynuacji. go, aby wstrzyknąć kontekst kontekstu dla domeny, której nie dostrzeżono przez domyślny monit o zagęszczenie.

Można także umieścić kompletny monit o zagęszczenie, ustawiając output.prompt:

import type { Plugin } from "@aicippy-code/plugin"

export const CustomCompactionPlugin: Plugin = async (ctx) => {
  return {
    "experimental.session.compacting": async (input, output) => {
      // Replace the entire compaction prompt
      output.prompt = `
You are generating a continuation prompt for a multi-agent swarm session.

Summarize:
1. The current task and its status
2. Which files are being modified and by whom
3. Any blockers or dependencies between agents
4. The next steps to complete the work

Format as a structured prompt that a new agent can use to resume work.
`
    },
  }
}

Gdy urządzenie jest output.prompt, jest całkowicie dostępne na domyślnym monit o zagęszczanie. Tablica output.context jest w tym przypadku poniesiona.