{"id":38549839,"url":"https://github.com/kernel/hypeman-cli","last_synced_at":"2026-03-07T22:30:46.969Z","repository":{"id":324843560,"uuid":"1094501646","full_name":"kernel/hypeman-cli","owner":"kernel","description":"hypeman cli tool","archived":false,"fork":false,"pushed_at":"2026-03-03T16:45:52.000Z","size":489,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-03T20:52:50.922Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kernel.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-11T19:45:04.000Z","updated_at":"2026-03-03T16:44:22.000Z","dependencies_parsed_at":"2026-01-08T09:02:12.388Z","dependency_job_id":null,"html_url":"https://github.com/kernel/hypeman-cli","commit_stats":null,"previous_names":["onkernel/hypeman-cli","kernel/hypeman-cli"],"tags_count":25,"template":false,"template_full_name":null,"purl":"pkg:github/kernel/hypeman-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kernel%2Fhypeman-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kernel%2Fhypeman-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kernel%2Fhypeman-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kernel%2Fhypeman-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kernel","download_url":"https://codeload.github.com/kernel/hypeman-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kernel%2Fhypeman-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30234446,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T19:01:10.287Z","status":"ssl_error","status_checked_at":"2026-03-07T18:59:58.103Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-17T07:32:00.375Z","updated_at":"2026-03-07T22:30:46.952Z","avatar_url":"https://github.com/kernel.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hypeman CLI\n\nThe official CLI for [Hypeman](https://github.com/kernel/hypeman/).\n\n## Installation\n\n### Installing with Homebrew\n\n```sh\nbrew install kernel/tap/hypeman\n```\n\n### Installing with Go\n\n\u003c!-- x-release-please-start-version --\u003e\n\n```sh\ngo install 'github.com/kernel/hypeman-cli/cmd/hypeman@latest'\n```\n\n### Running Locally\n\n\u003c!-- x-release-please-start-version --\u003e\n\n```sh\ngo run cmd/hypeman/main.go\n```\n\n\u003c!-- x-release-please-end --\u003e\n\n## Usage\n\n```sh\n# Pull an image\nhypeman pull nginx:alpine\n\n# Boot a new VM (auto-pulls image if needed)\nhypeman run --name my-app nginx:alpine\n\n# List running VMs\nhypeman ps\n# show all VMs\nhypeman ps -a\n\n# View logs of your app\n# All commands support using VM name, ID, or partial ID\nhypeman logs my-app\nhypeman logs -f my-app\n\n# Execute a command in a running VM\nhypeman exec my-app whoami\n# Shell into the VM\nhypeman exec -it my-app /bin/sh\n\n# VM lifecycle\n# Turn off the VM\nhypeman stop my-app\n# Boot the VM that was turned off\nhypeman start my-app\n# Put the VM to sleep (paused)\nhypeman standby my-app\n# Awaken the VM (resumed)\nhypeman restore my-app\n\n# Create a reverse proxy (\"ingress\") from the host to your VM\nhypeman ingress create --name my-ingress my-app --hostname my-nginx-app --port 80 --host-port 8081\n\n# List ingresses\nhypeman ingress list\n\n# Curl nginx through your ingress\ncurl --header \"Host: my-nginx-app\" http://127.0.0.1:8081\n\n# Delete an ingress\nhypeman ingress delete my-ingress\n\n# Delete all VMs\nhypeman rm --force --all\n```\n\nMore ingress features:\n- Automatic certs\n- Subdomain-based routing\n\n```bash\n# Make your VM if not already present\nhypeman run --name my-app nginx:alpine\n\n# This requires configuring the Hypeman server with DNS credentials\n# Change --hostname to a domain you own\nhypeman ingress create --name my-tls-ingress my-app --hostname hello.hypeman-development.com -p 80 --host-port 7443 --tls\n\n# Curl through your TLS-terminating reverse proxy configuration\ncurl \\\n  --resolve hello.hypeman-development.com:7443:127.0.0.1 \\\n  https://hello.hypeman-development.com:7443\n\n# OR... Ingress also supports subdomain-based routing\nhypeman ingress create --name my-tls-subdomain-ingress '{instance}' --hostname '{instance}.hypeman-development.com' -p 80 --host-port 8443 --tls\n\n# Curling through the subdomain-based routing\ncurl \\\n  --resolve my-app.hypeman-development.com:8443:127.0.0.1 \\\n  https://my-app.hypeman-development.com:8443\n\n# Delete all ingress\nhypeman ingress delete --all\n```\n\nMore logging features:\n- Cloud Hypervisor logs\n- Hypeman operational logs\n\n```bash\n# View Cloud Hypervisor logs for your VM\nhypeman logs --source vmm my-app\n# View Hypeman logs for your VM\nhypeman logs --source hypeman my-app\n```\n\nFor details about specific commands, use the `--help` flag.\n\nThe CLI also provides resource-based commands for more advanced usage:\n\n```sh\nhypeman [resource] [command] [flags]\n```\n\n## Resource Management\n\n### Viewing Server Resources\n\nCheck available server capacity, current allocations, and GPU availability:\n\n```bash\n# Show server resource status (CPU, memory, disk, network, GPU)\nhypeman resources\n\n# Show resources as JSON\nhypeman resources --format json\n\n# Show only GPU information\nhypeman resources --transform gpu\n```\n\n### Per-VM Resource Limits\n\nControl resource allocation for instances:\n\n```bash\n# Set disk I/O limit\nhypeman run --disk-io 100MB/s --name io-limited myimage:latest\n\n# Set network bandwidth limits\nhypeman run --bandwidth-down 1Gbps --bandwidth-up 500Mbps --name bw-limited myimage:latest\n\n# Combine multiple resource options\nhypeman run \\\n  --cpus 4 \\\n  --memory 8GB \\\n  --gpu-profile L40S-2Q \\\n  --disk-io 200MB/s \\\n  --bandwidth-down 10Gbps \\\n  --name ml-training \\\n  pytorch:latest\n```\n\n## GPU support\n\n\n### GPU Passthrough\n\nFor full GPU passthrough (entire GPU dedicated to one VM):\n\n```bash\n# Discover available passthrough-capable devices\nhypeman device available\n\n# Register a GPU for passthrough\nhypeman device register --pci-address 0000:a2:00.0 --name my-gpu\n\n# List registered devices\nhypeman device list\n\n# Run an instance with the GPU attached\nhypeman run --device my-gpu --hypervisor qemu --name gpu-workload cuda:12.0\n\n# When done, unregister the device\nhypeman device delete my-gpu\n```\n\n### Nvidia vGPU\n\nUse NVIDIA vGPU to share a physical GPU across multiple VMs:\n\n```bash\n# Run with a vGPU profile\nhypeman run --gpu-profile L40S-1Q --name ml-workload pytorch:latest\n\n# Run with more vGPU resources\nhypeman run --gpu-profile L40S-4Q --cpus 8 --memory 32GB --name training-job tensorflow:latest\n```\n\n### Hypervisor Selection\n\nChoose between Cloud Hypervisor (default) and QEMU:\n\n```bash\n# Run with QEMU (more compatible with some features like vGPU)\nhypeman run --hypervisor qemu --name qemu-vm myimage:latest\n\n# Run with Cloud Hypervisor (default, faster boot)\nhypeman run --hypervisor cloud-hypervisor --name ch-vm myimage:latest\n```\n\n## Global Flags\n\n- `--debug` - Enable debug logging (includes HTTP request/response details)\n- `--version`, `-v` - Show the CLI version\n\n## Development\n\n### Testing Preview Branches\n\nWhen developing features in the main [hypeman](https://github.com/kernel/hypeman) repo, Stainless automatically creates preview branches in `stainless-sdks/hypeman-cli` with your API changes. You can check out these branches locally to test the CLI changes:\n\n```bash\n# Checkout preview/\u003cbranch\u003e (e.g., if working on \"devices\" branch in hypeman)\n./scripts/checkout-preview devices\n\n# Checkout an exact branch name\n./scripts/checkout-preview -b main\n./scripts/checkout-preview -b preview/my-feature\n```\n\nThe script automatically adds the `stainless` remote if needed and also updates `go.mod` to point the `hypeman-go` SDK dependency to the corresponding preview branch in `stainless-sdks/hypeman-go`.\n\n\u003e **Warning:** The `go.mod` and `go.sum` changes from `checkout-preview` are for local testing only. Do not commit these changes.\n\nAfter checking out a preview branch, you can build and test the CLI:\n\n```bash\ngo build -o hypeman ./cmd/hypeman\n./hypeman --help\n```\n\nYou can also point the SDK dependency independently:\n\n```bash\n# Point hypeman-go to a specific branch\n./scripts/use-sdk-preview preview/my-feature\n\n# Point to a specific commit\n./scripts/use-sdk-preview abc1234def567\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkernel%2Fhypeman-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkernel%2Fhypeman-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkernel%2Fhypeman-cli/lists"}