[{"data":1,"prerenderedAt":1204},["ShallowReactive",2],{"doc-command-line":3},{"id":4,"title":5,"body":6,"description":1195,"extension":1196,"meta":1197,"navigation":1198,"path":1199,"seo":1200,"slug":12,"source":1201,"stem":1202,"__hash__":1203},"docs\u002Fdocs\u002Fcommand-line.md","Command line",{"type":7,"value":8,"toc":1183},"minimark",[9,13,78,91,117,127,137,141,144,257,285,288,458,461,621,624,771,774,850,853,976,979,989,1026,1029,1102,1105],[10,11,5],"h1",{"id":12},"command-line",[14,15,16,20,23,28,30,34,36,40,42,46,48,52,54,58,60,64,66,70,72,76],"p",{},[17,18,19],"strong",{},"Contents",[21,22],"br",{},[24,25,27],"a",{"href":26},"#test-specs","Test specs",[21,29],{},[24,31,33],{"href":32},"#selecting-tests","Selecting tests",[21,35],{},[24,37,39],{"href":38},"#running","Running",[21,41],{},[24,43,45],{"href":44},"#how-tests-behave","How tests behave",[21,47],{},[24,49,51],{"href":50},"#history-and-analysis","History and analysis",[21,53],{},[24,55,57],{"href":56},"#output","Output",[21,59],{},[24,61,63],{"href":62},"#configuration","Configuration",[21,65],{},[24,67,69],{"href":68},"#information","Information",[21,71],{},[24,73,75],{"href":74},"#environment","Environment",[21,77],{},[14,79,80,81,85,86,90],{},"This is the command line of a test binary, which the\n",[24,82,84],{"href":83},"\u002Fdocs\u002Fprogmasoft-runner\u002F","Catch3 runner"," reads. ",[87,88,89],"code",{},"--help"," prints it.",[14,92,93,94,97,98,101,102,105,106,108,109,112,113,116],{},"Long options take their value after ",[87,95,96],{},"="," or as the next argument:\n",[87,99,100],{},"--jobs=4"," and ",[87,103,104],{},"--jobs 4"," are the same. Short options take it attached or\nafter ",[87,107,96],{},": ",[87,110,111],{},"-j4",", ",[87,114,115],{},"-j=4",". An option the runner does not know is an error,\nwith a suggestion when it looks like a known one:",[118,119,125],"pre",{"className":120,"code":122,"language":123,"meta":124},[121],"language-text","$ .\u002Ftests --jbos=4\nerror: '--jbos=4' is not an option; did you mean --jobs?\n","text","",[87,126,122],{"__ignoreMap":124},[14,128,129,132,133,136],{},[87,130,131],{},"--"," ends the options: what follows is test specs, even when it starts with\n",[87,134,135],{},"-",".",[138,139,27],"h2",{"id":140},"test-specs",[14,142,143],{},"Arguments that are not options select tests by name or tag, as in Catch2:",[145,146,147,160],"table",{},[148,149,150],"thead",{},[151,152,153,157],"tr",{},[154,155,156],"th",{},"Spec",[154,158,159],{},"Selects",[161,162,163,174,188,200,210,223,233,243],"tbody",{},[151,164,165,171],{},[166,167,168],"td",{},[87,169,170],{},"\"parses lists\"",[166,172,173],{},"the test of that name",[151,175,176,181],{},[166,177,178],{},[87,179,180],{},"\"parses*\"",[166,182,183,184,187],{},"tests whose name starts with \"parses\"; ",[87,185,186],{},"*"," may stand at either end",[151,189,190,195],{},[166,191,192],{},[87,193,194],{},"[parser]",[166,196,197,198],{},"tests tagged ",[87,199,194],{},[151,201,202,207],{},[166,203,204],{},[87,205,206],{},"[parser][fast]",[166,208,209],{},"tests with both tags",[151,211,212,217],{},[166,213,214],{},[87,215,216],{},"~[slow]",[166,218,219,220],{},"every test but those tagged ",[87,221,222],{},"[slow]",[151,224,225,230],{},[166,226,227],{},[87,228,229],{},"[parser],[lexer]",[166,231,232],{},"tests with either tag",[151,234,235,240],{},[166,236,237],{},[87,238,239],{},"\"a b\" [x]",[166,241,242],{},"specs separated by spaces must all match",[151,244,245,250],{},[166,246,247],{},[87,248,249],{},"[@alias]",[166,251,252,253],{},"the tags of a ",[24,254,256],{"href":255},"\u002Fdocs\u002Ftest-cases-and-sections\u002F#tag-aliases","tag alias",[14,258,259,260,262,263,112,266,269,270,112,273,112,275,101,278,281,282,136],{},"Without a spec, every test runs except hidden ones, whose tags start with\n",[87,261,136],{},"; a spec that names a hidden test runs it. A backslash makes ",[87,264,265],{},",",[87,267,268],{},"[",",\n",[87,271,272],{},"]",[87,274,186],{},[87,276,277],{},"~",[87,279,280],{},"\""," literal: ",[87,283,284],{},"\"commas\\, and more\"",[138,286,33],{"id":287},"selecting-tests",[145,289,290,299],{},[148,291,292],{},[151,293,294,297],{},[154,295,296],{},"Option",[154,298],{},[161,300,301,314,342,359,390,409,419,429,439],{},[151,302,303,311],{},[166,304,305,112,308],{},[87,306,307],{},"-c",[87,309,310],{},"--section=NAME",[166,312,313],{},"run only this section; repeat for nested sections",[151,315,316,324],{},[166,317,318,112,321],{},[87,319,320],{},"-p",[87,322,323],{},"--path-filter=c:SECTION|g:INDEX",[166,325,326,327,330,331,334,335,337,338,136],{},"run one path through sections (",[87,328,329],{},"c:",") and generator values (",[87,332,333],{},"g:",", an index or ",[87,336,186],{},"); repeat for each level. See ",[24,339,341],{"href":340},"\u002Fdocs\u002Ffiltering-execution-path\u002F","running a section",[151,343,344,352],{},[166,345,346,112,349],{},[87,347,348],{},"-f",[87,350,351],{},"--input-file=FILE",[166,353,354,355,358],{},"run the tests named in FILE, one exact name per line; lines starting with ",[87,356,357],{},"#"," are comments",[151,360,361,366],{},[166,362,363],{},[87,364,365],{},"--select=WHICH",[166,367,368,371,372,112,375,112,378,381,382,385,386],{},[87,369,370],{},"all"," (default), ",[87,373,374],{},"failed",[87,376,377],{},"changed",[87,379,380],{},"new"," or ",[87,383,384],{},"smart","; see ",[24,387,389],{"href":388},"\u002Fdocs\u002Fprogmasoft-runner\u002F#choosing-and-ordering-tests","choosing tests",[151,391,392,397],{},[166,393,394],{},[87,395,396],{},"--changes-since=REVISION",[166,398,399,400,101,402,404,405,408],{},"the Git revision ",[87,401,377],{},[87,403,384],{}," compare with (default ",[87,406,407],{},"HEAD",")",[151,410,411,416],{},[166,412,413],{},[87,414,415],{},"--incremental",[166,417,418],{},"skip tests that passed last time and whose inputs did not change",[151,420,421,426],{},[166,422,423],{},[87,424,425],{},"--shard=INDEX\u002FCOUNT",[166,427,428],{},"run one of COUNT shards, counting from 0",[151,430,431,436],{},[166,432,433],{},[87,434,435],{},"--shard-durations=FILE",[166,437,438],{},"balance shards by the durations in a JSON report or a history",[151,440,441,449],{},[166,442,443,112,446],{},[87,444,445],{},"-#",[87,447,448],{},"--filenames-as-tags",[166,450,451,452,454,455],{},"tag every test with ",[87,453,357],{}," and the name of its file, as ",[87,456,457],{},"[#parser.tests]",[138,459,39],{"id":460},"running",[145,462,463,471],{},[148,464,465],{},[151,466,467,469],{},[154,468,296],{},[154,470],{},[161,472,473,486,496,506,520,530,544,557,567,580,601,611],{},[151,474,475,483],{},[166,476,477,112,480],{},[87,478,479],{},"-j",[87,481,482],{},"--jobs=N",[166,484,485],{},"worker processes; 0, the default, uses one per hardware thread",[151,487,488,493],{},[166,489,490],{},[87,491,492],{},"--in-process",[166,494,495],{},"run the tests in this process, one after another",[151,497,498,503],{},[166,499,500],{},[87,501,502],{},"--isolate",[166,504,505],{},"start a fresh process for every test",[151,507,508,513],{},[166,509,510],{},[87,511,512],{},"--pass-env=NAME",[166,514,515,516,519],{},"give the tests the variable ",[87,517,518],{},"NAME",", which they do not get because its name looks like a secret (repeatable)",[151,521,522,527],{},[166,523,524],{},[87,525,526],{},"--timeout=SECONDS",[166,528,529],{},"the limit for a test without history, and the cap of learned limits; 0 for none",[151,531,532,537],{},[166,533,534],{},[87,535,536],{},"--no-adaptive-timeout",[166,538,539,540,543],{},"use ",[87,541,542],{},"--timeout"," for every test",[151,545,546,551],{},[166,547,548],{},[87,549,550],{},"--retries=N|auto|off",[166,552,553,556],{},[87,554,555],{},"auto"," (default) retries what may pass again; N retries every failure up to N times",[151,558,559,564],{},[166,560,561],{},[87,562,563],{},"--repeat=N",[166,565,566],{},"run every test N times, to find flaky tests",[151,568,569,577],{},[166,570,571,112,574],{},[87,572,573],{},"-a",[87,575,576],{},"--fail-fast[=N]",[166,578,579],{},"start no test after N failed tests (default 1)",[151,581,582,587],{},[166,583,584],{},[87,585,586],{},"--order=ORDER",[166,588,589,371,592,112,595,381,598],{},[87,590,591],{},"priority",[87,593,594],{},"declared",[87,596,597],{},"name",[87,599,600],{},"random",[151,602,603,608],{},[166,604,605],{},[87,606,607],{},"--seed=N|random",[166,609,610],{},"the random seed; a new one each run by default",[151,612,613,618],{},[166,614,615],{},[87,616,617],{},"--no-bisect",[166,619,620],{},"do not search for the test that leaves state behind",[138,622,45],{"id":623},"how-tests-behave",[145,625,626,634],{},[148,627,628],{},[151,629,630,632],{},[154,631,296],{},[154,633],{},[161,635,636,649,662,675,697,707,721,731,741,751,761],{},[151,637,638,646],{},[166,639,640,112,643],{},[87,641,642],{},"-s",[87,644,645],{},"--success",[166,647,648],{},"report passing assertions too, and show every assertion",[151,650,651,659],{},[166,652,653,112,656],{},[87,654,655],{},"-b",[87,657,658],{},"--break",[166,660,661],{},"break into the debugger on a failure; runs in process",[151,663,664,672],{},[166,665,666,112,669],{},[87,667,668],{},"-e",[87,670,671],{},"--no-throw",[166,673,674],{},"skip the assertions that expect exceptions",[151,676,677,685],{},[166,678,679,112,682],{},[87,680,681],{},"-w",[87,683,684],{},"--warn=WHAT",[166,686,687,688,112,691,381,694],{},"fail on ",[87,689,690],{},"no-assertions",[87,692,693],{},"unmatched-specs",[87,695,696],{},"infinite-generators",[151,698,699,704],{},[166,700,701],{},[87,702,703],{},"--allow-no-tests",[166,705,706],{},"succeed when no test runs",[151,708,709,714],{},[166,710,711],{},[87,712,713],{},"--skip-benchmarks",[166,715,716,717,720],{},"do not run ",[87,718,719],{},"BENCHMARK"," blocks",[151,722,723,728],{},[166,724,725],{},[87,726,727],{},"--benchmark-samples=N",[166,729,730],{},"samples per benchmark (default 100)",[151,732,733,738],{},[166,734,735],{},[87,736,737],{},"--benchmark-resamples=N",[166,739,740],{},"bootstrap resamples (default 100000)",[151,742,743,748],{},[166,744,745],{},[87,746,747],{},"--benchmark-confidence-interval=X",[166,749,750],{},"between 0 and 1 (default 0.95)",[151,752,753,758],{},[166,754,755],{},[87,756,757],{},"--benchmark-no-analysis",[166,759,760],{},"report the mean of the samples without statistics",[151,762,763,768],{},[166,764,765],{},[87,766,767],{},"--benchmark-warmup-time=MILLISECONDS",[166,769,770],{},"warm-up time per benchmark (default 100)",[138,772,51],{"id":773},"history-and-analysis",[145,775,776,784],{},[148,777,778],{},[151,779,780,782],{},[154,781,296],{},[154,783],{},[161,785,786,803,813,830,840],{},[151,787,788,793],{},[166,789,790],{},[87,791,792],{},"--history=DIRECTORY",[166,794,795,796,799,800,408],{},"where results are remembered (default ",[87,797,798],{},".catch3"," beside the binary, or ",[87,801,802],{},"CATCH3_HISTORY",[151,804,805,810],{},[166,806,807],{},[87,808,809],{},"--no-history",[166,811,812],{},"neither read nor write the history",[151,814,815,820],{},[166,816,817],{},[87,818,819],{},"--quarantine=MODE",[166,821,822,371,824,381,827],{},[87,823,555],{},[87,825,826],{},"report",[87,828,829],{},"off",[151,831,832,837],{},[166,833,834],{},[87,835,836],{},"--replay",[166,838,839],{},"run last run's failures again, each in the order and with the seed it failed with",[151,841,842,847],{},[166,843,844],{},[87,845,846],{},"--analytics[=json]",[166,848,849],{},"print what the history says about the tests, and exit",[138,851,57],{"id":852},"output",[145,854,855,863],{},[148,856,857],{},[151,858,859,861],{},[154,860,296],{},[154,862],{},[161,864,865,878,891,908,918,928,942,956,966],{},[151,866,867,875],{},[166,868,869,112,872],{},[87,870,871],{},"-v",[87,873,874],{},"--verbose",[166,876,877],{},"print every test as it ends, with what it printed",[151,879,880,888],{},[166,881,882,112,885],{},[87,883,884],{},"-q",[87,886,887],{},"--quiet",[166,889,890],{},"print only failures and the summary",[151,892,893,898],{},[166,894,895],{},[87,896,897],{},"--color=WHEN",[166,899,900,371,902,381,905],{},[87,901,555],{},[87,903,904],{},"always",[87,906,907],{},"never",[151,909,910,915],{},[166,911,912],{},[87,913,914],{},"--junit=FILE",[166,916,917],{},"write a JUnit XML report",[151,919,920,925],{},[166,921,922],{},[87,923,924],{},"--json=FILE",[166,926,927],{},"write a JSON report with every attempt and its analysis",[151,929,930,935],{},[166,931,932],{},[87,933,934],{},"--trace=FILE",[166,936,937,938,941],{},"write a trace for ",[87,939,940],{},"chrome:\u002F\u002Ftracing"," or Perfetto",[151,943,944,949],{},[166,945,946],{},[87,947,948],{},"--coverage=DIR",[166,950,951,952],{},"run every test in a process of its own and keep its coverage in DIR, with a map of what each test reached; see ",[24,953,955],{"href":954},"\u002Fdocs\u002Fprogmasoft-runner\u002F#per-test-coverage","Per-test coverage",[151,957,958,963],{},[166,959,960],{},[87,961,962],{},"--slowest[=N]",[166,964,965],{},"list the N slowest tests (default 10)",[151,967,968,973],{},[166,969,970],{},[87,971,972],{},"--premature-exit-guard-file=FILE",[166,974,975],{},"create FILE, private to the user, when the run starts and remove it when the run ends normally",[138,977,63],{"id":978},"configuration",[14,980,981,982,988],{},"A project can keep its options in a ",[24,983,985],{"href":984},"\u002Fdocs\u002Fprogmasoft-runner\u002F#project-configuration",[87,986,987],{},"catch3.json",";\noptions on the command line win over it.",[145,990,991,999],{},[148,992,993],{},[151,994,995,997],{},[154,996,296],{},[154,998],{},[161,1000,1001,1014],{},[151,1002,1003,1008],{},[166,1004,1005],{},[87,1006,1007],{},"--config=FILE",[166,1009,1010,1011,1013],{},"read this ",[87,1012,987],{}," instead of searching for one",[151,1015,1016,1021],{},[166,1017,1018],{},[87,1019,1020],{},"--no-config",[166,1022,1023,1024],{},"read no ",[87,1025,987],{},[138,1027,69],{"id":1028},"information",[145,1030,1031,1039],{},[148,1032,1033],{},[151,1034,1035,1037],{},[154,1036,296],{},[154,1038],{},[161,1040,1041,1067,1080,1092],{},[151,1042,1043,1051],{},[166,1044,1045,112,1048],{},[87,1046,1047],{},"-l",[87,1049,1050],{},"--list[=FORMAT]",[166,1052,1053,1054,371,1056,381,1059,1062,1063,408],{},"list the matching tests: ",[87,1055,123],{},[87,1057,1058],{},"names",[87,1060,1061],{},"json"," (",[24,1064,1066],{"href":1065},"\u002Fdocs\u002Fprogmasoft-runner\u002F#formats-other-tools-read","format",[151,1068,1069,1077],{},[166,1070,1071,112,1074],{},[87,1072,1073],{},"-t",[87,1075,1076],{},"--list-tags",[166,1078,1079],{},"list the tags of the matching tests",[151,1081,1082,1089],{},[166,1083,1084,112,1087],{},[87,1085,1086],{},"-h",[87,1088,89],{},[166,1090,1091],{},"print the options",[151,1093,1094,1099],{},[166,1095,1096],{},[87,1097,1098],{},"--version",[166,1100,1101],{},"print the version of Catch3",[138,1103,75],{"id":1104},"environment",[145,1106,1107,1116],{},[148,1108,1109],{},[151,1110,1111,1114],{},[154,1112,1113],{},"Variable",[154,1115],{},[161,1117,1118,1127,1141,1151,1171],{},[151,1119,1120,1124],{},[166,1121,1122],{},[87,1123,802],{},[166,1125,1126],{},"the history directory",[151,1128,1129,1134],{},[166,1130,1131],{},[87,1132,1133],{},"CATCH3_PROPERTY_DATABASE",[166,1135,1136,1137],{},"the example database of ",[24,1138,1140],{"href":1139},"\u002Fdocs\u002Fprogmasoft-properties\u002F","property tests",[151,1142,1143,1148],{},[166,1144,1145],{},[87,1146,1147],{},"CATCH3_WORKER",[166,1149,1150],{},"set in each worker to its number",[151,1152,1153,1164],{},[166,1154,1155,112,1158,112,1161],{},[87,1156,1157],{},"TMPDIR",[87,1159,1160],{},"TMP",[87,1162,1163],{},"TEMP",[166,1165,1166,1167],{},"set while a test runs to its ",[24,1168,1170],{"href":1169},"\u002Fdocs\u002Fprogmasoft-runner\u002F#temporary-files","own directory",[151,1172,1173,1176],{},[166,1174,1175],{},"Bazel's test variables",[166,1177,1178,1179],{},"see ",[24,1180,1182],{"href":1181},"\u002Fdocs\u002Fprogmasoft-runner\u002F#bazel-and-ctest","Bazel",{"title":124,"searchDepth":1184,"depth":1184,"links":1185},2,[1186,1187,1188,1189,1190,1191,1192,1193,1194],{"id":140,"depth":1184,"text":27},{"id":287,"depth":1184,"text":33},{"id":460,"depth":1184,"text":39},{"id":623,"depth":1184,"text":45},{"id":773,"depth":1184,"text":51},{"id":852,"depth":1184,"text":57},{"id":978,"depth":1184,"text":63},{"id":1028,"depth":1184,"text":69},{"id":1104,"depth":1184,"text":75},"ContentsTest specsSelecting testsRunningHow tests behaveHistory and analysisOutputConfigurationInformationEnvironment","md",{},true,"\u002Fdocs\u002Fcommand-line",{"title":5,"description":1195},"docs\u002Fcommand-line.md","docs\u002Fcommand-line","fSOTYWBLGZxZ-u4WBFqGIVOaiQRaJ9Bic3KPGYNeLDM",1794961594966]