Environment Setup

Set up your development environment for building Hyperstack stacks.

Just want to use an existing stack?

If you’re consuming data from a deployed stack, see Using Stacks → Installation instead.

---

Prerequisites

• Rust 1.70+ (install via rustup)
• A code editor with Rust support (VS Code + rust-analyzer recommended)

---

CLI

The Hyperstack CLI (hs) handles project initialization, deployment, and SDK generation.

cargo install hyperstack-cli

Verify the installation:

hs --version

PATH configuration

Ensure ~/.cargo/bin is in your PATH. Most Rust installations configure this automatically.

---

Rust Dependencies

Add the Hyperstack crate to your stack project’s Cargo.toml:

[dependencies]
hyperstack = "0.5.3"
serde = { version = "1.0", features = ["derive"] }

This gives you access to:

• #[hyperstack] — The main macro for defining stacks
• #[entity], #[map], #[aggregate] — Field-level attributes
• Stream derive macro — Generates streaming infrastructure

---

Project Initialization

Create a new stack project:

cargo new my-stack --lib
cd my-stack

Initialize Hyperstack configuration:

hs init

This creates hyperstack.toml and a .hyperstack/ directory for generated stack files.

hyperstack.toml:

[project]
name = "my-stack"

[sdk]
output_dir = "./generated"

Validate your setup:

hs config validate

---

Environment Variables

Variable	Description	Default
HYPERSTACK_API_URL	Override API endpoint	Production API

---

Next Steps

• Stack Definitions — Understand the declarative model
• Your First Stack — Build an end-to-end streaming app
• Macros Reference — Complete attribute documentation

---

Troubleshooting

Issue	Solution
hs: command not found	Add ~/.cargo/bin to your PATH
cargo build fails	Ensure hyperstack = "0.5.3" is in Cargo.toml
hs init fails	Check you’re in a valid Cargo project