mirror of
https://github.com/nushell/nushell.git
synced 2025-08-14 07:58:50 +02:00
Autogenerate missing docs (#3514)
* Autogenerate missing docs * Update ansi.md * Rename question mark command docs * Delete empty?.md
This commit is contained in:
26
docs/commands/benchmark.md
Normal file
26
docs/commands/benchmark.md
Normal file
@ -0,0 +1,26 @@
|
||||
# benchmark
|
||||
Runs a block and returns the time it took to execute it.
|
||||
|
||||
## Usage
|
||||
```shell
|
||||
> benchmark <block> {flags}
|
||||
```
|
||||
|
||||
## Parameters
|
||||
* `<block>` the block to run and benchmark
|
||||
|
||||
## Flags
|
||||
* -h, --help: Display this help message
|
||||
* -p, --passthrough <block>: Display the benchmark results and pass through the block's output
|
||||
|
||||
## Examples
|
||||
Benchmarks a command within a block
|
||||
```shell
|
||||
> benchmark { sleep 500ms }
|
||||
```
|
||||
|
||||
Benchmarks a command within a block and passes its output through
|
||||
```shell
|
||||
> echo 45 | benchmark { sleep 500ms } --passthrough {}
|
||||
```
|
||||
|
Reference in New Issue
Block a user