Skip to content

agentic.Workspace

Page status: scaffold Source state: generated Applies to: Shepherd v1.0-dev Owner: @docs-system-owner (TBD) Validation: scripts/gen_shepherd_api_inventory.py --check

This is reference — exact, generated facts. The mental model lives in concepts; recipes live in guides.

Pre-rename surface

Generated from the internal agentic facade; names and paths change at the Shepherd rename.

class

Workspace

Process-local syntax nucleus workspace handle.

metagit instance-attribute

metagit = metagit

model instance-attribute

model = model

root instance-attribute

root = root

scope instance-attribute

scope = scope

trace_stub instance-attribute

trace_stub: object | None = None

__aenter__ async

__aenter__() -> Self

__aexit__ async

__aexit__(
    exc_type: type[BaseException] | None,
    exc: BaseException | None,
    traceback: TracebackType | None,
) -> None

__enter__

__enter__() -> Self

__exit__

__exit__(
    exc_type: type[BaseException] | None,
    exc: BaseException | None,
    traceback: TracebackType | None,
) -> None

__init__

__init__(
    *,
    model: object,
    root: Path | None,
    scope: Scope,
    config: _EffectiveConfig,
    owner: Workspace | None = None,
    owns_scope: bool = False,
    metagit: bool = False,
) -> None

See also