插件 - OpenCode Docs | OpenCode Tutorial

插件允许您通过挂钩各种事件和自定义行为来扩展 OpenCode。您可以创建插件来添加新功能、与外部服务集成或修改 OpenCode 的默认行为。

有关示例，请查看社区创建的插件。

##使用插件

有两种方式加载插件。

###从本地文件

将 JavaScript 或 TypeScript 文件放置在插件目录中。

.opencode/plugins/ - 项目级插件
~/.config/opencode/plugins/ - 全局插件

这些目录中的文件在启动时自动加载。

###从 npm

在配置文件中指定 npm 包。

bash

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

支持常规和带作用域的 npm 包。

在生态系统中浏览可用插件。

###插件如何安装

npm 插件在启动时使用 Bun 自动安装。包及其依赖项缓存在 ~/.cache/opencode/node_modules/ 中。

本地插件直接从插件目录加载。要使用外部包，您必须在配置目录中创建 package.json（参见依赖项），或将插件发布到 npm 并将其添加到配置中。

###加载顺序

插件从所有来源加载，所有钩子按顺序运行。加载顺序是：

全局配置 (~/.config/opencode/opencode.json)
项目配置 (opencode.json)
全局插件目录 (~/.config/opencode/plugins/)
项目插件目录 (.opencode/plugins/)

名称和版本相同的重复 npm 包只加载一次。但是，名称相似的本地插件和 npm 插件会分别加载。

##创建插件

插件是一个 JavaScript/TypeScript 模块，它导出一个或多个插件函数。每个函数接收一个上下文对象并返回一个钩子对象。

###依赖项

本地插件和自定义工具可以使用外部 npm 包。在配置目录中添加一个 package.json，包含所需的依赖项。

bash

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

OpenCode 在启动时运行 bun install 来安装这些依赖。然后您的插件和工具可以导入它们。

bash

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

###基本结构

bash

  console.log("Plugin initialized!")

  return {
    // 钩子实现放在这里
  }
}

插件函数接收：

project：当前项目信息。
directory：当前工作目录。
worktree：git 工作树路径。
client：用于与 AI 交互的 opencode SDK 客户端。
$：Bun 的 shell API，用于执行命令。

###TypeScript 支持

对于 TypeScript 插件，您可以从插件包导入类型：

bash

  return {
    // 类型安全的钩子实现
  }
}

###事件

插件可以订阅事件，如下面的示例部分所示。以下是可用的不同事件列表。

命令事件

command.executed

文件事件

file.edited
file.watcher.updated

安装事件

installation.updated

LSP 事件

lsp.client.diagnostics
lsp.updated

消息事件

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

权限事件

permission.replied
permission.updated

服务器事件

server.connected

会话事件

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

待办事项事件

todo.updated

工具事件

tool.execute.after
tool.execute.before

TUI 事件

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

##示例

以下是一些可用于扩展 opencode 的插件示例。

###发送通知

在某些事件发生时发送通知：

bash

  return {
    event: async ({ event }) => {
      // 会话完成时发送通知
      if (event.type === "session.idle") {
        await $`osascript -e 'display notification "Session completed!" with title "opencode"'`
      }
    },
  }
}

我们使用 osascript 在 macOS 上运行 AppleScript。这里我们用它来发送通知。

Note

📝 Note

如果您使用 OpenCode 桌面应用程序，它可以在响应准备就绪或会话出错时自动发送系统通知。

###.env 保护

防止 opencode 读取 .env 文件：

bash

  return {
    "tool.execute.before": async (input, output) => {
      if (input.tool === "read" && output.args.filePath.includes(".env")) {
        throw new Error("Do not read .env files")
      }
    },
  }
}

###自定义工具

插件还可以向 opencode 添加自定义工具：

bash

  return {
    tool: {
      mytool: tool({
        description: "This is a custom tool",
        args: {
          foo: tool.schema.string(),
        },
        async execute(args, ctx) {
          return `Hello ${args.foo}!`
        },
      }),
    },
  }
}

tool 辅助函数创建一个 opencode 可以调用的自定义工具。它接受一个 Zod schema 函数并返回一个工具定义，包含：

description：工具的功能描述
args：工具参数的 Zod schema
execute：调用工具时运行的函数

您的自定义工具将与内置工具一起在 opencode 中可用。

###日志记录

使用 client.app.log() 代替 console.log 进行结构化日志记录：

bash

  await client.app.log({
    service: "my-plugin",
    level: "info",
    message: "Plugin initialized",
    extra: { foo: "bar" },
  })
}

级别：debug、info、warn、error。详情请参见 SDK 文档。

###压缩钩子

自定义会话压缩时包含的上下文：

bash

  return {
    "experimental.session.compacting": async (input, output) => {
      // 向压缩提示注入额外上下文
      output.context.push(`
## 自定义上下文

包含应在压缩后保持的任何状态：
- 当前任务状态
- 已做出的重要决定
- 正在处理的文件
`)
    },
  }
}

experimental.session.compacting 钩子在 LLM 生成延续摘要之前触发。使用它注入默认压缩提示可能遗漏的特定领域上下文。

您还可以通过设置 output.prompt 完全替换压缩提示：

bash

  return {
    "experimental.session.compacting": async (input, output) => {
      // 替换整个压缩提示
      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.
`
    },
  }
}

当设置 output.prompt 时，它完全替换默认压缩提示。在这种情况下，output.context 数组被忽略。