Skip to content

CLI Reference

Complete documentation for the wavectl command-line interface tool.

In This Section

  • Command Reference - Complete reference for all wavectl commands, options, and usage examples

About wavectl

wavectl is the primary command-line tool for deploying, configuring, and managing Waveshift infrastructure. It provides a simple interface for complex AWS orchestration tasks.

Key Features

  • Infrastructure Deployment - Deploy complete Waveshift systems to AWS
  • Site Management - Register and manage physical locations
  • Router Configuration - Configure GL.iNet routers as hubs
  • Health Monitoring - Check system health and connectivity
  • Session Management - Connect to Waveshift servers via SSM

Common Commands

# Initialise directory
wavectl init --identity-provider <provider> --profile <profile> --region <region>

# Deploy infrastructure
wavectl deploy

# Create access server to connect securely to waveshift
wavectl access-servers --add 1

# Connect to server cli
wavectl start-session waveshift

# Manage sites
wavectl sites list
wavectl sites add <site-name>

# Configure router hubs
wavectl configure-hub

Getting Help

For help with any command, use:

wavectl --help
wavectl <command> --help