@pugi/runtime

Plugin runtime API for the Pugi ecosystem.

Used by all @pugi/plugin-* packages to register hooks against the Pugi session lifecycle.

Installation

npm install @pugi/runtime

Usage

import type { Plugin, PluginInput } from '@pugi/runtime';

const myPlugin: Plugin = async (input) => {
  return {
    'chat.params': async ({ model, message }, output) => {
      // modify temperature, topP, maxOutputTokens, etc.
    },
    'experimental.chat.system.transform': async ({ userMessageText, sessionID }, output) => {
      // inject system prompt fragments
    },
    'experimental.session.finish': async ({ sessionID, messageID, finish }, output) => {
      // veto turn-finish on failed verification
      output.veto = false;
    },
  };
};

export default myPlugin;

Hook surface

• chat.params - modify model parameters before request
• chat.headers - inject request headers
• chat.message - observe inbound user messages
• permission.ask - moderate tool/file permission prompts
• command.execute.before - intercept slash command execution
• tool.execute.before / tool.execute.after - intercept tool calls
• tool.definition - modify tool descriptions sent to the model
• shell.env - inject environment variables for shell tools
• provider - register custom model providers
• auth - register custom auth methods
• config - load-time config injection
• experimental.chat.system.transform - inject system prompt fragments
• experimental.chat.messages.transform - rewrite message history before send
• experimental.session.finish - veto turn-finish based on verification checks
• experimental.session.compacting - customize compaction prompts
• experimental.compaction.autocontinue - control synthetic continue turns
• experimental.text.complete - rewrite final text segments
• experimental.provider.small_model - override the small-model resolver

License

MIT. See NOTICE.md for attribution details.