docs: show real CLI screenshots in How to use - #43
adamsiwiec1 wants to merge 8 commits into
Conversation
Keep the command cheat-sheet, then walk through help, search, deploy dry-run, and start claude using the screenshots already on main. Co-authored-by: adam siwiec <adamsiwiec1@users.noreply.github.com>
Lead with the three cleared screenshots and matching commands. Drop the help-as-wizard lead, GCP, and start opencode. Move the rest of the command/env dump under the shots as a short also list. Co-authored-by: adam siwiec <adamsiwiec1@users.noreply.github.com>
|
Preview of the How to use shots (the Files tab only shows the README markdown diff — relative Rendered README on this branch: https://github.com/openhat-security/runhug/blob/cursor/readme-how-to-use-screenshots-96cf/README.md
|
Until #35 is on main, What it does keeps Deploy on RunPod/heretic and Use on OpenAI URL / Claude Code / run / start claude. How to use is unchanged. Co-authored-by: adam siwiec <adamsiwiec1@users.noreply.github.com>
Replace search, deploy --dry-run, and start claude captures with real runhug 0.1.8 linux_amd64 output. Caption start claude with the --base-url/--model command shown; Claude Code was not on PATH. Co-authored-by: adam siwiec <adamsiwiec1@users.noreply.github.com>
|
Refreshed How to use shots from DistEng dogfood ( Note: Claude Code CLI was not on the capture machine. Shot 04 is honest: the Anthropic↔OpenAI bridge comes up; Rendered README on this branch: https://github.com/openhat-security/runhug/blob/cursor/readme-how-to-use-screenshots-96cf/README.md
|
Match the DistEng still exactly: bgdyt63ulkghmu, not gydt63ulkghmu. Co-authored-by: adam siwiec <adamsiwiec1@users.noreply.github.com>
Capture search, deploy --dry-run, and start claude from the Homebrew cask runhug 0.1.8 binary on macOS Terminal/iTerm (not PTY mocks). Scrub ANTHROPIC_AUTH_TOKEN / rpa_ values from Claude frames.
Match the README command/alt text to the real Homebrew 0.1.8 `runhug start claude` session recorded on macOS against an existing QUEUE endpoint (Claude Code launched; tokens scrubbed in frames).
Keep the model-specific start command only under How to use.
This branch has not been deployed
2 participants
Summary
README visual How to use plus the FOSS + DistEng soft block on What it does.
How to use (search → dry-run → start claude), now with fresh DistEng dogfood captures from a real
runhug 0.1.8linux_amd64 install:runhug search "small instruct" --limit 10→assets/screenshots/02-runhug-search.pngrunhug deploy Qwen/Qwen2.5-0.5B-Instruct --dry-run→assets/screenshots/03-runhug-deploy-dry-run.pngrunhug start claude --base-url https://api.runpod.ai/v2/bgdyt63ulkghmu/openai/v1 --model Qwen/Qwen2.5-0.5B-Instruct→assets/screenshots/04-runhug-start-claude.gif(PNG still kept at04-runhug-start-claude.png)Help PNG omitted from How to use. GCP and
start opencodeare not listed as shipped. Wizard is only in the short “also” list. QUEUE / Load balancer URL lines stay.Start Claude honesty: the capture shows the Anthropic↔OpenAI bridge coming up; Claude Code CLI was not on PATH on the DistEng machine (
claude: not found). No faked Claude TUI.What it does (earlier push): until #35 is on main, item 2 keeps Deploy any Hugging Face checkpoint / RunPod / heretic and no longer pitches GCP Spot llama.cpp; item 3 keeps Use / OpenAI URL / Claude Code /
runhug run/runhug start claudeand dropsstart opencodeas current (OpenCode stays under “more integrations coming soon” only).Install and Go code are untouched.
Security / privacy impact
None. Docs-only README markup and public CLI screenshots. Tokens in the start-claude capture are redacted.
Checklist
go test ./...passes (not run — docs-only, no Go changes)CHANGELOG.md## [Unreleased]has a bullet for user-visible behavior (or this PR is docs/chore-only)