hull plugin install

Synopsis

hull plugin install adds a plugin so its command becomes available as hull <plugin-name>. The source is either a git URL (cloned for you) or a path to a local directory (copied in). hull reads the plugin’s plugin.yaml, checks it, and stores it under ~/.config/hull/plugins/.

When to use it

Use it when you want a hull command the core binary doesn’t ship — an organisation helper, a custom auth flow, a workflow shortcut. For curated, signed plugins, browse hull marketplace search and verify the archive first.

What happens

  1. hull decides whether <source> is a git source. A source ending in .git, or starting with git@, git://, ssh://, or file://, is treated as git.
  2. For a git source, hull runs git clone --depth 1 into ~/.config/hull/plugins/<name>, where <name> is the last path segment of the URL without .git. For a local directory, hull copies it to ~/.config/hull/plugins/<name>, where <name> is the directory’s name.
  3. hull reads plugin.yaml for the plugin’s name, version, description, and the command to run. The command must be a bare filename in the plugin directory (no slashes).
  4. hull runs the plugin’s install hook if it declares one.
  5. From now on, hull <name> runs the plugin.

If a plugin with that name is already installed, hull stops and leaves the existing one untouched — remove it first to reinstall.

Usage 

hull plugin install <source> [flags]

Flags

Inherits the global flags.

Worked example

Install a plugin from a local directory, then confirm it registered:

hull plugin install ./hello

Installed plugin: hello v1.2.0

hull plugin list

NAME   VERSION  DESCRIPTION
hello  1.2.0    Print a friendly greeting

hull hello world

hello from the plugin: world

Install from a git URL instead:

hull plugin install https://github.com/acme/hull-backup.git

Installed plugin: backup v0.4.0

See also