Getting Started

Quick Start

Install Burr with the UI extras and launch the server:

pip install "apache-burr[start]"
burr

This starts the tracking server on port 7241 and opens the UI in your browser.

Connect Your App

Any application that uses with_tracker will automatically appear in the UI:

from burr.core import ApplicationBuilder

app = (
    ApplicationBuilder()
    .with_actions(...)
    .with_transitions(...)
    .with_tracker("local", project="my-project")
    .build()
)

Run your application and then open http://localhost:7241 to see your project, its application runs, and the step-by-step trace.

Reloading Prior State

Because the tracking client writes to the local filesystem (~/.burr by default), you can reload state from any past run for debugging:

from burr.tracking import LocalTrackingClient

tracker = LocalTrackingClient(project="my-project")
app = (
    ApplicationBuilder()
    .with_graph(base_graph)
    .initialize_from(
        tracker,
        resume_at_next_action=True,
        default_state={},
        default_entrypoint="my-entrypoint",
        fork_from_app_id="<prior-app-id>",
        fork_from_sequence_id=None,
        fork_from_partition_key=None,
    )
    .with_tracker(tracker)
    .build()
)

See Tracking Burr for the full tracking client reference.