Repository navigation
docs: a Terminal UI page with screenshots, and the rest brought up to date - #1256
Merged
Merged
Conversation
… date onctl.sh/docs had no page on onctl tui, and the pages it had predated most of the CLI: no ac, boxes or static provider, no login, pause, resume, port-forward, sizes, restart, import, claude or tui, a MkDocs-style admonition that rendered as text, and a help block listing a vm command that no longer exists. - docs/tui.md: the TUI, with seven screenshots of the real view (VMs, help, filter, describe, destroy, sizes, GitHub repos) rendered from tuiModel.View() against sample Hetzner data at 110x24, as the landing page's was. The landing page's tui.png is re-rendered the same way, so it now shows the <a> claude key too. - getting-started.md: every provider in a table with what it needs (credentials, binaries, images), the auto-detection order from tools.WhichCloudProvider, create's flags, ssh -- and -a, port-forward, ls/pause/resume/destroy/restart, and pointers to tui, claude, import, action and env. - index.md: the feature list from the README (boxes, claude, tui, ac, port-forward, pause, import) and the root help as the CLI prints it today. - templates.md: where -a scripts come from and in what order, -e, --dot-env, -u, -d, cloud-init, and -f / onctl env with the YAML keys from cmd/create.go. - Sidebar: Onctl, Getting Started, Terminal UI, Claude Code on a box, Deployments, Templates. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01J3DrQy8Pdg8KsM31aMxJaM
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1256 +/- ##
=======================================
Coverage 47.78% 47.78%
=======================================
Files 81 81
Lines 9342 9342
=======================================
Hits 4464 4464
Misses 4878 4878 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two things, both on onctl.sh/docs.
A Terminal UI page
docs/tui.md, with seven screenshots of the real view, rendered fromtuiModel.View()against sample Hetzner data at 110x24 (the same way the landing page's was made): the VMs view, the help page, a filter, describe, the destroy confirmation,:sizesand:repos. Covers moving around, filtering, the per-VM keys, the views and the:commands, and ends with the full key list fromonctl tui --help.The landing page's
tui.pngis re-rendered the same way, so it now shows the<a> claudekey the old one predated.The existing pages, audited against the CLI
Checked every page against
onctl --helpand each command's help,cloudProviderList,tools.WhichCloudProvider,internal/files/init/onctl.yamlandcmd/create.go:ac,boxesorstatic; now a table of all ten with what each needs (credentials, binaries, images,onctl login). The!!! notewas MkDocs syntax and rendered as literal text; it's now a Docusaurus admonition, and says the actual auto-detection order (aws, azure, gcp, hetzner, ovh) and thatonctl claudedefaults to boxes. Addedcreate's flags,ssh -- COMMANDandssh -a,port-forward,ls/pause/resume/destroy/restart, and pointers to tui, claude, import, action and env. Theonctl upexample isonctl create(upis an alias).onctlhelp block is the current output: it listed avmcommand that no longer exists and lackedclaude,login,logout,port-forward,restart,sizes,ssh-proxy,tui, andac/static/boxesin-p.-ascripts come from,onctl templates list,-e/--dot-env/-u/-d(verified order increate.go: cloud-init wait, upload, scripts, download), cloud-init, and-f/onctl envwith the YAML keys fromcmd/create.go.npm run typecheck && npm run buildpass with no broken links; the pages were checked rendered in headless Chrome.🤖 Generated with Claude Code
https://claude.ai/code/session_01J3DrQy8Pdg8KsM31aMxJaM