Skip to content
Terminal UI

Terminal UI

Podplane uses a few terminal UI styles for interactive commands:

StyleUsed byPurpose
Configuration wizardcluster create, oidc createCollect settings when creating a new config.
VM boot wizardlocal startShow local VM startup tasks and health checks.
OpenTofu/Terraform plan-and-apply dashboardcluster create, cluster upgrade, oidc createReview infrastructure changes and track apply progress.
Deletion workflowcluster delete, oidc deleteConfirm removal and track destruction and cleanup.

Before the style-specific controls, here’s how to switch modes and stop execution safely.

TUI and Inline modes

TUI mode uses the terminal’s alternate screen; Inline mode keeps scrolling output and prompts in the main screen. The TUI needs 80 columns × 24 rows. Resize a smaller terminal or press Ctrl+O to continue in Inline mode. Switching preserves answers, does not restart execution or approve the plan, and lasts for the rest of that run. Non-interactive runs use Inline mode. Type yes to approve, or use --auto-approve to skip confirmation.

Ctrl-C requests a safe stop. Wait for cleanup to finish. Cancellation and failure do not undo applied changes; inspect the logs before retrying.

Shortcut keys are bold teal; their descriptions are muted. In lists, checklists, resource tables, and text panels, press /, type a term, then Enter to search. Use n for the next matching row or line and N for the previous one; search wraps at either end. Matching is literal and case-insensitive. Esc cancels search entry, or clears an active search; press Esc again to close the panel. Search persists from Review to Apply. It respects the hide-completed filter and never approves or toggles an item. Searching logs pauses following; End resumes it.

Configuration wizard

cluster create and oidc create keep questions, preparation, and plan/apply in one session, including OIDC setup started from cluster creation. Ctrl+L opens preparation logs. Exiting leaves a short result and any warnings; failures also preserve diagnostics and a resume command.

OpenTofu/Terraform plan-and-apply dashboard

When applying infrastructure changes, Podplane runs OpenTofu or Terraform and shows its plan and progress in this dashboard. The footer tracks Questions → Init → Plan → Review → Apply.

Review and progress

  • Resource table: lists planned changes before apply starts. Use ↑/↓ to select a resource and Enter to inspect its before/after values. Sensitive values are hidden. Review shows resources and actions; status icons and the Status column appear during apply. Page up with Ctrl+B, PgUp, or b; page down with Ctrl+F, PgDn, or Space. You can also scroll over the table with your mouse wheel and click a resource to open its details.
  • Approval: Tab selects Cancel or Approve and apply; Enter confirms. Inspecting a resource never approves the plan.
  • Progress: the status, elapsed time, and progress bar show apply activity. The percentage counts completed resource changes, not time remaining.
  • Hide completed: during apply, press h to hide or show completed resources. Completed resources are hidden by default. The filter preserves plan order and does not change overall progress.
  • Details, logs, and outputs: Enter opens resource details, l opens engine logs, and o opens output changes. Esc closes the panel.

Panel shortcuts

The mouse wheel scrolls details, logs, and outputs when the pointer is over the panel.

ActionKeys
Scroll one line↑ / ↓
Page upCtrl+B, PgUp, or b
Page downCtrl+F, PgDn, or Space
Jump to topHome or g
Jump to bottomEnd or G
Close panelEsc

Logs open following new output. Scrolling up pauses following; End or G resumes it. The panel shows Following or Paused.

In logs, drag across text to select and copy it on mouse-release. Selection pauses updates; scrolling or pressing a key clears it. Press c to copy all retained logs (up to 4 MiB per copy). Logs have a 64 MiB retention budget; reaching it discards oldest entries and shows a warning. Copying uses the clipboard on the machine running Podplane; clipboard access must be available there.

Deletion workflow

cluster delete and oidc delete use Prepare → Confirm → Delete → Cleanup. Cluster deletion offers dependent cleanup checkboxes; OIDC deletion confirms infrastructure removal and retains state and local files.

The TUI dashboard shows cleanup tasks and each validated destroy plan’s resources. Resource progress applies to the current phase, not the entire deletion. Table, details, and log controls match the plan-and-apply dashboard above. Ctrl+O preserves checkbox selections when switching to Inline mode. Cancellation waits for safe cleanup; failures leave diagnostics and a resume command.