Installation

Set up the Hyperstack CLI and SDKs for your project.

---

CLI Installation

The Hyperstack CLI (hs) manages specs, deployments, and SDK generation.

From Source (Recommended)

# Clone the repository
git clone https://github.com/HyperTekOrg/hyperstack-oss
cd hyperstack-oss

# Install globally
cargo install --path cli

# Verify installation
hs --version

Build Without Installing

target/release/hs

cargo build --release -p hyperstack-cli

---

SDK Installation

TypeScript / React

npm install hyperstack-react

Peer dependencies:

• react ^18.0.0
• zustand ^4.0.0

# Install peer dependencies if needed
npm install react zustand

Rust

Add to your Cargo.toml:

[dependencies]
hyperstack-sdk = { git = "https://github.com/HyperTekOrg/hyperstack-oss", branch = "main" }
tokio = { version = "1.0", features = ["full"] }

Python

pip install hyperstack-sdk

---

Authentication

Before deploying specs, authenticate with Hyperstack:

# Create a new account
hs auth register

# Or login to existing account
hs auth login

# Verify authentication
hs auth whoami

Credentials are stored in ~/.hyperstack/credentials.toml.

---

Project Setup

Initialize a New Project

# In your project directory
hs init

This creates hyperstack.toml and auto-discovers any existing AST files.

Configuration File

hyperstack.toml:

[project]
name = "my-project"

[sdk]
output_dir = "./generated"

# Specs are auto-discovered from .hyperstack/*.ast.json
# Define explicitly for custom naming:
[[specs]]
name = "my-spec"
ast = "MyEntity"

Validate Configuration

hs config validate

---

Development Setup

For Spec Development (Rust)

If you’re writing specs, add these dependencies:

[dependencies]
hyperstack = { path = "../hyperstack-oss/main/hyperstack", features = ["full"] }
hyperstack-spec-macros = { path = "../hyperstack-oss/main/spec-macros" }
hyperstack-interpreter = { path = "../hyperstack-oss/main/interpreter" }

# For local server
hyperstack-server = { path = "../hyperstack-oss/main/rust/hyperstack-server" }

# Required
tokio = { version = "1.0", features = ["full"] }
serde = { version = "1.0", features = ["derive"] }
borsh = { version = "1.5", features = ["derive"] }

For Frontend Development

# Install SDK
npm install hyperstack-react

# For local development, use localhost WebSocket
# For production, use your deployed spec URL

---

Environment Variables

Variable	Description	Default
HYPERSTACK_API_URL	Override API endpoint	Production API

---

Verify Installation

CLI

hs --help
hs auth status

TypeScript SDK

import { HyperstackProvider, useHyperstack, defineStack } from 'hyperstack-react';

// If this compiles, you're ready to go
const TestStack = defineStack({
  name: 'test',
  views: {},
});

---

Next Steps

• React Quickstart - Build your first real-time app
• CLI Commands - Full command reference
• Creating Specs - Create custom data streams

---

Troubleshooting

Issue	Solution
hs: command not found	Ensure ~/.cargo/bin is in your PATH
Cannot find module 'hyperstack-react'	Run npm install hyperstack-react
Peer dependency warnings	Install react and zustand explicitly
Authentication failed	Run hs auth login to refresh credentials