What you need
See Admin basics for ports and auth. Summary:
Primary surfaces are CLI and TUI. Optional API when zyvor-api is deployed.
1. Open the product
Primary surfaces are CLI and TUI. Optional API when zyvor-api is deployed.
2. Sign in / authenticate
SAML/OIDC on zyvor-api when enabled; local CLI needs disk/image access.
3. Orient yourself
Use the quick map on the customer docs home, then open the home surface (getting-started).
4. First workflows
Follow Common workflows for the shortest useful paths.
Next steps
GuestKit is organized by navigation groups (sidebar, desktop nav, or CLI command groups). Use search / command palette when available.
Surfaces
| Need | Surface |
|---|---|
| Inspect | guestkit inspect |
| Doctor | guestkit doctor |
| Fix plans | fix-plans / repair |
| TUI | guestctl |
Browse vs act
Inventory and status views are safe to explore. Mutating actions (deploy, migrate, sign, remediate) follow role gates and confirmation dialogs — review impact first.
Related
- Open the home surface (
getting-started) from Getting Started. - Use the page index to jump to the domain you need.
- Complete the job, then confirm status on Jobs / Activity / Audit surfaces when present.