# Kitaru Documentation

> Kitaru is the runtime layer underneath your agent stack: it gives Python AI workflows durable checkpoints, replay, resumable waits, tracked LLM calls, artifact lineage, deployment, and operational tooling.

## Getting Started

Install Kitaru, run your first durable flow, and learn the first production path.

- [Kitaru Reference](/index.md): Auto-generated reference for the Kitaru Python SDK and command-line interface

## API Reference

CLI and Python reference material for exact commands, functions, and types.

- [CLI Reference](/cli.md): Record, replay, and improve AI agents in production. Create deployments with `kitaru deploy`; inspect existing deployments with `kitaru flow`.
- [kitaru analytics](/cli/analytics.md): Manage anonymous usage analytics preferences.
- [kitaru analytics opt-in](/cli/analytics/opt-in.md): Enable anonymous usage analytics.
- [kitaru analytics opt-out](/cli/analytics/opt-out.md): Disable anonymous usage analytics.
- [kitaru analytics status](/cli/analytics/status.md): Show the current analytics preference.
- [kitaru auth](/cli/auth.md): Manage active Kitaru server authentication helpers.
- [kitaru auth api-keys](/cli/auth/api-keys.md): Manage service-account API keys.
- [kitaru auth api-keys create](/cli/auth/api-keys/create.md): Create a service-account API key and print its one-time value.
- [kitaru auth api-keys delete](/cli/auth/api-keys/delete.md): Delete an API key.
- [kitaru auth api-keys list](/cli/auth/api-keys/list.md): List API-key metadata for a service account.
- [kitaru auth api-keys rotate](/cli/auth/api-keys/rotate.md): Rotate an API key and print its one-time replacement value.
- [kitaru auth api-keys show](/cli/auth/api-keys/show.md): Show API-key metadata without revealing the raw key value.
- [kitaru auth api-keys update](/cli/auth/api-keys/update.md): Update API-key metadata without revealing the raw key value.
- [kitaru auth service-accounts](/cli/auth/service-accounts.md): Manage Kitaru service accounts.
- [kitaru auth service-accounts create](/cli/auth/service-accounts/create.md): Create a service account.
- [kitaru auth service-accounts delete](/cli/auth/service-accounts/delete.md): Delete a service account.
- [kitaru auth service-accounts list](/cli/auth/service-accounts/list.md): List service accounts.
- [kitaru auth service-accounts show](/cli/auth/service-accounts/show.md): Show service-account metadata.
- [kitaru auth service-accounts update](/cli/auth/service-accounts/update.md): Update service-account metadata.
- [kitaru auth token](/cli/auth/token.md): Print a short-lived bearer token for the active Kitaru server.
- [kitaru build](/cli/build.md): Build an immutable deployment version from a flow target.
- [kitaru clean](/cli/clean.md): Reset Kitaru state.
- [kitaru clean all](/cli/clean/all.md): Reset all local state: project + global.
- [kitaru clean global](/cli/clean/global.md): Reset all local Kitaru and ZenML state on this machine.
- [kitaru clean project](/cli/clean/project.md): Remove the project-local .kitaru/ directory.
- [kitaru deploy](/cli/deploy.md): Deploy a new flow version and attach one routing tag.
- [kitaru executions](/cli/executions.md): Inspect and manage flow executions.
- [kitaru executions cancel](/cli/executions/cancel.md): Cancel a running execution.
- [kitaru executions cohort](/cli/executions/cohort.md): Resolve a cohort of original executions (dry-run selection only).
- [kitaru executions diff](/cli/executions/diff.md): Compare an original execution against replay executions.
- [kitaru executions diff-matrix](/cli/executions/diff-matrix.md): Diff many original executions against their auto-discovered replays.
- [kitaru executions get](/cli/executions/get.md): Show detailed information for one execution.
- [kitaru executions input](/cli/executions/input.md): Resolve pending wait input for a non-interactive or timed-out execution.
- [kitaru executions list](/cli/executions/list.md): List executions with optional filters.
- [kitaru executions logs](/cli/executions/logs.md): Fetch runtime log entries for an execution.
- [kitaru executions replay](/cli/executions/replay.md): Replay one or more executions from a checkpoint cut point.
- [kitaru executions resume](/cli/executions/resume.md): Resume a paused execution when it did not continue automatically after input.
- [kitaru executions retry](/cli/executions/retry.md): Retry a failed execution as same-execution recovery.
- [kitaru executions statistics](/cli/executions/statistics.md): Show grouped execution statistics.
- [kitaru flow](/cli/flow.md): Inspect existing deployments and manage deployment routing. Create new deployments with `kitaru deploy`.
- [kitaru flow deployments](/cli/flow/deployments.md): Inspect and manage existing deployment versions for a flow.
- [kitaru flow deployments curl](/cli/flow/deployments/curl.md): Generate a curl command that starts a deployment execution.
- [kitaru flow deployments delete](/cli/flow/deployments/delete.md): Delete one deployment version when no exclusive tag protects it.
- [kitaru flow deployments list](/cli/flow/deployments/list.md): List deployment versions for one flow.
- [kitaru flow deployments logs](/cli/flow/deployments/logs.md): Fetch runtime logs for an execution associated with a deployment.
- [kitaru flow deployments show](/cli/flow/deployments/show.md): Show one deployment version.
- [kitaru flow list](/cli/flow/list.md): List flows that have deployment versions.
- [kitaru flow show](/cli/flow/show.md): Show deployment summary for one flow.
- [kitaru flow tag](/cli/flow/tag.md): Attach or move a public tag on one deployment version.
- [kitaru flow untag](/cli/flow/untag.md): Remove a public tag from one deployment version.
- [kitaru info](/cli/info.md): Show detailed environment information for the current setup.
- [kitaru init](/cli/init.md): Initialize a Kitaru project in the current directory.
- [kitaru invoke](/cli/invoke.md): Invoke a deployed flow snapshot.
- [kitaru log-store](/cli/log-store.md): Manage global runtime log-store settings.
- [kitaru log-store reset](/cli/log-store/reset.md): Clear the persisted global runtime log-store override.
- [kitaru log-store set](/cli/log-store/set.md): Set the global runtime log-store backend override.
- [kitaru log-store show](/cli/log-store/show.md): Show the effective global runtime log-store configuration.
- [kitaru login](/cli/login.md): Connect to a remote server, or start and connect to a local server.
- [kitaru logout](/cli/logout.md): Log out from the current Kitaru server and clear stored auth state.
- [kitaru model](/cli/model.md): Manage local model aliases for kitaru.llm().
- [kitaru model list](/cli/model/list.md): List model aliases available to `kitaru.llm()` in this environment.
- [kitaru model register](/cli/model/register.md): Register or update a model alias used by `kitaru.llm()`.
- [kitaru project](/cli/project.md): Inspect projects; create, delete, and switch them on ZenML Pro/Cloud.
- [kitaru project create](/cli/project/create.md): Create a Kitaru project on ZenML Pro/Cloud, activating it by default.
- [kitaru project current](/cli/project/current.md): Show the active Kitaru project.
- [kitaru project delete](/cli/project/delete.md): Delete a Kitaru project on ZenML Pro/Cloud by name or ID.
- [kitaru project list](/cli/project/list.md): List Kitaru projects visible to the current user.
- [kitaru project show](/cli/project/show.md): Show a Kitaru project by name or ID.
- [kitaru project use](/cli/project/use.md): Use a Kitaru project on ZenML Pro/Cloud as the active default.
- [kitaru secrets](/cli/secrets.md): Manage centralized runtime secrets.
- [kitaru secrets delete](/cli/secrets/delete.md): Delete a secret by exact name or exact ID.
- [kitaru secrets list](/cli/secrets/list.md): List all secrets visible to the current user context.
- [kitaru secrets set](/cli/secrets/set.md): Set a public secret by default, or create it privately with --private.
- [kitaru secrets show](/cli/secrets/show.md): Show a secret with metadata and optional raw values.
- [kitaru stack](/cli/stack.md): Inspect, create, delete, and switch stacks.
- [kitaru stack create](/cli/stack/create.md): Create a local, Kubernetes, Vertex AI, SageMaker, AzureML, or Modal stack.
- [kitaru stack current](/cli/stack/current.md): Show the currently active stack.
- [kitaru stack delete](/cli/stack/delete.md): Delete a stack by name or ID.
- [kitaru stack list](/cli/stack/list.md): List stacks visible to the current user.
- [kitaru stack show](/cli/stack/show.md): Show translated details for a stack by name or ID.
- [kitaru stack use](/cli/stack/use.md): Use a stack as the active default by name or ID.
- [kitaru status](/cli/status.md): Show the current connection state and active stack context.
- [kitaru](/reference/python.md): Kitaru documentation page.

## Optional

Lower-priority project material, exhaustive generated pages, and release history.

- [Deployment](/reference/python/_interface_deployments/Deployment.md): Kitaru documentation page.
- [analytics](/reference/python/analytics.md): Kitaru documentation page.
- [AnalyticsEvent](/reference/python/analytics/AnalyticsEvent.md): Kitaru documentation page.
- [artifacts](/reference/python/artifacts.md): Kitaru documentation page.
- [checkpoint](/reference/python/checkpoint.md): Kitaru documentation page.
- [cli_output](/reference/python/cli_output.md): Kitaru documentation page.
- [CLIOutputFormat](/reference/python/cli_output/CLIOutputFormat.md): Kitaru documentation page.
- [CommandEnvelope](/reference/python/cli_output/CommandEnvelope.md): Kitaru documentation page.
- [ErrorEnvelope](/reference/python/cli_output/ErrorEnvelope.md): Kitaru documentation page.
- [client](/reference/python/client.md): Kitaru documentation page.
- [KitaruClient](/reference/python/client/KitaruClient.md): Kitaru documentation page.
- [cohort](/reference/python/cohort.md): Kitaru documentation page.
- [CohortQuery](/reference/python/cohort/CohortQuery.md): Kitaru documentation page.
- [CohortResult](/reference/python/cohort/CohortResult.md): Kitaru documentation page.
- [config](/reference/python/config.md): Kitaru documentation page.
- [diff](/reference/python/diff.md): Kitaru documentation page.
- [CheckpointDiff](/reference/python/diff/CheckpointDiff.md): Kitaru documentation page.
- [ExecutionDiff](/reference/python/diff/ExecutionDiff.md): Kitaru documentation page.
- [errors](/reference/python/errors.md): Kitaru documentation page.
- [FailureOrigin](/reference/python/errors/FailureOrigin.md): Kitaru documentation page.
- [KitaruAmbiguousFlowResultError](/reference/python/errors/KitaruAmbiguousFlowResultError.md): Kitaru documentation page.
- [KitaruBackendError](/reference/python/errors/KitaruBackendError.md): Kitaru documentation page.
- [KitaruContextError](/reference/python/errors/KitaruContextError.md): Kitaru documentation page.
- [KitaruDeploymentInputValuesError](/reference/python/errors/KitaruDeploymentInputValuesError.md): Kitaru documentation page.
- [KitaruDivergenceError](/reference/python/errors/KitaruDivergenceError.md): Kitaru documentation page.
- [KitaruError](/reference/python/errors/KitaruError.md): Kitaru documentation page.
- [KitaruExecutionError](/reference/python/errors/KitaruExecutionError.md): Kitaru documentation page.
- [KitaruFeatureNotAvailableError](/reference/python/errors/KitaruFeatureNotAvailableError.md): Kitaru documentation page.
- [KitaruLogRetrievalError](/reference/python/errors/KitaruLogRetrievalError.md): Kitaru documentation page.
- [KitaruRuntimeError](/reference/python/errors/KitaruRuntimeError.md): Kitaru documentation page.
- [KitaruStackIntegrationDependencyError](/reference/python/errors/KitaruStackIntegrationDependencyError.md): Kitaru documentation page.
- [KitaruStackNotRemoteExecutableStateError](/reference/python/errors/KitaruStackNotRemoteExecutableStateError.md): Kitaru documentation page.
- [KitaruStackNotRemoteExecutableUsageError](/reference/python/errors/KitaruStackNotRemoteExecutableUsageError.md): Kitaru documentation page.
- [KitaruStateError](/reference/python/errors/KitaruStateError.md): Kitaru documentation page.
- [KitaruTimeoutError](/reference/python/errors/KitaruTimeoutError.md): Kitaru documentation page.
- [KitaruUsageError](/reference/python/errors/KitaruUsageError.md): Kitaru documentation page.
- [KitaruUserCodeError](/reference/python/errors/KitaruUserCodeError.md): Kitaru documentation page.
- [KitaruWaitValidationError](/reference/python/errors/KitaruWaitValidationError.md): Kitaru documentation page.
- [StackNotRemoteExecutable](/reference/python/errors/StackNotRemoteExecutable.md): Kitaru documentation page.
- [events](/reference/python/events.md): Kitaru documentation page.
- [flow](/reference/python/flow.md): Kitaru documentation page.
- [FlowHandle](/reference/python/flow/FlowHandle.md): Kitaru documentation page.
- [inspection](/reference/python/inspection.md): Kitaru documentation page.
- [llm](/reference/python/llm.md): Kitaru documentation page.
- [logging](/reference/python/logging.md): Kitaru documentation page.
- [mcp](/reference/python/mcp.md): Kitaru documentation page.
- [server](/reference/python/mcp/server.md): Kitaru documentation page.
- [replay](/reference/python/replay.md): Kitaru documentation page.
- [ReplayFailureRow](/reference/python/replay/ReplayFailureRow.md): Kitaru documentation page.
- [ReplayPlan](/reference/python/replay/ReplayPlan.md): Kitaru documentation page.
- [ReplayPlanDocument](/reference/python/replay/ReplayPlanDocument.md): Kitaru documentation page.
- [ReplayResultRow](/reference/python/replay/ReplayResultRow.md): Kitaru documentation page.
- [ReplaySkippedRow](/reference/python/replay/ReplaySkippedRow.md): Kitaru documentation page.
- [ReplaySubmission](/reference/python/replay/ReplaySubmission.md): Kitaru documentation page.
- [ReplaySummary](/reference/python/replay/ReplaySummary.md): Kitaru documentation page.
- [secrets](/reference/python/secrets.md): Kitaru documentation page.
- [Secret](/reference/python/secrets/Secret.md): Kitaru documentation page.
- [SecretSummary](/reference/python/secrets/SecretSummary.md): Kitaru documentation page.
- [wait](/reference/python/wait.md): Kitaru documentation page.