Install

Install HaltState SDKs and prepare a safe environment for guarded service or worker execution.

Python

python3 -m venv .venv
source .venv/bin/activate
pip install haltstate-sdk

TypeScript

npm install @haltstate/sdk

Go

go get github.com/haltstate-ai/sdk-go@v1.0.1

Preview SDK: external module install resolves, and source builds locally.

Java

repositories { maven { url = uri("https://jitpack.io") } }
dependencies { implementation("com.github.haltstate-ai:sdk-java:v0.2.0") }

Preview SDK: JitPack metadata exists; source targets Java 17 and local verification requires a Java toolchain.

Rust

Preview SDK source is present in sdk-rust. Cargo is not available on this host and crates.io search returned no haltstate package, so there is no public remote install command yet.

Service checklist

Run workers with least-privilege API keys.
Set fail-closed behavior for money, PII, and production writes.
Use a stable idempotency key before the first guard call.
Report execution only after the side effect has completed.
Keep raw customer payloads out of public live events.

SDK availability

Language	Status	Use now
Python	First-party Beta package `haltstate-sdk` version `0.7.0`; sync/async clients, check, guard, report, decorators, approval flow, exception types, idempotency, and fail-closed behavior.	`pip install haltstate-sdk`
TypeScript	First-party implementation `@haltstate/sdk` version `1.0.2`; build verified; automated test coverage pending.	`npm install @haltstate/sdk`
Go	First-party Preview module; build verification passed; automated test files currently absent.	`go get github.com/haltstate-ai/sdk-go@v1.0.1`
Java	First-party Preview source; group/artifact `ai.haltstate:haltstate-sdk` version `0.2.0`; Java 17 toolchain verification pending on this host.	Use source checkout only until registry publication is externally verified.
Rust	First-party Preview source; crate `haltstate` version `0.1.0`; Rust toolchain verification pending on this host.	Use source checkout only until crates.io publication is externally verified.

Canonical API base

New integrations should use https://haltstate.ai as the public base URL and the HaltState-branded governance namespace. Existing clients may still support legacy aliases for compatibility, but public docs should point new users at the current contract.

Implementation notes

Keep the HaltState call as close as possible to the side effect. The agent may plan and draft freely, but the wrapper around the actual action should be the place where authority is checked. That wrapper should send only the context required for policy evaluation: safe identifiers, normalized amounts, action names, risk flags, schedule windows, and redaction status. Raw customer payloads and secrets should stay in the business system or protected operator tooling.

Operational evidence

For each action, preserve the decision, the worker outcome, the idempotency key, safe resource references, latency, proof status, and redaction status. This evidence supports incident response and control narratives because it shows what the system did at runtime rather than only describing what the policy document intended. HaltState supports alignment work; it is not a substitute for legal advice or a compliance certification.