Skip to content

config

The settings surface: every CAFLEET_* environment variable resolves to a field on the Settings model defined here. Read this page to see defaults and aliases when embedding or contributing. Like every API page, it is for contributors changing cafleet and embedders driving it from Python; CLI users find the command surface in CLI options.

config

Project-wide settings sourced from the CAFLEET_* environment block.

The :class:Settings singleton (settings) is imported by the broker, CLI, server, and multiplexer modules. Every field reads from a single explicit CAFLEET_* env var via validation_alias — no implicit prefix-based binding — and falls back to a hard-coded default suitable for local single-user use.

Settings

Bases: BaseSettings

Runtime configuration for the CAFleet broker, CLI, and server.

Every attribute is read from an explicit CAFLEET_* environment variable and defaults to a value suitable for local single-user use. Modify via the env block; do NOT mutate the settings singleton at runtime.

Attributes:

Name Type Description
database_url str

SQLAlchemy URL for the SQLite registry. Sourced from CAFLEET_DATABASE_URL; defaults to sqlite:///~/.local/share/cafleet/cafleet.db (the home directory is expanded at import time). Use an absolute path — SQLAlchemy does not expand ~ in SQLite URLs.
broker_host str

Bind host for cafleet server. Sourced from CAFLEET_BROKER_HOST; defaults to "127.0.0.1".
broker_port int

Bind port for cafleet server. Sourced from CAFLEET_BROKER_PORT; defaults to 8000.
max_text_len int

Codepoint truncation limit applied when rendering message bodies (CLI echo and broker inline-preview keystroke). Sourced from CAFLEET_MAX_TEXT_LEN; defaults to 200. The persisted Task.text column is never truncated, and the WebUI API returns raw broker dicts that do not apply this limit.
Source code in cafleet/src/cafleet/config.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
class Settings(BaseSettings):
    """Runtime configuration for the CAFleet broker, CLI, and server.

    Every attribute is read from an explicit ``CAFLEET_*`` environment
    variable and defaults to a value suitable for local single-user use.
    Modify via the env block; do NOT mutate the ``settings`` singleton at
    runtime.

    Attributes:
        database_url: SQLAlchemy URL for the SQLite registry. Sourced from
            ``CAFLEET_DATABASE_URL``; defaults to
            ``sqlite:///~/.local/share/cafleet/cafleet.db`` (the home
            directory is expanded at import time). Use an absolute path —
            SQLAlchemy does not expand ``~`` in SQLite URLs.
        broker_host: Bind host for ``cafleet server``. Sourced from
            ``CAFLEET_BROKER_HOST``; defaults to ``"127.0.0.1"``.
        broker_port: Bind port for ``cafleet server``. Sourced from
            ``CAFLEET_BROKER_PORT``; defaults to ``8000``.
        max_text_len: Codepoint truncation limit applied when rendering
            message bodies (CLI echo and broker inline-preview keystroke).
            Sourced from ``CAFLEET_MAX_TEXT_LEN``; defaults to ``200``. The
            persisted ``Task.text`` column is never truncated, and the
            WebUI API returns raw broker dicts that do not apply this
            limit.
    """

    database_url: str = Field(
        default_factory=_default_database_url,
        validation_alias="CAFLEET_DATABASE_URL",
    )
    broker_host: str = Field(
        default="127.0.0.1",
        validation_alias="CAFLEET_BROKER_HOST",
    )
    broker_port: int = Field(
        default=8000,
        validation_alias="CAFLEET_BROKER_PORT",
    )
    max_text_len: int = Field(
        default=200,
        validation_alias="CAFLEET_MAX_TEXT_LEN",
    )