Skip to main content

Config

Configuration data models for spec-kit

Overview​

These models define the structure for project and global configurations, supporting TOML serialization and validation.

Classes​

BranchNamingConfig​

Configuration for branch naming patterns

Dataclass

Methods​

from_dict​
from_dict(data: Dict[str, Any]) -> 'BranchNamingConfig'

Create instance from dictionary (TOML deserialization)

Parameters:

  • data (Dict, required)

Returns: BranchNamingConfig

to_dict​
to_dict(self) -> Dict[str, Any]

Convert to dictionary for TOML serialization

Returns: Dict

ProjectConfig​

Main project configuration

Dataclass

Methods​

create_default​
create_default(name: str = 'default-project') -> 'ProjectConfig'

Create a default configuration

Parameters:

  • name (str, optional) - Default: default-project

Returns: ProjectConfig

from_dict​
from_dict(data: Dict[str, Any]) -> 'ProjectConfig'

Create instance from dictionary (TOML deserialization)

Parameters:

  • data (Dict, required)

Returns: ProjectConfig

to_dict​
to_dict(self) -> Dict[str, Any]

Convert to dictionary for TOML serialization

Returns: Dict

TemplateConfig​

Configuration for template engine settings

Dataclass

Methods​

add_assistant​
add_assistant(self, assistant_name: str) -> None

Add an AI assistant to the list if not already present.

Parameters:

  • assistant_name (str, required)
from_dict​
from_dict(data: Dict[str, Any]) -> 'TemplateConfig'

Create instance from dictionary (TOML deserialization)

Parameters:

  • data (Dict, required)

Returns: TemplateConfig

has_assistant​
has_assistant(self, assistant_name: str) -> bool

Check if an AI assistant is in the list.

Parameters:

  • assistant_name (str, required)

Returns: bool

remove_assistant​
remove_assistant(self, assistant_name: str) -> bool

Remove an AI assistant from the list.

Parameters:

  • assistant_name (str, required)

Returns: bool

to_dict​
to_dict(self) -> Dict[str, Any]

Convert to dictionary for TOML serialization

Returns: Dict

Properties​

  • primary_assistant

Functions​

ensure_system_path​

ensure_system_path(value: Any) -> pathlib.Path

Coerce a raw path-like value into a Path using the host system class.

Parameters:

  • value (Any, required)

Returns: Path