Skip to content

Commit a35d4f7

Browse files
committed
docs: add a setup command to the README
1 parent ab7bf4a commit a35d4f7

1 file changed

Lines changed: 10 additions & 15 deletions

File tree

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -59,22 +59,17 @@ codspeed run pytest ./tests --codspeed
5959
codspeed run pnpm vitest bench
6060
```
6161

62+
## Advanced usage
63+
64+
### Installing tools before running
65+
66+
You can install executors and instruments before running the benchmark with the `setup` command:
67+
68+
```bash
69+
codspeed setup
6270
```
63-
Usage: codspeed run [OPTIONS] [COMMAND]...
64-
65-
Arguments:
66-
[COMMAND]... The bench command to run
67-
68-
Options:
69-
--upload-url <UPLOAD_URL>
70-
The upload URL to use for uploading the results, useful for on-premises installations
71-
--token <TOKEN>
72-
The token to use for uploading the results, if not provided it will be read from the CODSPEED_TOKEN environment variable
73-
--working-directory <WORKING_DIRECTORY>
74-
The directory where the command will be executed
75-
-h, --help
76-
Print help
77-
```
71+
72+
This is especially useful when configuring environments with tools such as docker.
7873

7974
### Logging level
8075

0 commit comments

Comments
 (0)