kysera plugin

Plugin management and configuration tools for discovering, enabling, and configuring Kysera plugins.

Commands

Command	Description
list	List available and installed plugins
enable	Enable a plugin
disable	Disable a plugin
config	Configure plugin settings

list

List available and installed plugins.

kysera plugin list [options]

Options

Option	Description
--installed	Show only installed plugins
--available	Show available plugins from registry
--enabled	Show only enabled plugins
--disabled	Show only disabled plugins
-c, --category <type>	Filter by category
-s, --search <query>	Search plugins by name or description
--show-details	Show detailed plugin information
--json	Output as JSON
--config <path>	Path to configuration file

Plugin Categories

Category	Description
database	Database-level plugins
schema	Schema modification plugins
query	Query enhancement plugins
audit	Audit and logging plugins
cache	Caching plugins
validation	Validation plugins

Examples

# List all plugins
kysera plugin list

# List installed plugins only
kysera plugin list --installed

# List available plugins from registry
kysera plugin list --available

# Filter by category
kysera plugin list --category audit

# Search plugins
kysera plugin list --search "soft delete"

# Show detailed information
kysera plugin list --show-details

# Show only enabled plugins
kysera plugin list --enabled

Output

Default view:

Kysera Plugins
────────────────────────────────────────────────────────────────────────────────

Installed Plugins:

  @kysera/soft-delete v1.0.0
    Status: ● Enabled
    Category: schema
    Soft delete support with automatic filtering

  @kysera/timestamps v1.0.0
    Status: ● Enabled
    Category: schema
    Automatic created_at and updated_at timestamps

Available Plugins:

  @kysera/audit v1.0.0
    Category: audit
    Comprehensive audit logging for all database operations

  @kysera/cache v1.0.0
    Category: cache
    Query result caching with Redis/memory backends

────────────────────────────────────────────────────────────────────────────────
Summary:
  Installed: 2
  Enabled: 2
  Disabled: 0
  Available: 7

Detailed view (with --show-details):

Shows additional information:

• Author
• Homepage URL
• Hooks used (e.g., beforeInsert, afterUpdate)
• Providers exported
• Commands added
• Version compatibility

Plugin Status

Status	Indicator	Description
Enabled	●	Plugin is active and running
Disabled	●	Plugin is installed but not active
Installed	●	Plugin is installed, status unknown
Available	◯	Plugin can be installed

enable

Enable an installed plugin.

kysera plugin enable [name] [options]

Arguments

Argument	Description
name	Plugin name (e.g., @kysera/audit); optional with --all

Options

Option	Description
--all	Enable all installed plugins
-f, --force	Force enable without checks
--configure	Configure plugin after enabling
--restart	Restart application after enabling
--json	Output as JSON
--config <path>	Path to configuration file

Examples

# Enable a plugin
kysera plugin enable @kysera/soft-delete

# Enable and configure interactively
kysera plugin enable @kysera/audit --configure

# Enable everything that is installed
kysera plugin enable --all

Effect

Enabling a plugin:

1. Updates kysera.config.ts to include the plugin
2. Validates plugin compatibility
3. Runs any plugin initialization hooks

disable

Disable an enabled plugin without uninstalling.

kysera plugin disable [name] [options]

Arguments

Argument	Description
name	Plugin name (e.g., @kysera/audit); optional with --all

Options

Option	Description
--all	Disable all enabled plugins
-f, --force	Force disable without dependency checks
--keep-config	Keep plugin configuration
--restart	Restart application after disabling
--json	Output as JSON
--config <path>	Path to configuration file

Examples

# Disable a specific plugin
kysera plugin disable @kysera/audit

# Disable but keep its configuration for later
kysera plugin disable @kysera/audit --keep-config

# Disable all plugins
kysera plugin disable --all

Effect

Disabling a plugin:

1. Updates kysera.config.ts to set enabled: false
2. Plugin hooks are no longer called
3. Plugin remains installed for quick re-enabling

config

Configure plugin settings.

kysera plugin config [name] [options]

Arguments

Argument	Description
name	Plugin name (e.g., @kysera/soft-delete)

Options

Option	Description
-g, --get <key>	Get a configuration value
-s, --set <key>	Set a configuration key
--value <value>	Value for the key given via --set
--reset	Reset to default configuration
--show	Show current configuration
--edit	Edit configuration interactively
--validate	Validate configuration
--export <file>	Export configuration to file
--import <file>	Import configuration from file
--json	Output as JSON
--config <path>	Path to configuration file

Setting a value uses the --set <key> --value <value> pair — one key per invocation; run the command again for each additional key.

Examples

# Show current configuration
kysera plugin config @kysera/soft-delete --show

# Set a configuration value (one key per invocation)
kysera plugin config @kysera/soft-delete --set deletedAtColumn --value deleted_at

# Get a specific value
kysera plugin config @kysera/soft-delete --get deletedAtColumn

# Edit interactively
kysera plugin config @kysera/audit --edit

# Reset to defaults
kysera plugin config @kysera/soft-delete --reset

Configuration in kysera.config.ts

Plugin configuration is stored in the config file under the keys softDelete, timestamps, audit, and rls:

export default {
  plugins: {
    softDelete: {
      enabled: true,
      deletedAtColumn: 'deleted_at',
      includeDeleted: false
    },
    timestamps: {
      enabled: true,
      createdAtColumn: 'created_at',
      updatedAtColumn: 'updated_at'
    },
    audit: {
      enabled: true,
      auditTable: 'audit_logs'
    }
  }
}

Official Plugins

@kysera/soft-delete

Soft delete support with automatic filtering.

kysera plugin enable @kysera/soft-delete
kysera plugin config @kysera/soft-delete --set deletedAtColumn --value deleted_at

@kysera/timestamps

Automatic created_at and updated_at timestamps.

kysera plugin enable @kysera/timestamps

@kysera/audit

Comprehensive audit logging.

kysera plugin enable @kysera/audit
kysera plugin config @kysera/audit --set auditTable --value audit_logs

@kysera/rls

Row-Level Security for multi-tenant applications.

kysera plugin enable @kysera/rls

Custom Plugins

You can create custom plugins in a plugins/ directory:

my-project/
├── plugins/
│   └── my-custom-plugin/
│       ├── package.json
│       └── index.ts
└── kysera.config.ts

Custom plugins are automatically discovered by kysera plugin list.

See Also

• Plugins Overview - Plugin architecture
• @kysera/soft-delete - Soft delete plugin
• @kysera/audit - Audit plugin
• @kysera/timestamps - Timestamps plugin
• Authoring Plugins - Create custom plugins