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.

function

workspace 

workspace(
    *,
    model: object,
    root: str | Path | None = None,
    metagit: bool = False,
) -> Workspace

Open and install a process-local syntax nucleus workspace.

When metagit=True, task .run(...) calls under this workspace dispatch through meta-git's runtime substrate (capture, merge/discard, run identity). Requires the agentic meta-package's integration to be installed (it is, on import agentic). metagit=True requires a root.

See also