Documentation Index

Fetch the complete documentation index at: https://mintlify.com/hypertekorg/hyperstack/llms.txt

Use this file to discover all available pages before exploring further.

​

CLI Overview

​

Installation

​

Core Workflow

1. Create a new project from a template
   hs create my-stack --template react-ore
   
2. Initialize configuration if starting from an existing project
   hs init
   
3. Deploy your stack to production
   hs up
   
4. Generate SDKs for client applications
   hs sdk create typescript my-stack
   

​

Command Categories

​

Project Management

• hs create - Create a new project from a template
• hs init - Initialize configuration for an existing project

​

Deployment

• hs up - Deploy a stack (push + build + deploy)
• hs push - Push local stacks to remote (alias for hs stack push)
• hs status - Show overview of stacks, builds, and deployments

​

Stack Management

• hs stack - Manage deployed stacks (list, show, delete, rollback, stop)
• hs explore - Discover stacks and explore their schemas

​

SDK Generation

• hs sdk - Generate TypeScript and Rust SDKs

​

Build Management (Advanced)

• hs build - Low-level build management (hidden from help)

​

Configuration & Authentication

• hs auth - Login, logout, check authentication status
• hs config - Validate configuration files

​

Global Flags

# Install bash completions
hs --completions bash > /usr/local/etc/bash_completion.d/hs

# Install zsh completions
hs --completions zsh > /usr/local/share/zsh/site-functions/_hs

​

Configuration File

[[stack]]
name = "my-stack"
ast_file = "stacks/my-stack.stack"

[sdk.typescript]
output = "./sdk/typescript"
package_name = "@my-org/my-stack-sdk"

[sdk.rust]
output = "./sdk/rust"
crate_name = "my_stack_sdk"

​

Return Codes

• 0 - Success
• 1 - Error (with error message printed to stderr)

​

Telemetry

• View telemetry status: hs telemetry status
• Opt out: hs telemetry disable
• Opt in: hs telemetry enable

​

Getting Help

# Show general help
hs --help

# Show command-specific help
hs up --help
hs stack --help

​

Next Steps

• Install the CLI
• Set up authentication
• Deploy your first stack