Skip to content

Commit b4f6504

Browse files
committed
Add extra useful info to ci readme
1 parent 3733ca0 commit b4f6504

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

ci/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,26 @@ This directory contains tooling used to run Continuous Integration tasks.
2222
```
2323
fireci --help
2424
```
25+
26+
## Uninstall
27+
28+
If you run into any issues and need to re-install, or uninstall the package, you can do so
29+
by uninstalling the `fireci` package.
30+
31+
```shell
32+
pip3 uninstall fireci -y
33+
```
34+
35+
## Debug
36+
37+
By default, if you're not running `fireci` within the context of CI, the minimum log level is set
38+
to `INFO`.
39+
40+
To manually set the level to `DEBUG`, you can use the `--debug` flag.
41+
42+
```shell
43+
fireci --debug clean
44+
```
45+
46+
> ![NOTE]
47+
> The `--debug` flag must come _before_ the command.

0 commit comments

Comments
 (0)