Skip to content

plugins

Manage Openbase plugins installed into the local CLI runtime.

Usage

openbase-coder plugins COMMAND [ARGS]

Subcommands

Subcommand Description
add SOURCE [--ref REF] Install a plugin from local repo path or GitHub URL
list List installed plugins
show PLUGIN_ID Show a plugin's declared capabilities
remove PLUGIN_ID Uninstall a plugin
update [PLUGIN_ID] [--ref REF] Update one plugin or all plugins
bootstrappers List all discovered bootstrapper names

Source Types

Local repo path

openbase-coder plugins add ~/code/my-openbase-plugin
  • Installed editable (-e) into the CLI Python environment
  • Useful for active plugin development

GitHub URL

openbase-coder plugins add https://github.com/org/openbase-plugin
openbase-coder plugins add https://github.com/org/openbase-plugin --ref main
  • Cloned under ~/.openbase/plugins/sources/
  • Installed pinned to resolved commit SHA

What Happens on Add/Update/Remove

Mutating plugin commands will:

  1. Update plugin registry and requirements under ~/.openbase/plugins/
  2. Sync plugin-declared Claude skills into ~/.claude/skills
  3. Regenerate console plugin integration artifacts
  4. Restart managed launchd services

Plugin Declaration Model

Plugins are Python packages discovered via entry points in:

[project.entry-points."openbase_coder.plugins"]
my_plugin = "my_plugin.spec:get_plugin_spec"

The entry point returns a plugin spec dict containing declarations such as:

  • bootstrappers
  • stacks
  • project_views
  • console_pages
  • skills
  • django_url_modules
  • console_npm_packages

Collision Rules

Install/update will fail if a plugin conflicts with existing plugins on:

  • bootstrapper name
  • console page key
  • console page route
  • project view stack