Supported CLI arguments¶
| Argument | Type | Default value | Description |
|---|---|---|---|
-h, --help |
Unique flag | - | Displays help message |
-v, --version |
Unique flag | - | Displays application version |
-w, --write-config |
Unique flag | - | Creates config file corresponding to the default configuration |
-c, --config |
Optional argument | .clang-build-profiler |
Specifies custom config path |
-a, --artifacts |
Optional argument | .cbp/ |
Specifies custom output directory |
-o, --output |
Optional argument | terminal |
Selects profiling output format |
-b, --build |
Exclusive group [1] | build/ |
Selects CMake build directory |
-t, --target |
Exclusive group [1] | - | Selects build artifacts directory |
-f, --file |
Exclusive group [1] | - | Selects specific translation unit |
Examples¶
View help¶
Verbose form:
clang-build-profiler --help
Short form:
clang-build-profiler -h
View version¶
Verbose form:
clang-build-profiler --version
Short form:
clang-build-profiler -v
Write default config¶
Verbose form:
clang-build-profiler --write-config
Short form:
clang-build-profiler -w
Specify custom config path¶
Verbose form:
clang-build-profiler --config="configs/clang-build-profiler.yml"
Short form:
clang-build-profiler -c "configs/clang-build-profiler.yml"
Specify custom output path¶
Verbose form:
clang-build-profiler --artifacts="data/clang-build-profiler/"
Short form:
clang-build-profiler -a "data/clang-build-profiler/"
Specify output format¶
Verbose form:
clang-build-profiler --output=json
Short form:
clang-build-profiler -o json
Specify trace file¶
Verbose form:
clang-build-profiler --file="build/main.cpp.json"
Short form:
clang-build-profiler -f "build/main.cpp.json"