Skip to content

README updates#37

Merged
sjmiller609 merged 3 commits intomainfrom
readme-updates
Dec 11, 2025
Merged

README updates#37
sjmiller609 merged 3 commits intomainfrom
readme-updates

Conversation

@sjmiller609
Copy link
Collaborator

@sjmiller609 sjmiller609 commented Dec 11, 2025

Note

Adds a full development guide, rewrites the README for quick start and usage, and upgrades the installer with system setup steps and robust release selection.

  • Docs:
    • Add DEVELOPMENT.md with setup, config, testing, TLS ingress, and telemetry guidance.
    • Overhaul README.md: add banner, requirements, Quick Start, remote CLI install, usage examples, ingress/TLS/logging sections, and link to development guide.
  • Installer (scripts/install.sh):
    • Add system setup: ensure KVM group membership, enable IPv4 forwarding persistently, and raise file descriptor limits for ingress.
    • Implement find_release_with_artifact and use it to select API/CLI releases with matching artifacts.
    • Refine installation: install CLI with wrapper, token tool, config templating, capabilities, and service setup improvements.

Written by Cursor Bugbot for commit 9d87695. This will update automatically on new commits. Configure here.

Comment on lines +40 to +43
# Find the most recent release that has a specific artifact available
# Usage: find_release_with_artifact <repo> <archive_prefix> <os> <arch>
# Returns: version tag (e.g., v0.5.0) or empty string if not found
find_release_with_artifact() {
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if you install while stainless is publishing there's a possible issue if you find the latest release but there aren't artifacts published there yet. So use the most recent release that has artifacts

@@ -0,0 +1,291 @@
# Development Guide
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this used to be the README

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice. I think if we include an architecture diagram it should go here

@@ -0,0 +1,291 @@
# Development Guide
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice. I think if we include an architecture diagram it should go here


**Install on Debian/Ubuntu:**
```bash
sudo apt-get install erofs-utils dnsmasq
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

iptables too i think (i had to do this on a fresh debian install)

@sjmiller609 sjmiller609 merged commit 1356047 into main Dec 11, 2025
4 checks passed
@sjmiller609 sjmiller609 deleted the readme-updates branch December 11, 2025 20:06
sjmiller609 added a commit that referenced this pull request Feb 28, 2026
* CLI: Update hypeman SDK to a9a0d6c and add new commands/flags

Update hypeman-go SDK and add CLI coverage for missing SDK methods:

New commands:
- `hypeman image list` for client.Images.List()
- `hypeman image get` for client.Images.Get()
- `hypeman image delete` for client.Images.Delete()
- `hypeman volume create` for client.Volumes.New()
- `hypeman volume list` for client.Volumes.List()
- `hypeman volume get` for client.Volumes.Get()
- `hypeman volume delete` for client.Volumes.Delete()
- `hypeman volume attach` for client.Instances.Volumes.Attach()
- `hypeman volume detach` for client.Instances.Volumes.Detach()
- `hypeman ingress get` for client.Ingresses.Get()
- `hypeman build list` for client.Builds.List()
- `hypeman build get` for client.Builds.Get()
- `hypeman build cancel` for client.Builds.Cancel()

New flags:
- `--skip-guest-agent` on `hypeman run` for InstanceNewParams.SkipGuestAgent
- `--skip-kernel-headers` on `hypeman run` for InstanceNewParams.SkipKernelHeaders

Co-authored-by: Cursor <[email protected]>

* Consistency tweaks

* CLI: Update hypeman SDK to b99ed48 and add new flags

- Updated hypeman-go to b99ed48
- Added --volume/-v flag on `hypeman run` for InstanceNewParams.Volumes
- Added --base-image-digest, --cache-scope, --global-cache-key,
  --is-admin-build, --secrets flags on `hypeman build` for BuildNewParams

Co-authored-by: Cursor <[email protected]>

* CLI: Update hypeman SDK to 5fc15d8 and add vz hypervisor support

- Updated hypeman-go to v0.9.8 (5fc15d8)
- Added "vz" (Virtualization.framework) hypervisor option to `hypeman run --hypervisor`
- Added explicit "vz" case to formatHypervisor in `hypeman ps` output

Co-authored-by: Cursor <[email protected]>

---------

Co-authored-by: kernel-internal[bot] <260533166+kernel-internal[bot]@users.noreply.github.com>
Co-authored-by: Cursor <[email protected]>
Co-authored-by: Steven Miller <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants