microsoft/TypeAgent
Publicmirrored fromhttps://github.com/microsoft/TypeAgentAvailable
docs/content/help/cheatSheet.html
357lines · modecode
| 1 | <!doctype html> |
| 2 | <!-- Copyright (c) Microsoft Corporation. |
| 3 | Licensed under the MIT License. --> |
| 4 | |
| 5 | <html lang="en"> |
| 6 | <head> |
| 7 | <meta charset="UTF-8" /> |
| 8 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| 9 | <title>TypeAgent Cheatsheet</title> |
| 10 | <style> |
| 11 | body { |
| 12 | font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif, Arial, Helvetica, sans-serif; |
| 13 | } |
| 14 | |
| 15 | .title |
| 16 | { |
| 17 | font-size: xx-large; |
| 18 | text-align: center; |
| 19 | margin-bottom: 30px; |
| 20 | } |
| 21 | |
| 22 | .container { |
| 23 | display: flex; |
| 24 | flex-wrap: wrap; |
| 25 | flex-direction: row; |
| 26 | justify-content: center; |
| 27 | gap: 15px; |
| 28 | } |
| 29 | |
| 30 | .section { |
| 31 | border: solid; |
| 32 | border-width: 3px; |
| 33 | border-color: royalblue; |
| 34 | border-radius: 7px; |
| 35 | } |
| 36 | |
| 37 | .sectionTitle { |
| 38 | color: goldenrod; |
| 39 | font-size: larger; |
| 40 | font-weight: 700; |
| 41 | margin: 5px; |
| 42 | text-align: center; |
| 43 | } |
| 44 | |
| 45 | .command-container { |
| 46 | white-space: nowrap; |
| 47 | margin: 10px 5px; |
| 48 | display: flex; |
| 49 | justify-content: space-between; |
| 50 | } |
| 51 | |
| 52 | .command-container:hover { |
| 53 | background-color: skyblue; |
| 54 | border: darkblue; |
| 55 | border-style: dashed; |
| 56 | border-width: 1px; |
| 57 | border-radius: 3px; |
| 58 | } |
| 59 | |
| 60 | .command { |
| 61 | text-align: left; |
| 62 | font-weight: bold; |
| 63 | } |
| 64 | |
| 65 | .command-description { |
| 66 | color: #313131; |
| 67 | text-align: right; |
| 68 | margin-right: 15px; |
| 69 | } |
| 70 | |
| 71 | .command-container[data-details]:hover:after { |
| 72 | content: attr(data-details); |
| 73 | position: absolute; |
| 74 | display: inline; |
| 75 | text-align: right; |
| 76 | white-space: nowrap; |
| 77 | color: gray; |
| 78 | background-color: lightyellow; |
| 79 | border: 1px solid black; |
| 80 | padding: 1px 5px 1px 5px; |
| 81 | font-size: 70%; |
| 82 | margin: 10px; |
| 83 | white-space: wrap;; |
| 84 | } |
| 85 | |
| 86 | .command-parameters { |
| 87 | margin-left: 3px; |
| 88 | font-style: italic; |
| 89 | } |
| 90 | |
| 91 | .command-notes { |
| 92 | font-size: small; |
| 93 | align-self: baseline; |
| 94 | position: relative; |
| 95 | bottom: 0px; |
| 96 | } |
| 97 | |
| 98 | .search { |
| 99 | width: 50%; |
| 100 | padding: 10px; |
| 101 | font-size: medium; |
| 102 | } |
| 103 | |
| 104 | .filtered { |
| 105 | opacity: 0.2; |
| 106 | } |
| 107 | |
| 108 | </style> |
| 109 | </head> |
| 110 | <body> |
| 111 | <div> |
| 112 | <div class="title">TypeAgent Cheat sheet</div> |
| 113 | <!-- Add search box --> |
| 114 | <div style="text-align: center; margin-bottom: 20px;"> |
| 115 | <input |
| 116 | type="text" |
| 117 | id="searchBox" |
| 118 | placeholder="Search commands..." |
| 119 | class="search" |
| 120 | oninput="filterCommands()" |
| 121 | /> |
| 122 | </div> |
| 123 | </div> |
| 124 | <div class="container"> |
| 125 | <div class="section"> |
| 126 | <div class="sectionTitle">Agents</div> |
| 127 | |
| 128 | <div class="command-container"> |
| 129 | <div class="command-description">Disable agent:</div> |
| 130 | <div class="command">@config agent -off</div> |
| 131 | <div class="command-parameters"><agent name></div> |
| 132 | </div> |
| 133 | |
| 134 | <div class="command-container"> |
| 135 | <div class="command-description">Enable agent:</div> |
| 136 | <div class="command">@config agent</div> |
| 137 | <div class="command-parameters"><agent name></div> |
| 138 | </div> |
| 139 | |
| 140 | <div class="command-container"> |
| 141 | <div class="command-description">List all agents:</div> |
| 142 | <div class="command">@config agent</div> |
| 143 | </div> |
| 144 | |
| 145 | <div class="command-container"> |
| 146 | <div class="command-description">Show agent commands:</div> |
| 147 | <div class="command">@help</div> |
| 148 | <div class="command-parameters"><agent name></div> |
| 149 | </div> |
| 150 | </div> |
| 151 | <div class="section"> |
| 152 | <div class="sectionTitle">Cache</div> |
| 153 | |
| 154 | <div class="command-container"> |
| 155 | <div class="command-description">Clear the cache:</div> |
| 156 | <div class="command">@const new</div> |
| 157 | </div> |
| 158 | |
| 159 | <div class="command-container"> |
| 160 | <div class="command-description">Print the cache to the debug console:</div> |
| 161 | <div class="command">@const list</div> |
| 162 | </div> |
| 163 | |
| 164 | <div class="command-container"> |
| 165 | <div class="command-description">Show cache info:</div> |
| 166 | <div class="command">@const info</div> |
| 167 | </div> |
| 168 | |
| 169 | </div> |
| 170 | <div class="section"> |
| 171 | <div class="sectionTitle">Shell / CLI</div> |
| 172 | |
| 173 | <div class="command-container"> |
| 174 | <div class="command-description">Clear the display:</div> |
| 175 | <div class="command">@clear</div> |
| 176 | </div> |
| 177 | |
| 178 | <div class="command-container"> |
| 179 | <div class="command-description">Show help:</div> |
| 180 | <div class="command">@help</div> |
| 181 | </div> |
| 182 | |
| 183 | <div class="command-container"> |
| 184 | <div class="command-description">Show shell settings:</div> |
| 185 | <div class="command">@shell show settings</div> |
| 186 | </div> |
| 187 | |
| 188 | <div class="command-container"> |
| 189 | <div class="command-description">Exit the application:</div> |
| 190 | <div class="command">@exit</div> |
| 191 | </div> |
| 192 | |
| 193 | <div class="command-container"> |
| 194 | <div class="command-description">Set the theme:</div> |
| 195 | <div class="command">@shell theme</div> |
| 196 | <div class="command-parameters"><light|dark></div> |
| 197 | </div> |
| 198 | |
| 199 | <div class="command-container" data-details="The shell canvas can display a URL or you can specify any of the supported aliases (paleobiodb, crossword, commerce, markdown, montage)."> |
| 200 | <div class="command-description" >Open shell canvas:</div> |
| 201 | <div class="command">@shell open</div> |
| 202 | <div class="command-parameters"><URL|alias></div> |
| 203 | </div> |
| 204 | |
| 205 | <div class="command-container"> |
| 206 | <div class="command-description">Close the shell canvas:</div> |
| 207 | <div class="command">@shell close</div> |
| 208 | </div> |
| 209 | |
| 210 | </div> |
| 211 | <div class="section"> |
| 212 | <div class="sectionTitle">Misc@ellaneous</div> |
| 213 | |
| 214 | <div class="command-container"> |
| 215 | <div class="command-description">Make a random request:</div> |
| 216 | <div class="command">@random</div> |
| 217 | </div> |
| 218 | |
| 219 | <div class="command-container"> |
| 220 | <div class="command-description">Show help:</div> |
| 221 | <div class="command">@help</div> |
| 222 | </div> |
| 223 | |
| 224 | <div class="command-container"> |
| 225 | <div class="command-description">Change default request handler:</div> |
| 226 | <div class="command">@config request</div> |
| 227 | <div class="command-parameters"><agent name></div> |
| 228 | </div> |
| 229 | |
| 230 | <div class="command-container"> |
| 231 | <div class="command-description">Show environment variables:</div> |
| 232 | <div class="command">@env</div> |
| 233 | </div> |
| 234 | |
| 235 | </div> |
| 236 | <div class="section"> |
| 237 | <div class="sectionTitle">Models</div> |
| 238 | |
| 239 | <div class="command-container"> |
| 240 | <div class="command-description">Show translation model being used:</div> |
| 241 | <div class="command">@config translation model</div> |
| 242 | </div> |
| 243 | |
| 244 | <div class="command-container"> |
| 245 | <div class="command-description" data-details="Current model options are: GPT_35_TURBO, GPT_4_O, GPT_4_O_MINI, GPT_v, openai:LOCAL">Change LLM models for translation:</div> |
| 246 | <div class="command">@config translation model set</div> |
| 247 | <div class="command-parameters">GPT_4_O</div> |
| 248 | </div> |
| 249 | |
| 250 | <div class="command-container"> |
| 251 | <div class="command-description">Reset model configuration:</div> |
| 252 | <div class="command">@config translation model --reset</div> |
| 253 | </div> |
| 254 | |
| 255 | </div> |
| 256 | <div class="section"> |
| 257 | <div class="sectionTitle">Debugging</div> |
| 258 | |
| 259 | <div class="command-container"> |
| 260 | <div class="command-description" data-details="Developer mode confirms actions before executing them and prompts the user to make corrections and/or select alternate actions.">Turn on developer mode:</div> |
| 261 | <div class="command">@config dev on</div> |
| 262 | </div> |
| 263 | |
| 264 | <div class="command-container"> |
| 265 | <div class="command-description">Turn on all tracing:</div> |
| 266 | <div class="command">@trace *</div> |
| 267 | </div> |
| 268 | |
| 269 | <div class="command-container"> |
| 270 | <div class="command-description">Open DevTools:</div> |
| 271 | <div class="command">F12</div> |
| 272 | </div> |
| 273 | </div> |
| 274 | <div class="section"> |
| 275 | <div class="sectionTitle">Actions</div> |
| 276 | |
| 277 | <div class="command-container"> |
| 278 | <div class="command-description">Reset action status (on/off) to defaults:</div> |
| 279 | <div class="command">@config action --reset</div> |
| 280 | </div> |
| 281 | |
| 282 | <div class="command-container"> |
| 283 | <div class="command-description">Turn OFF actions for a specific agent:</div> |
| 284 | <div class="command">@config action --off</div> |
| 285 | <div class="command-parameters"><agent name></div> |
| 286 | </div> |
| 287 | |
| 288 | <div class="command-container"> |
| 289 | <div class="command-description">Turn ON actions for a specific agent:</div> |
| 290 | <div class="command">@config action</div> |
| 291 | <div class="command-parameters"><agent name></div> |
| 292 | </div> |
| 293 | </div> |
| 294 | <div class="section"> |
| 295 | <div class="sectionTitle">Session</div> |
| 296 | |
| 297 | <div class="command-container"> |
| 298 | <div class="command-description">Create a new session:</div> |
| 299 | <div class="command">@session new</div> |
| 300 | </div> |
| 301 | |
| 302 | <div class="command-container"> |
| 303 | <div class="command-description">Show current session info:</div> |
| 304 | <div class="command">@session info</div> |
| 305 | </div> |
| 306 | |
| 307 | <div class="command-container"> |
| 308 | <div class="command-description">List all sessions:</div> |
| 309 | <div class="command">@session list</div> |
| 310 | </div> |
| 311 | </div> |
| 312 | <div class="section"> |
| 313 | <div class="sectionTitle">Calendar</div> |
| 314 | |
| 315 | <div class="command-container"> |
| 316 | <div class="command-description">Login to the calendar account:</div> |
| 317 | <div class="command">@calendar login</div> |
| 318 | </div> |
| 319 | |
| 320 | <div class="command-container"> |
| 321 | <div class="command-description">Logout of the calendar account:</div> |
| 322 | <div class="command">@calendar login</div> |
| 323 | </div> |
| 324 | |
| 325 | </div> |
| 326 | |
| 327 | <div class="section"> |
| 328 | <div class="sectionTitle">Chat History</div> |
| 329 | |
| 330 | <div class="command-container"> |
| 331 | <div class="command-description">Show chat history:</div> |
| 332 | <div class="command">@history</div> |
| 333 | </div> |
| 334 | |
| 335 | </div> |
| 336 | </div> |
| 337 | |
| 338 | <script> |
| 339 | function filterCommands() { |
| 340 | const searchValue = document.getElementById('searchBox').value.toLowerCase(); |
| 341 | const commands = document.querySelectorAll('.command-container'); |
| 342 | |
| 343 | commands.forEach(command => { |
| 344 | const description = command.querySelector('.command-description').textContent.toLowerCase(); |
| 345 | const commandText = command.querySelector('.command').textContent.toLowerCase(); |
| 346 | const parameters = command.querySelector('.command-parameters')?.textContent.toLowerCase() || ''; |
| 347 | |
| 348 | if (description.includes(searchValue) || commandText.includes(searchValue) || parameters.includes(searchValue)) { |
| 349 | command.classList.remove("filtered"); |
| 350 | } else { |
| 351 | command.classList.add("filtered"); |
| 352 | } |
| 353 | }); |
| 354 | } |
| 355 | </script> |
| 356 | </body> |
| 357 | </html> |
| 358 | |