From 1a32636cd214e00bb854637b3eb5f7639b1efcc9 Mon Sep 17 00:00:00 2001 From: Amolith Date: Sun, 9 Nov 2025 17:11:16 -0700 Subject: [PATCH] docs(readme): add demo --- README.md | 2 ++ demo.tape | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 demo.tape diff --git a/README.md b/README.md index d666a4883d1d36f4eabaff1890f5c4ce30fa42be..d99dbf0510f17cfc73a2a2d0695a7ef1f07bf02a 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,8 @@ _Poke [Crush](https://github.com/charmbracelet/crush)—or any other CLI agent—from your shell. Inspired by [zsh-kimi-cli](https://github.com/MoonshotAI/zsh-kimi-cli)_ +![Shell comment giving instructions for adding the prefix, then the user types 'Say hello', adds the prefix, presses enter, the agent says hello, and the user is dropped to a normal prompt](https://vhs.charm.sh/vhs-2WsmXhqnQK9RktL9NGzz4M.gif) + ## Features - **Prefix-based activation**: Mark commands with `✨` to send them to your agent diff --git a/demo.tape b/demo.tape new file mode 100644 index 0000000000000000000000000000000000000000..5ccb01b68cc7ed05be86950bf3816c8df31decb0 --- /dev/null +++ b/demo.tape @@ -0,0 +1,35 @@ +# SPDX-FileCopyrightText: Amolith +# +# SPDX-License-Identifier: Unlicense + +Output demo.gif + +Require echo +Require fish + +Set Shell "fish" +Set FontSize 40 +Set Width 1100 +Set Height 350 + +# Set up the plugin with a mock runner +Hide +Type@1ms "function mock_runner; echo 'Hello! 👋'; end" Enter +Type@1ms "set -g __AGENTSH_RUNNER mock_runner" Enter +Type@1ms "source conf.d/agentsh.fish" Enter +Type@1ms "clear" Enter + +# Show the prefix toggle feature +Type "# Press Ctrl+X to toggle the prefix" Show +Sleep 3s Enter + +# Toggle prefix on and show it appears +Type "Say hello" Sleep 750ms +Ctrl+x Sleep 1s + +# Submit the command +Enter Wait+Screen /hello/ +Sleep 3s + +# Show normal command works +Type "# Back to normal shell" Sleep 3s