mine plugin
Install, remove, and manage mine plugins. Plugins are standalone binaries that hook into the command pipeline and can register custom subcommands.
List Installed Plugins
Section titled “List Installed Plugins”mine plugin # list all installed pluginsmine plugin list # same thingShows each plugin with a status indicator, name, version, and hook/command counts. Active plugins show a filled circle; disabled plugins show an empty circle.
Install a Plugin
Section titled “Install a Plugin”mine plugin install ./my-pluginmine plugin install /path/to/mine-plugin-obsidianInstalls a plugin from a local directory containing a mine-plugin.toml manifest. mine reads the manifest, displays the requested permissions, and prompts for confirmation before installing.
The installation flow:
- Parse
mine-plugin.tomlfrom the source directory - Validate the manifest (required fields, name format, stage/mode pairing)
- Display plugin name, version, author, description
- Display requested permissions for review
- Prompt
Install this plugin? [y/N] - Copy the plugin to
~/.local/share/mine/plugins/<name>/ - Register hooks and commands
Example
Section titled “Example”$ mine plugin install ./todo-stats Installing todo-stats v0.1.0 by mine-examples Track todo completion stats and show a summary
Permissions: No special permissions required
Install this plugin? [y/N] y
Installed todo-stats v0.1.0 1 hooks registered, 1 commands availableRemove a Plugin
Section titled “Remove a Plugin”mine plugin remove todo-statsmine plugin rm todo-stats # aliasmine plugin uninstall todo-stats # aliasRemoves an installed plugin and unregisters its hooks and commands.
Show Plugin Info
Section titled “Show Plugin Info”mine plugin info todo-statsDisplays detailed information about an installed plugin:
- Version, author, description, license
- Protocol version and install directory
- Enabled status
- Registered hooks (command pattern, stage, mode)
- Registered commands (name, description)
- Declared permissions
Search for Plugins
Section titled “Search for Plugins”mine plugin search obsidian # search by keywordmine plugin search # list all mine pluginsmine plugin search --tag logging # filter by GitHub topicSearches GitHub for repositories matching the mine-plugin-* naming convention. Results include the repository name, description, and star count.
Rate Limits
Section titled “Rate Limits”GitHub’s search API has rate limits for unauthenticated requests. Set GITHUB_TOKEN to increase your limit:
export GITHUB_TOKEN=ghp_...mine plugin search obsidianError Reference
Section titled “Error Reference”| Error | Cause | Fix |
|---|---|---|
reading manifest: open mine-plugin.toml: no such file or directory | Source directory has no manifest | Ensure the directory contains mine-plugin.toml |
invalid manifest: plugin.name is required | Manifest missing required field | Add the missing field to mine-plugin.toml |
invalid manifest: plugin.name "My Plugin" must be kebab-case | Name not in kebab-case format | Use lowercase with hyphens (e.g., my-plugin) |
invalid manifest: hooks[0]: notify stage requires notify mode | Stage/mode mismatch | Notify stage must use notify mode; all other stages use transform mode |
plugin "foo" not found | Plugin not installed | Check spelling with mine plugin list or install it first |
Installation cancelled. | User declined the permission prompt | Review the permissions and run mine plugin install again |
Environment Variables
Section titled “Environment Variables”| Variable | Purpose |
|---|---|
GITHUB_TOKEN | Increases GitHub API rate limit for mine plugin search |
See Also
Section titled “See Also”- Plugins feature overview — how the plugin system works
- Building Plugins — create your own plugins
- Plugin Protocol — the JSON communication contract
- Hook command reference — user-local hooks (no plugin required)