feat(scan): guided engine pick + examples in --help#34
Merged
Conversation
scan now offers to generate a migration from one of its suggestions when run in an interactive terminal, so you no longer have to re-type a table command with --engine/--order-by. Piped or scripted runs are unchanged: the prompt is skipped unless stdin is a TTY and the input is a real file. Also add an EXAMPLES section to --help for the top-level command and each subcommand to improve discoverability. Refactor the table-generation path into generate_table_migration(), shared by the table command and the new scan prompt.
Render with: vhs assets/demo.tape (or the charmbracelet/vhs docker image). The demo shows scan analyzing video_events.json, suggesting engines, and the interactive prompt generating a ReplacingMergeTree migration.
…-generate # Conflicts: # README.md
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.
Addresses two user-friendliness gaps: the two-step
scan→tableworkflow, and poor discoverability without the README.What changed
Guided generation in
scan. After printing suggestions,scannow offers to generate a migration from one of them, so you don't have to re-type a fulltable --engine X --order-by ...command:-). Piped/scripted/redirected runs are byte-for-byte unchanged — no prompt, no files.{name}_up.sql/{name}_down.sqlto the current dir using the picked suggestion's engine +ORDER BY.scan -nnow names those files.Examples in
--help. Added anEXAMPLESsection to the top-level command and every subcommand (scan/table/kafka/diff), reusing the README's example invocations.Demo GIF. Added a VHS terminal demo (
assets/demo.gif+assets/demo.tape, regenerable withvhs assets/demo.tape) and embedded it at the top of the README.Refactor. Extracted the table-generation body into
generate_table_migration(), shared by thetablecommand and the newscanprompt (no behavior change fortable).