@juanibiapina/pi-extension-settings

A pi extension that provides centralized settings management for all extensions.

Features

• /extension-settings command - Interactive UI to configure all registered extension settings
• Helpers for reading/writing - getSetting() and setSetting() functions
• Persistent storage - Settings stored in ~/.pi/agent/settings-extensions.json

For Users

Install the extension to get the /extension-settings command, which provides an interactive UI to configure settings for all extensions that support it:

pi install npm:@juanibiapina/pi-extension-settings

⚠️ Load Order: pi-extension-settings must appear before any extension that registers settings in your packages array in ~/.pi/settings.json. Extensions register via the event bus at load time, so if pi-extension-settings hasn't loaded yet, those registrations are silently lost.

Then use /extension-settings in pi:

• Settings are grouped by extension with headers
• Use arrow keys to navigate
• Press Enter or Space to cycle through values (or edit string inputs)
• Type to search/filter settings
• Press Escape to close

For Extension Authors

If you're developing an extension and want to use the settings system, add this package as a dependency in your extension's package.json:

{
  "dependencies": {
    "@juanibiapina/pi-extension-settings": "^0.4.0"
  }
}

This gives you access to getSetting() and setSetting() helpers, and lets you register settings so they appear in the /extension-settings UI.

Register Settings (for the UI)

Emit the pi-extension-settings:register event during extension load to make your settings appear in /extension-settings:

import type { ExtensionAPI } from "@mariozechner/pi-coding-agent";
import type { SettingDefinition } from "@juanibiapina/pi-extension-settings";

export default function myExtension(pi: ExtensionAPI) {
  pi.events.emit("pi-extension-settings:register", {
    name: "my-extension",
    settings: [
      {
        id: "timeout",
        label: "Request Timeout",
        description: "Timeout in seconds for API requests",
        defaultValue: "30",
        values: ["10", "30", "60", "120"],  // Cycles through these values
      },
      {
        id: "debug",
        label: "Debug Mode",
        description: "Enable verbose logging",
        defaultValue: "off",
        values: ["on", "off"],
      },
      {
        id: "projectName",
        label: "Project Name",
        description: "Name used in commit messages",
        defaultValue: "",
        // No 'values' = free-form string input
      },
    ] satisfies SettingDefinition[]
  });
}

Read/Write Settings

Use the helper functions to read and write settings:

import { getSetting, setSetting } from "@juanibiapina/pi-extension-settings";

// Read a setting (with default fallback - must match defaultValue from registration)
const timeout = getSetting("my-extension", "timeout", "30");

// Write a setting
setSetting("my-extension", "debug", "on");

API Reference

getSetting(extensionName, settingId, defaultValue?)

Get a setting value. Returns the stored value, or the provided default, or undefined.

const value = getSetting("my-extension", "timeout", "30");

setSetting(extensionName, settingId, value)

Set a setting value. Writes to ~/.pi/agent/settings-extensions.json.

setSetting("my-extension", "debug", "on");

SettingDefinition (type)

Type for settings registration (use with satisfies for type checking):

interface SettingDefinition {
  id: string;            // Unique ID within the extension
  label: string;         // Display label in UI
  description?: string;  // Optional help text shown when selected
  defaultValue: string;  // Default value if not set
  values?: string[];     // Values to cycle through (omit for free-form string input)
}

Event: pi-extension-settings:register

Emit this event to register settings for the UI:

pi.events.emit("pi-extension-settings:register", {
  name: string;                    // Extension name
  settings: SettingDefinition[];   // Array of setting definitions
});

Storage

Settings are stored in ~/.pi/agent/settings-extensions.json:

{
  "my-extension": {
    "timeout": "60",
    "debug": "on"
  },
  "another-extension": {
    "theme": "dark"
  }
}

License

MIT