ProjectConfig

Configuration classes for Klisk projects

ProjectConfig

Main configuration class for Klisk projects, loaded from klisk.config.yaml.

Fields

entry · str · default: "src/main.py"

Entry point file for the Klisk project

name · str · default: "MyAgent"

Name of the agent project

studio · StudioConfig · default: "StudioConfig()"

Configuration for the Klisk Studio development interface

api · ApiConfig · default: "ApiConfig()"

Configuration for the API server

Methods

load

@classmethod
def load(cls, project_dir: str | Path) -> ProjectConfig

Load configuration from a project directory.

project_dir · str | Path · required

Path to the project directory containing klisk.config.yaml

return · ProjectConfig

Loaded project configuration. Returns a default configuration if klisk.config.yaml does not exist.

Example:

from klisk.core.config import ProjectConfig

config = ProjectConfig.load("/path/to/project")
print(config.name)  # "MyAgent"
print(config.entry)  # "src/main.py"

---

StudioConfig

Configuration for the Klisk Studio development interface.

Fields

port · int · default: "3000"

Port number for the Studio web interface

Example:

from klisk.core.config import StudioConfig

studio = StudioConfig(port=3001)

---

ApiConfig

Configuration for the Klisk API server.

Fields

port · int · default: "8000"

Port number for the API server

Example:

from klisk.core.config import ApiConfig

api = ApiConfig(port=8080)