hvx is a Go command-line client for the OpenHVX tenant and admin HTTP APIs.
It manages contexts, lists resources, and submits and inspects asynchronous tasks.
The backend builds the internal agent protocol envelopes.
Status: active development. HTTP behavior is tested with local test servers; validation against a complete deployed OpenHVX environment remains necessary.
| Guide | Contents |
|---|---|
| Architecture | Client boundaries, safety rules, and limitations |
| Configuration | Endpoints, credentials, environment, and migration |
| Development | Builds, tests, and CI |
| Task protocol | HTTP idempotency, accepted tasks, and polling |
| API | Commands and HTTP route mapping |
Use Go 1.25 or newer. From src:
go build -o ../bin/hvx ./cmd/hvxRun bin/hvx --help, then follow the configuration guide.
Use a patched Go toolchain when building distributable binaries.
Common commands after initialization:
bin/hvx get vms
bin/hvx start vm web01 --wait
bin/hvx create -f examples/task.example.json
bin/hvx get requests
bin/hvx retry REQUEST_ID
bin/hvx get tasksKeys are generated and saved automatically before submission. Use retry to recover
an uncertain request; running a new task command creates a new operation.
Named contexts select environments and accounts through hvx config use-context.