docs(readme): add gif

Amolith created 1 month ago

Change summary

README.md | 19 +++++++++++--------
demo.tape | 47 +++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 58 insertions(+), 8 deletions(-)

Detailed changes

README.md

@@ -4,6 +4,8 @@ A Fish wrapper for the `claude` CLI that routes requests through
 [Synthetic.new](https://synthetic.new), enabling use of models like GLM-4.6
 through `claude`.
 
+![Invoking synclaude with the interactive i subcommand to override the default models. First question is how to override the models, selecting each individually or by group. After selecting group, the next question is which group, large -L or light -l or both. After selecting large, the next question is which model to use, presented as a list of IDs with fuzzy filtering. After typing "mmm2" for MiniMax M2, Claude Code starts. After typing Hi and getting a response and quitting Claude Code, synclaude shows how many requests were used during the session and how many are remaining.](https://vhs.charm.sh/vhs-2wRBg9PpDidQIfCptnQuLz.gif)
+
 ## tl;dr
 
 - Defaults to GLM 4.6
@@ -73,14 +75,14 @@ synclaude i
 
 ### Flags
 
-| Flag | Short | Description |
-|------|-------|-------------|
-| `--large` | `-L` | Override Opus, Sonnet, and Sub-agent models |
-| `--light` | `-l` | Override Haiku |
-| `--haiku` | `-H` | Override Haiku |
-| `--opus` | `-o` | Override Opus |
-| `--sonnet` | `-s` | Override Sonnet |
-| `--agent` | `-a` | Override sub-agent |
+| Flag       | Short | Description                                 |
+| ---------- | ----- | ------------------------------------------- |
+| `--large`  | `-L`  | Override Opus, Sonnet, and Sub-agent models |
+| `--light`  | `-l`  | Override Haiku                              |
+| `--haiku`  | `-H`  | Override Haiku                              |
+| `--opus`   | `-o`  | Override Opus                               |
+| `--sonnet` | `-s`  | Override Sonnet                             |
+| `--agent`  | `-a`  | Override sub-agent                          |
 
 All other flags are passed through to the `claude` command.
 
@@ -125,6 +127,7 @@ Individual overrides take precedence over group overrides.
 - `CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC`: Disabled because telemetry bad
 
 After each run, it queries the Synthetic API to display:
+
 - Requests used during the session
 - Remaining quota (color-coded: green <33%, yellow 33-66%, red >66%)
 

demo.tape

@@ -0,0 +1,47 @@
+# SPDX-FileCopyrightText: Amolith <[e-mail]>
+#
+# SPDX-License-Identifier: Unlicense
+
+Output demo.gif
+
+Require echo
+Require fish
+
+Set Shell "fish"
+Set FontSize 32
+Set Width 1250
+Set Height 750
+
+# Set up the plugin
+Hide
+Type@1ms "source functions/synclaude.fish" Enter
+Type@1ms "clear" Enter
+Show
+
+# Start interactive model selection
+Type "synclaude i" Sleep 750ms
+Enter Sleep 2s
+
+# Select Group
+Sleep 750ms
+Enter Sleep 2s
+
+# Select heavy group
+Space Sleep 750ms
+Enter Sleep 2s
+
+# Select the heavy model
+Type "mmm2" Sleep 1.25s
+Enter Sleep 2.25s
+
+# Send a message
+Type "Hi!" Sleep 1.25s
+Enter Sleep 4s
+
+# Exit with Ctrl+C twice
+Ctrl+c
+Sleep 500ms
+Ctrl+c
+
+# Show usage
+Sleep 5s