docs: Add readme demo - #265
Merged
Merged
Conversation
- semble search/find-related gain --pretty, printing human-readable "path:start-end" + code per result instead of raw JSON. Default JSON output (used by agents/MCP) is unchanged. - create_index_from_path takes an optional on_progress(files_done, files_total) callback, threaded through SembleIndex.from_path/ from_git. The CLI wires it to a tqdm bar (green, matching the installer checkmarks and `semble savings` bars) that only appears on a tty and only when there's actually indexing work to do — a cache hit shows nothing. Claude-Session: https://claude.ai/code/session_013GB3H6NiUFKsyAVC3aQNZf
Real terminal recording (via VHS, light/dark variants) of semble install detecting Claude Code, Cursor, and Codex, followed by semble search --pretty against a live FastAPI checkout — including the new indexing progress bar. Claude-Session: https://claude.ai/code/session_013GB3H6NiUFKsyAVC3aQNZf
.github/scripts/demo-{dark,light}.tape are the actual, reproducible
source for assets/images/tour-{dark,light}.gif — real terminal
recordings (via VHS) rather than a mockup, run inside a throwaway
`env -i HOME=...` shell so semble install never touches a real
dotfile. Re-rendered both GIFs from these scripts to confirm they
reproduce byte-for-byte the same demo.
Claude-Session: https://claude.ai/code/session_013GB3H6NiUFKsyAVC3aQNZf
Take main's --format/show_progress_bar implementation from #261 over this branch's --pretty/on_progress version, switch the VHS tapes to --format text, regenerate the demo GIFs, and relock uv.lock against the 1-week exclude-newer span. Claude-Session: https://claude.ai/code/session_01N5WnCfeaj66TgZTbqm2Zew
The setup steps lived as comments in .github/scripts/*.tape because VHS tapes can't run shell. Move the tapes out of .github (nothing in CI uses them) and replace the comments with scripts/demo/record.sh, which builds an isolated home per theme, warms the model cache, and renders both GIFs. Claude-Session: https://claude.ai/code/session_01N5WnCfeaj66TgZTbqm2Zew
… bar Record the demo against pydantic v2.13.5 (~3s to index) with a natural language query that surfaces to_camel, shorten the terminal to 720px, and wait for the prompt before holding the result for 3.5s. Set miniters=1 on the indexing tqdm bar: its adaptive miniters froze the bar for up to ~0.9s when many tiny files were followed by larger ones. record.sh now shares the seed's .cache with each theme home, since loading freshly copied grammar dylibs stalled the first files. README links to the GIFs are temporarily relative so the branch renders them on GitHub; they need to point at main before merging. Claude-Session: https://claude.ai/code/session_01N5WnCfeaj66TgZTbqm2Zew
The 720px recording left empty space below the final prompt. Claude-Session: https://claude.ai/code/session_01N5WnCfeaj66TgZTbqm2Zew
Drop the "See it in action" heading so the GIF follows the intro directly, and qualify the sub-second indexing claim with "for most repos" since the demo repo takes ~3s. Claude-Session: https://claude.ai/code/session_01N5WnCfeaj66TgZTbqm2Zew
Absolute raw.githubusercontent.com URLs render on PyPI as well as GitHub. Claude-Session: https://claude.ai/code/session_01N5WnCfeaj66TgZTbqm2Zew
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
 |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
The install plan and results printed absolute paths, which wrap and add noise (/Users/you/..., or a temp dir in the demo). Paths under the home directory are now shown as ~/..., other paths are unchanged. Claude-Session: https://claude.ai/code/session_01N5WnCfeaj66TgZTbqm2Zew
|
Want your agent to iterate on Greptile's feedback? Try greploops. |
Matches scripts/demo/, which records them. Claude-Session: https://claude.ai/code/session_01N5WnCfeaj66TgZTbqm2Zew
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
1 participant
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.
This adds a cool demo to our readme showing a
semble installandsemble search. Also made two small changes to make thetqdmbar smoother, and make the installation paths more readable.