find_work.cli.plugins#

Loadable plug-in interface.

class find_work.cli.plugins.PluginSpec#

Bases: object

Specifications of CLI plugin hooks.

attach_base_command(group: ClickAliasedGroup) None#

Attach plugin’s base command to the CLI.

Parameters:

group – Click group

setup_base_command(options: MainOptions) None#

Initialize plugin’s base command.

This hook should not change the global state.

Parameters:

options – global options

get_command_by_name(command: str) Command | None#

Match a command by its name.

Parameters:

command – colon-separated pair of plugin name and command name to match, without any whitespace

Returns:

matched command or None