demo-wrds-download.tape (3034B)
1 # VHS tape for recording wrds-dl TUI demo GIF. 2 # Usage: vhs demo-wrds-download.tape 3 # 4 # Prerequisites: 5 # - wrds-dl binary built and in PATH (or ./go/wrds-dl) 6 # - WRDS credentials saved (~/.config/wrds-dl/credentials) 7 # or exported as PGUSER / PGPASSWORD environment variables 8 # - Active network connection to WRDS (Duo 2FA approved) 9 10 Output demo-wrds-download-raw.gif 11 12 Set FontSize 18 13 Set Width 1400 14 Set Height 700 15 Set Padding 20 16 Set Theme "GruvboxDarkHard" 17 18 Set TypingSpeed 80ms 19 20 Set Shell "bash" 21 22 Hide 23 Type 'export PS1="> "' 24 Enter 25 Type "clear" 26 Enter 27 Show 28 29 # ─── 1. LAUNCH THE TUI ─── 30 Type "./wrds-dl tui" 31 Enter 32 33 # Wait for login screen to render 34 Sleep 2s 35 36 # ─── 2. LOGIN WITH SAVED CREDENTIALS ─── 37 # The login form shows "Login as <user> [enter]" when credentials exist. 38 # Press Enter to connect with saved credentials. 39 Enter 40 41 # Wait for connection + Duo 2FA + schemas to load 42 Sleep 2s 43 44 # ─── 3. BROWSE SCHEMAS ─── 45 # Schemas pane is focused by default. Navigate to find "crsp". 46 Sleep 500ms 47 Down 1 48 Sleep 300ms 49 Down 1 50 Sleep 300ms 51 Down 1 52 Sleep 300ms 53 Down 1 54 Sleep 300ms 55 Down 1 56 Sleep 1s 57 58 # Use "/" to filter schemas 59 Type "/" 60 Sleep 300ms 61 Type "crsp" 62 Sleep 1s 63 Enter 64 Sleep 1s 65 66 # ─── 4. DRILL INTO SCHEMA ─── 67 # Press right arrow to select the schema and load its tables. 68 Right 69 Sleep 2s 70 71 # ─── 5. BROWSE TABLES ─── 72 # Tables pane is now focused. Filter for "msf" (monthly stock file). 73 Type "/" 74 Sleep 300ms 75 Type "msf" 76 Sleep 1s 77 Enter 78 Sleep 2s 79 80 # ─── 6. VIEW TABLE METADATA ─── 81 # Press right to drill into the table and see the preview pane. 82 Right 83 Sleep 3s 84 85 # ─── 7. SCROLL THROUGH COLUMNS ─── 86 # Preview pane shows column catalog. Scroll with j/k. 87 Sleep 500ms 88 Down 1 89 Sleep 300ms 90 Down 1 91 Sleep 300ms 92 Down 1 93 Sleep 300ms 94 Down 1 95 Sleep 300ms 96 Down 1 97 Sleep 1s 98 99 # Scroll back up 100 Up 1 101 Sleep 200ms 102 Up 1 103 Sleep 200ms 104 Up 1 105 Sleep 1s 106 107 # ─── 8. FILTER COLUMNS ─── 108 # Press "/" in the preview pane to filter columns. 109 Type "/" 110 Sleep 300ms 111 Type "ret" 112 Sleep 1s 113 # Press Escape to clear the filter 114 Escape 115 Sleep 1s 116 117 # ─── 9. OPEN DOWNLOAD DIALOG ─── 118 # Press "d" to open the download form. 119 Type "d" 120 Sleep 1s 121 122 # ─── 10. FILL IN DOWNLOAD FORM ─── 123 # SELECT columns field — clear prepopulated "*" then type columns 124 Ctrl+U 125 Sleep 200ms 126 Type "permno,date,prc,ret,shrout" 127 Sleep 500ms 128 129 # Move to WHERE clause 130 Tab 131 Sleep 300ms 132 Type "date >= '2024-01-01' AND date < '2024-02-01'" 133 Sleep 500ms 134 135 # Move to LIMIT — leave empty (no limit) 136 Tab 137 Sleep 300ms 138 139 # Move to Output path 140 Tab 141 Sleep 300ms 142 # Clear prepopulated path then type custom path 143 Ctrl+U 144 Sleep 200ms 145 Type "./crsp_msf_2024_jan.parquet" 146 Sleep 500ms 147 148 # Move to Format — keep default "parquet" 149 Tab 150 Sleep 1s 151 152 # ─── 11. SUBMIT DOWNLOAD ─── 153 Enter 154 Sleep 5s 155 156 # ─── 12. DISMISS SUCCESS MESSAGE ─── 157 Escape 158 Sleep 1s 159 160 # ─── 13. QUIT ─── 161 Type "q" 162 Sleep 500ms 163 164 # ─── 14. VERIFY OUTPUT ─── 165 Type "du -h crsp_msf_2024_jan.parquet" 166 Enter 167 Sleep 3s