Plugins

Plugins allow you to extend codeflow by hooking into various events and customizing behavior. You can create plugins to add new features, integrate with external services, or modify codeflow’s default behavior.

---

Create a plugin

A plugin is a JavaScript/TypeScript module that exports one or more plugin functions. Each function receives a context object and returns a hooks object.

---

Location

Plugins are loaded from:

1. .codeflow/plugin directory either in your project
2. Or, globally in ~/.config/codeflow/plugin

---

Basic structure

.codeflow/plugin/example.js

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

  return {
    // Hook implementations go here
  }
}

The plugin function receives:

• project: The current project information.
• directory: The current working directory.
• worktree: The git worktree path.
• client: An codeflow SDK client for interacting with the AI.
• $: Bun’s shell API for executing commands.

---

TypeScript support

For TypeScript plugins, you can import types from the plugin package:

my-plugin.ts

import type { Plugin } from "@codeflow-ai/plugin"

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

---

Examples

Here are some examples of plugins you can use to extend codeflow.

---

Send notifications

Send notifications when certain events occur:

.codeflow/plugin/notification.js

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 "codeflow"'`
      }
    },
  }
}

We are using osascript to run AppleScript on macOS. Here we are using it to send notifications.

---

.env protection

Prevent codeflow from reading .env files:

.codeflow/plugin/env-protection.js

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")
      }
    },
  }
}