Adds CLI animation

[leoyala]

Summary

Adds CLI animation as an example together with the tape file to use with vhs to regenerate the animation.

Changes

• New .tape file to create animation of CLI
• Adds gif animation to README and index in docs page.

Test plan

• uv run pytest passes

Summary by CodeRabbit

• Documentation
  • Added a visual CLI demonstration to the README and documentation site.
  • Added a complete terminal walkthrough showing dataset initialization, tracking, and log inspection.
  • Included reference details for supported CLI recording directives.

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds a VHS script that records a reproducible dstrack CLI workflow and embeds the generated CLI animation in the README and documentation.

Changes

CLI demonstration

Layer / File(s)	Summary
Recording setup cli.tape	Documents supported VHS directives and configures the output, terminal theme, prompt, temporary directory, and CSV dataset.
CLI workflow cli.tape	Records datastore initialization, repeated dataset tracking, dataset log output, and recording completion.
Documentation embedding README.md, docs/index.md	Adds the generated CLI image to the README and Features documentation.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested labels: enhancement

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the main change: adding a CLI animation example and its VHS tape.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch 51-add-cli-animation

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[github-actions]

Test Results

   48 files  ±0     48 suites  ±0   1m 59s ⏱️ -26s
  263 tests ±0    263 ✅ ±0  0 💤 ±0  0 ❌ ±0 
6 312 runs  ±0  6 312 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 514a436. ± Comparison against base commit d2dafc1.

[coderabbitai]

🧹 Nitpick comments (2)

cli.tape (2)

60-61: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Add Require dstrack to fail fast if the CLI is not installed.

Since the tape records dstrack commands, requiring the executable ensures VHS will abort early rather than recording a series of "command not found" errors if the environment isn't set up correctly.

♻️ Proposed refactor

 Output docs/assets/cli.gif
+
+Require dstrack

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@cli.tape` around lines 60 - 61, Add Require dstrack near the top of the VHS
tape before any recorded dstrack commands, so VHS fails immediately when the
executable is unavailable while preserving the existing recording commands and
output.

---

94-112: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Merge the off-camera setup blocks to remove redundant state toggles.

There is no need to Show and immediately Hide the terminal between setting the prompt and creating the dummy dataset. Combining these into a single hidden block simplifies the script and avoids unnecessary double screen clears (Ctrl+L and clear).

♻️ Proposed refactor

-# --- off-camera setup: pin a reproducible prompt ---
-Hide
-Type `PROMPT='> '`
-Enter
-Ctrl+L
-Show
-
-# --- setup configuration in tmp folder ---
-Hide
-Type "cd $(mktemp -d)"
-Enter
-Type "printf 'id,feature,label\n1,0.5,cat\n2,0.9,dog\n3,0.2,cat\n' > data.csv"
-Enter
-Type "export LOGNAME=user USER=user"
-Enter
-Type "clear"
-Enter
-Show
+# --- off-camera setup: pin a reproducible prompt and create tmp folder ---
+Hide
+Type `PROMPT='> '`
+Enter
+Type "cd $(mktemp -d)"
+Enter
+Type "printf 'id,feature,label\n1,0.5,cat\n2,0.9,dog\n3,0.2,cat\n' > data.csv"
+Enter
+Type "export LOGNAME=user USER=user"
+Enter
+Ctrl+L
+Show

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@cli.tape` around lines 94 - 112, Merge the off-camera setup sections around
the PROMPT assignment and temporary dataset creation into one hidden block,
removing the intermediate Show/Hide toggles and redundant screen-clearing
commands while preserving the setup commands and their execution order.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@cli.tape`:
- Around line 60-61: Add Require dstrack near the top of the VHS tape before any
recorded dstrack commands, so VHS fails immediately when the executable is
unavailable while preserving the existing recording commands and output.
- Around line 94-112: Merge the off-camera setup sections around the PROMPT
assignment and temporary dataset creation into one hidden block, removing the
intermediate Show/Hide toggles and redundant screen-clearing commands while
preserving the setup commands and their execution order.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 5af29cb6-ee8a-4fbc-b36c-b824ce6bde8b

📥 Commits

Reviewing files that changed from the base of the PR and between d2dafc1 and 514a436.

⛔ Files ignored due to path filters (1)

• docs/assets/cli.gif is excluded by !**/*.gif

📒 Files selected for processing (3)

• README.md
• cli.tape
• docs/index.md