You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/1-essentials/04-console-commands.md
+16-1Lines changed: 16 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -223,6 +223,21 @@ final readonly class SynchronizeAircraft
223
223
}
224
224
```
225
225
226
+
## Interactive components
227
+
228
+
Tempest console comes with a range of interactive components that can be used to interact with the user while running a console command:
229
+
230
+
-`$console->ask()` will prompt the user for input and validate it.
231
+
-`$console->confirm()` will prompt the user for a yes/no answer.
232
+
-`$console->password()` will prompt the user for a password, the input will be masked.
233
+
-`$console->progressBar()` will render a progress bar.
234
+
-`$console->search()` will prompt the user with a search bar and update a result list in real-time.
235
+
-`$console->task()` will run a task and show a progress bar while it's running.
236
+
237
+
:::warning
238
+
Interactive components are only supported on Mac and Linux. On Windows, Tempest will fall back to non-interactive versions of these components.
239
+
:::
240
+
226
241
## Middleware
227
242
228
243
Console middleware can be applied globally or on a per-command basis. Global console middleware will be discovered and applied automatically, by priority order.
0 commit comments