Skip to main content

Script Discovery Service

Script discovery service for finding and managing Python scripts in .specify/scripts/ directory.

Classes​

FileSystemScriptDiscoveryService​

File system based script discovery service.

Inherits from: ScriptDiscoveryService

Methods​

find_script​
find_script(self, script_name: str) -> Optional[pathlib.Path]

Find a script by name, with or without .py extension.

Parameters:

  • script_name (str, required)

Returns: Optional

get_script_info​
get_script_info(self, script_name: str) -> Optional[Dict]

Get detailed information about a script.

Parameters:

  • script_name (str, required)

Returns: Optional

list_available_scripts​
list_available_scripts(self) -> List[str]

List all Python scripts in the scripts directory.

Returns: List

ScriptDiscoveryService​

Abstract interface for script discovery services.

Inherits from: ABC

Abstract class

Methods​

find_script​
find_script(self, script_name: str) -> Optional[pathlib.Path]

Find a script by name, returning its full path if found.

Parameters:

  • script_name (str, required)

Returns: Optional

get_script_info​
get_script_info(self, script_name: str) -> Optional[Dict]

Get metadata about a script including description and imports.

Parameters:

  • script_name (str, required)

Returns: Optional

list_available_scripts​
list_available_scripts(self) -> List[str]

List all available script names (without .py extension).

Returns: List