Skip to main content

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.

​
Installing the CLI

The Hyperstack CLI (hs) is distributed as a standalone binary and via Cargo, Rust’s package manager.

​
Prerequisites

  • Rust 1.70+ - Install via rustup

​
Install

cargo install hyperstack-cli
This installs the hs binary to your Cargo bin directory (typically ~/.cargo/bin).

​
Update

cargo install hyperstack-cli --force

​
Install from Binary

Binary releases are coming soon. For now, use the Cargo installation method.

​
Install from Source

For the latest development version: 
# Clone the repository
git clone https://github.com/HyperTekOrg/hyperstack.git
cd hyperstack/cli

# Build and install
cargo install --path .

​
Verify Installation

Confirm the CLI is installed correctly: 
hs --version
Expected output: 
hyperstack-cli 0.5.3

​
Shell Completions

Enable tab completion for your shell: 
# Install completions
hs --completions bash > /usr/local/etc/bash_completion.d/hs

# Reload your shell
source ~/.bashrc

​
Configuration Directory

The CLI stores credentials and settings in:
  • macOS/Linux: ~/.config/hyperstack/
  • Windows: %APPDATA%\hyperstack\

​
Files Created

  • credentials.toml - API key and authentication tokens
  • telemetry.toml - Telemetry consent and settings

​
Development Mode

For local development against a local Hyperstack API server: 
# Build with local feature flag
cargo install --path . --features local
This changes the API endpoint from https://api.usehyperstack.com to http://localhost:3000.

​
Troubleshooting

​
Command not found

If hs is not found after installation:
  1. Ensure ~/.cargo/bin is in your PATH: 
    echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
  2. Verify the binary exists: 
    ls ~/.cargo/bin/hs

​
Permission denied

If you get permission errors: 
chmod +x ~/.cargo/bin/hs

​
SSL/TLS errors

The CLI uses rustls for HTTPS. If you encounter SSL errors, ensure your system has up-to-date CA certificates.

​
Next Steps

Build docs developers (and LLMs) love

Get started for freeTalk to us