hypersdk

Reference Documentation

This directory contains technical reference documentation for HyperSDK.

Contents

CLI Reference - Command-line interface reference for all HyperSDK tools
Configuration Reference - Complete configuration file reference
Performance Tuning - Performance optimization guide
Troubleshooting Guide - Common issues and solutions

Quick Reference

Command Line Tools

HyperSDK provides three main command-line tools:

hyperctl - Interactive TUI for VM migration
hyperexport - Batch VM export tool
hypervisord - Daemon service for automated migrations

See CLI Reference for complete command syntax and options.

Configuration

Configuration can be provided via:

YAML configuration files
JSON configuration files
Command-line flags
Environment variables

See Configuration Reference for all available options.

Performance

For optimal performance:

Configure appropriate bandwidth limits
Use concurrent export workers
Enable compression for network transfers
Monitor system resources

See Performance Tuning for detailed optimization strategies.

Getting Help

If you encounter issues:

Check the Troubleshooting Guide
Review logs in /var/log/hypervisord/
Consult the API Documentation
Report issues on GitHub

Getting Started - Initial setup and first migration
User Guides - Step-by-step usage guides
API Documentation - REST API reference
Examples - Configuration examples

This site is open source. Improve this page.