Skip to content

docs: a Terminal UI page with screenshots, and the rest brought up to date - #1256

Merged
cdalar merged 1 commit into
mainfrom
docs-tui-and-audit
Oct 26, 2026
Merged

cdalar merged 1 commit into
mainfrom
docs-tui-and-audit

Conversation

@cdalar

@cdalar cdalar commented Oct 26, 2026

Copy link
Copy Markdown
Owner

Two things, both on onctl.sh/docs.

A Terminal UI page

docs/tui.md, with seven screenshots of the real view, rendered from tuiModel.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, :sizes and :repos. Covers moving around, filtering, the per-VM keys, the views and the : commands, and ends with the full key list from onctl tui --help.

The landing page's tui.png is re-rendered the same way, so it now shows the <a> claude key the old one predated.

the VMs view

The existing pages, audited against the CLI

Checked every page against onctl --help and each command's help, cloudProviderList, tools.WhichCloudProvider, internal/files/init/onctl.yaml and cmd/create.go:

  • Getting Started: had seven providers and no ac, boxes or static; now a table of all ten with what each needs (credentials, binaries, images, onctl login). The !!! note was 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 that onctl claude defaults to boxes. Added create's flags, ssh -- COMMAND and ssh -a, port-forward, ls/pause/resume/destroy/restart, and pointers to tui, claude, import, action and env. The onctl up example is onctl create (up is an alias).
  • Onctl (index): the feature list now matches the README (boxes, claude, tui, ac, port-forward, pause, import), and the onctl help block is the current output: it listed a vm command that no longer exists and lacked claude, login, logout, port-forward, restart, sizes, ssh-proxy, tui, and ac/static/boxes in -p.
  • Templates: the resolution order was listed but the prose around it was out of order (an "embedded file" sentence under the URL example); rewritten with where -a scripts come from, onctl templates list, -e/--dot-env/-u/-d (verified order in create.go: cloud-init wait, upload, scripts, download), cloud-init, and -f/onctl env with the YAML keys from cmd/create.go.
  • Deployments: checked, still accurate, untouched.
  • Claude Code on a box: unchanged, moved to position 4 behind the TUI page.

npm run typecheck && npm run build pass with no broken links; the pages were checked rendered in headless Chrome.

🤖 Generated with Claude Code

https://claude.ai/code/session_01J3DrQy8Pdg8KsM31aMxJaM

… 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

codecov Bot commented Oct 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 47.78%. Comparing base (2095e0d) to head (bee0e1c).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cdalar
cdalar merged commit 454eacc into main Oct 26, 2026
13 checks passed
@cdalar
cdalar deleted the docs-tui-and-audit branch October 26, 2026 15:10
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.

1 participant

⌂ 换网址