HestiaOS SDK — Domain Interface for the HestiaOS platform
Project description
🏠 HestiaOS SDK
Python SDK for the HestiaOS platform — deterministic governance, multi-agent orchestration, and local-first AI execution.
Installation
pip install hestiaos
Requires Python 3.11+.
Quickstart
Python Client
from hestiaos import Client
client = Client(base_url="http://localhost:8000")
# Run a command through the governance pipeline
result = client.run("create a report")
print(result.result) # "processed: create a report"
print(result.trace_id) # "abc-123-def"
print(result.mode) # "ALLOW"
# Check system health
status = client.system.status()
print(status.status) # "healthy"
# Retrieve a governance trace
trace = client.governance.trace("abc-123-def")
CLI
# Run a command
hestiaos run "create a report"
# Check server health
hestiaos health
# Retrieve a trace
hestiaos trace abc-123-def
# JSON output (pipe to jq)
hestiaos run "hello" --json | jq
# Custom server URL
hestiaos --base-url http://localhost:8000 health
CLI Reference
| Command | Description |
|---|---|
hestiaos run <text> |
Execute a command through the governance pipeline |
hestiaos trace <id> |
Retrieve a governance trace by ID |
hestiaos health |
Check server health status |
| Global Option | Description |
|---|---|
--base-url, -u |
API base URL (default: http://localhost:8000) |
--api-key, -k |
API key for authentication |
--json, -j |
Output as raw JSON |
API
Client(base_url, api_key=None)
| Method | Returns | Description |
|---|---|---|
client.run(input_text) |
RunResponse |
Execute through governance pipeline |
client.governance.trace(trace_id) |
dict | None |
Retrieve governance trace |
client.governance.explain(command_type, command_input) |
dict |
Explain a governance decision |
client.system.status() |
SystemStatus |
Server health status |
Models
RunResponse:result,trace_id,output,mode,budget,latency_msTraceResponse:trace_id,decision,violations,latency_msHealthResponse:status,version,uptime_secondsGovernanceBlock: Raised when governance blocks execution
Development
# Clone and install
git clone <repo-url> && cd hestiaos
python -m venv venv && source venv/bin/activate
pip install -e .
# Run tests
pytest tests/test_sdk_client.py tests/test_cli.py -v
License
MIT — see LICENSE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
hestiaos-0.1.0.tar.gz
(452.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
hestiaos-0.1.0-py3-none-any.whl
(14.5 kB
view details)
File details
Details for the file hestiaos-0.1.0.tar.gz.
File metadata
- Download URL: hestiaos-0.1.0.tar.gz
- Upload date:
- Size: 452.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
28134f3a925428fa8cae2fe072ed40d506443abb8b6fa92b26735d2539bfff04
|
|
| MD5 |
a16a578d718f1f14b8528f5237cb32dd
|
|
| BLAKE2b-256 |
fc65bebe1248bc600eef94871df142c0e07b75e750c53556d53d8b6b0a65619f
|
File details
Details for the file hestiaos-0.1.0-py3-none-any.whl.
File metadata
- Download URL: hestiaos-0.1.0-py3-none-any.whl
- Upload date:
- Size: 14.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
590c72873c8acf2a55423b60397760e10c058de11ab72909c85fb7d427ff76e4
|
|
| MD5 |
aa2c3139b5a599f8a9d661c0297bb435
|
|
| BLAKE2b-256 |
d8f0fa13ba6fd24b67900bd3a53fc3f594024fae36c230d9f6ec76e166c13ca2
|