Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/stratosphere-ve/core/llms.txt

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

Stratosphere Core is a Go CLI program. You do not need to compile a binary to get started — go run main.go is all you need. This guide walks you through cloning the repository, installing dependencies, and using the interactive menu for the first time.

Prerequisites

  • Go 1.21 or newer — Download from go.dev/dl. Verify your version with go version.
  • Git — Required to clone the repository.

Steps

1

Clone the repository

Clone the Stratosphere Core repository and move into the project directory.
git clone https://github.com/stratosphere-ve/core.git && cd core
2

Install dependencies

Download the Go module dependencies declared in go.mod. This fetches gopsutil/v3 and its transitive dependencies.
go mod download
3

Run the CLI

Start the CLI directly from source using go run.
go run main.go
The program prints a welcome message and the full menu, then waits for your input:
Welcome to the Stratosphere CLI!
This is just a simple mockup/placeholder of how everything will work in the future (in a GUI of course, not a CLI)

What would you like to do next?
-WATCHERS-
1. Change CpuWatcher Polling rate
2. View CPU usage

3. Change RAMWatcher Polling rate
4. View RAM usage

-VM MANAGEMENT- (Includes VM watchers and actions)

5. View VM Resource Allocation
6. View VM Status
7. View " View VM Resource Allocation" + "View VM Status"
8. Create VM
9. Delete VM
10. Manage VM


-OTHER-
50. Exit
4

Try your first watcher

Type 2 and press Enter to view live CPU usage. The cpuwatcher package uses gopsutil to read system CPU utilization and prints the result to the terminal.
2
You should see output showing current CPU usage across your cores.
Enter 50 at the menu prompt to exit the program cleanly.

What each menu option does

OptionAction
1Set a custom polling rate for the CPU watcher (2-second example)
2View current CPU usage
3Set a custom polling rate for the RAM watcher
4View current RAM usage
5View VM resource allocation
6View VM running status
7View both VM resource allocation and status
8Create a new VM
9Delete an existing VM
10Manage a VM (start, stop, restart, rename)
50Exit

Next steps

Build from source

Compile a standalone binary instead of using go run.

Introduction

Learn about the architecture and project status.

Build docs developers (and LLMs) love