One binary, one directory, first verified workflow.

Install one binary

Install the public 0.1.0 release from crates.io, or download a signed native archive from GitHub Releases.

• The package installs one executable named hyphae.
• Use --locked so dependency resolution matches the published package.

cargo install hyphae-cli --version 0.1.0 --locked
hyphae version --json

Choose one data directory

The data directory is the complete local ownership boundary. Only one engine or server process owns it at a time.

• Unix: export HYPHAE_DATA_DIR="$PWD/hyphae-data"
• PowerShell: $env:HYPHAE_DATA_DIR = "$PWD\hyphae-data"

Write and query structured data

KV and structured query are deterministic and require no LLM, embeddings, or external database.

• Writes are atomic.
• Caller-visible mutation UUIDs make retries durable and idempotent.
• Queries either complete within their budgets or fail without partial success.

hyphae put --key alpha --json '{"group":"edge","score":91}'
hyphae query --field group --equals '"edge"' --sort score --proof-out result.hyproof

Back up and inspect recovery

Backups are portable logical artifacts. Verify them before relying on them, and use doctor to inspect complete local recovery evidence.

hyphae backup --out ./hyphae-backup
hyphae backup-verify --backup ./hyphae-backup
hyphae doctor

Know what did not enter the architecture

The base flow has not installed Postgres, Redis, Valkey, a cloud agent, an embedding model, or an LLM. Add semantic retrieval or the /v1 server only when the application requires those optional surfaces.

• Embedded Rust is the recommended in-process facade.
• The HTTP server is loopback-first and proof-bearing.
• Framework adapters remain optional consumers.