docs: create demo.gif

Author: sgaunet

README.md

@@ -11,7 +11,6 @@ Usage:
   jwt-cli [command]
 
 Available Commands:
-  completion  Generate the autocompletion script for the specified shell
   decode      decode JWT token
   encode      encode JWT token
   genkeys     print commands example to generate keys for ES256, ES384, ES512, RS256, RS384, RS512
@@ -36,6 +35,9 @@ Supported methods are actually:
 * RS384
 * RS512
 
+# Demo
+
+![demo](doc/demo.gif)
 
 # Install
 

Taskfile.yml

@@ -19,6 +19,11 @@ tasks:
     cmds:
       - go get golang.org/x/tools/cmd/godoc
 
+  demo:
+    desc: "Generate demo.gif"
+    cmds:
+      - vhs doc/demo.tape
+
   doc:
     desc: "Run godoc server"
     cmds:

doc/demo.gif

@@ -0,0 +1,72 @@
+# VHS documentation
+#
+# Output:
+#   Output <path>.gif               Create a GIF output at the given <path>
+#   Output <path>.mp4               Create an MP4 output at the given <path>
+#   Output <path>.webm              Create a WebM output at the given <path>
+#
+# Settings:
+#   Set FontSize <number>           Set the font size of the terminal
+#   Set FontFamily <string>         Set the font family of the terminal
+#   Set Height <number>             Set the height of the terminal
+#   Set Width <number>              Set the width of the terminal
+#   Set LetterSpacing <float>       Set the font letter spacing (tracking)
+#   Set LineHeight <float>          Set the font line height
+#   Set Theme <string>              Set the theme of the terminal (JSON)
+#   Set Padding <number>            Set the padding of the terminal
+#   Set Framerate <number>          Set the framerate of the recording
+#   Set PlaybackSpeed <float>       Set the playback speed of the recording
+#
+# Sleep:
+#   Sleep <time>                    Sleep for a set amount of <time> in seconds
+#
+# Type:
+#   Type[@<time>] "<characters>"    Type <characters> into the terminal with a
+#                                   <time> delay between each character
+#
+# Keys:
+#   Backspace[@<time>] [number]     Press the Backspace key
+#   Down[@<time>] [number]          Press the Down key
+#   Enter[@<time>] [number]         Press the Enter key
+#   Space[@<time>] [number]         Press the Space key
+#   Tab[@<time>] [number]           Press the Tab key
+#   Left[@<time>] [number]          Press the Left Arrow key
+#   Right[@<time>] [number]         Press the Right Arrow key
+#   Up[@<time>] [number]            Press the Up Arrow key
+#   Down[@<time>] [number]          Press the Down Arrow key
+#   Ctrl+<key>                      Press the Control key + <key> (e.g. Ctrl+C)
+#
+# Display:
+#   Hide                            Hide the subsequent commands from the output
+#   Show                            Show the subsequent commands in the output
+
+Require jwt-cli
+
+Output doc/demo.gif
+
+Set FontSize 18
+Set Width 1200
+Set Height 600
+
+Type "# create JWT token with encode subcommand"
+Enter
+Sleep 500ms
+Type `jwt-cli encode rs256 --pk tests/RS256.key --p '{ "email": "[email protected]" }' | tee /tmp/key`
+Enter
+Sleep 500ms
+Type "# Decode JWT token with decode subcommand"
+Enter
+Sleep 500ms  
+Type `jwt-cli decode rs256 --pk tests/RS256.key --t "$(cat /tmp/key)"`
+Enter
+Sleep 1500ms
+Type "# jwt-cli handles many methods"
+Enter
+Sleep 500ms
+Type "jwt-cli encode --help"
+Enter
+Sleep 500ms
+
+Type "# END"
+Enter
+Sleep 4000ms