nself plugin

nself plugin — ɳSelf documentation.

Install, remove, update, and manage ɳSelf plugins.

Synopsis

nself plugin <subcommand> [flags]

Description

nself plugin manages the nself plugin ecosystem. Plugins extend the CLI and your backend stack with new capabilities. Free plugins (MIT licensed) install without a key. Pro plugins require a valid membership license key, set one with nself license set.

When you install a plugin, ɳSelf checks your license tier against the plugin’s requirements, downloads the plugin binary and Docker image, registers the plugin with the stack, and prepares database migrations. Run nself build and nself restart after installing plugins to include them in the generated docker-compose.yml.

Unknown subcommands are proxied to the matching plugin binary: nself plugin ai <action> calls nself <action>. This allows installed plugins to expose their own subcommands through the ɳSelf CLI namespace.

Subcommands

Subcommand	Description
install <name>	Install one or more plugins (license check for pro)
remove <name>	Remove a plugin
update [name]	Update a specific plugin, or all installed plugins if no name given
updates	Check for available plugin updates
list	List available and installed plugins
inventory	List installed plugins with version, tier, and status
info <name>	Show detailed plugin information (--open for marketplace page)
search <query>	Search plugins by name, description, or tag
marketplace	Browse the nSelf plugin marketplace (list, search, info)
refresh	Force refresh the registry cache
start <name>	Start a plugin service
stop <name>	Stop a plugin service
status [name]	Show plugin status
enable <name>	Re-enable a previously disabled plugin
disable <name>	Disable a plugin (excluded from compose on next build)
logs <name>	Tail logs from a plugin container
init <name>	Scaffold a new plugin project (go, rust, node, static templates)
link <path>	Register a local plugin directory as a shadow override
unlink <name>	Remove a local plugin shadow, restoring the registry version
dev <name>	Start a plugin in development mode with hot-reload
debug <name>	Attach a dlv debugger to a running plugin process
test <name>	Run a plugin’s test suite (unit + smoke install/uninstall)
submit [path]	Validate a plugin for submission to the registry
compat-check	Check installed plugins against the current CLI version
audit-tables	Audit np_* table row counts and multi-tenant isolation compliance

Flags

Flag	Default	Description
--key	""	License key for pro plugins
--version	""	Install a specific version
--force	false	Remove even if other plugins depend on this one
--keep-data	false	Preserve database data when removing
--installed	false	Show only installed plugins (for list)
--category	""	Filter by category (for list)
--detailed	false	Show detailed information
--help, -h	none	Show help

Examples

# List all available plugins
nself plugin list

# List only installed plugins
nself plugin list --installed

# Filter by category
nself plugin list --category ai

# Install a free plugin
nself plugin install notify

# Install a pro plugin (uses saved license key)
nself plugin install ai

# Install a pro plugin with an inline key
nself plugin install livekit --key nself_pro_xxxxx...

# Install a specific version
nself plugin install recording --version 1.2.0

# Remove a plugin
nself plugin remove ai

# Remove a plugin but keep its database data
nself plugin remove livekit --keep-data

# Force remove (ignores dependents)
nself plugin remove recording --force

# Update a specific plugin
nself plugin update ai

# Update all plugins
nself plugin update

# Check for available updates without installing
nself plugin updates

# Show installed plugins with version and tier
nself plugin inventory

# Refresh registry cache
nself plugin refresh

# Start/stop a plugin service
nself plugin start ai
nself plugin stop ai

# Show plugin status
nself plugin status
nself plugin status ai --detailed