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.

​

Authentication

​

Login

hs auth login

​

Non-interactive Login

hs auth login --key YOUR_API_KEY

​

Getting an API Key

1. Sign up at usehyperstack.com
2. Navigate to Settings → API Keys
3. Create a new API key
4. Copy the key (it’s only shown once)

​

Check Authentication Status

​

Local Status (No API Call)

hs auth status

Authenticated: Yes
API Key: hs_••••••••••••1234
Stored at: /home/user/.config/hyperstack/credentials.toml

​

Verify with API

hs auth whoami

Authenticated as: john@example.com
Organization: Acme Inc
Plan: Pro
API Key: hs_••••••••••••1234

​

Logout

hs auth logout

​

Using in CI/CD

​

GitHub Actions

name: Deploy Stack

on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      
      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
      
      - name: Install Hyperstack CLI
        run: cargo install hyperstack-cli
      
      - name: Authenticate
        run: hs auth login --key ${{ secrets.HYPERSTACK_API_KEY }}
      
      - name: Deploy
        run: hs up

​

GitLab CI

deploy:
  image: rust:latest
  before_script:
    - cargo install hyperstack-cli
    - hs auth login --key $HYPERSTACK_API_KEY
  script:
    - hs up
  only:
    - main

​

Environment Variables

export HYPERSTACK_API_KEY=hs_your_api_key_here

​

Credentials Storage

​

Location

• macOS/Linux: ~/.config/hyperstack/credentials.toml
• Windows: %APPDATA%\hyperstack\credentials.toml

​

Format

api_key = "hs_your_api_key_here"

​

Permissions

​

Security Best Practices

1. Never commit API keys to version control
2. Rotate keys regularly from the dashboard
3. Use separate keys for different environments (development, staging, production)
4. Revoke keys immediately if compromised
5. Use CI/CD secrets for automated deployments

​

Troubleshooting

​

Invalid API Key

Error: Invalid API key

• Verify the key is correct
• Check if the key has been revoked
• Generate a new key from the dashboard

​

Permission Denied

Error: Permission denied: ~/.config/hyperstack/credentials.toml

chmod 600 ~/.config/hyperstack/credentials.toml

​

Network Errors

Error: Failed to connect to API

• Check your internet connection
• Verify firewall settings
• Check if api.usehyperstack.com is accessible

​

Next Steps

• Create a new project
• Initialize an existing project
• Deploy your first stack