You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cli.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,7 +60,7 @@ prek install [OPTIONS] [HOOK|PROJECT]...
60
60
<dlclass="cli-reference"><dtid="prek-install--allow-missing-config"><ahref="#prek-install--allow-missing-config"><code>--allow-missing-config</code></a></dt><dd><p>Allow a missing <code>pre-commit</code> configuration file</p>
61
61
</dd><dtid="prek-install--cd"><ahref="#prek-install--cd"><code>--cd</code></a>, <code>-C</code> <i>dir</i></dt><dd><p>Change to directory before running</p>
62
62
</dd><dtid="prek-install--color"><ahref="#prek-install--color"><code>--color</code></a> <i>color</i></dt><dd><p>Whether to use color in output</p>
63
-
<p>May also be set with the <code>PREK_COLOR</code> environment variable.</p><p>[default: auto]</p><p>Possible values:</p>
63
+
<p>Possible values:</p>
64
64
<ul>
65
65
<li><code>auto</code>: Enables colored output only when the output is going to a terminal or TTY with support</li>
66
66
<li><code>always</code>: Enables colored output regardless of the detected environment</li>
@@ -127,7 +127,7 @@ prek install-hooks [OPTIONS] [HOOK|PROJECT]...
127
127
128
128
<dlclass="cli-reference"><dtid="prek-install-hooks--cd"><ahref="#prek-install-hooks--cd"><code>--cd</code></a>, <code>-C</code> <i>dir</i></dt><dd><p>Change to directory before running</p>
129
129
</dd><dtid="prek-install-hooks--color"><ahref="#prek-install-hooks--color"><code>--color</code></a> <i>color</i></dt><dd><p>Whether to use color in output</p>
130
-
<p>May also be set with the <code>PREK_COLOR</code> environment variable.</p><p>[default: auto]</p><p>Possible values:</p>
130
+
<p>Possible values:</p>
131
131
<ul>
132
132
<li><code>auto</code>: Enables colored output only when the output is going to a terminal or TTY with support</li>
133
133
<li><code>always</code>: Enables colored output regardless of the detected environment</li>
@@ -191,7 +191,7 @@ prek run [OPTIONS] [HOOK|PROJECT]...
191
191
<dlclass="cli-reference"><dtid="prek-run--all-files"><ahref="#prek-run--all-files"><code>--all-files</code></a>, <code>-a</code></dt><dd><p>Run on all files in the repo</p>
192
192
</dd><dtid="prek-run--cd"><ahref="#prek-run--cd"><code>--cd</code></a>, <code>-C</code> <i>dir</i></dt><dd><p>Change to directory before running</p>
193
193
</dd><dtid="prek-run--color"><ahref="#prek-run--color"><code>--color</code></a> <i>color</i></dt><dd><p>Whether to use color in output</p>
194
-
<p>May also be set with the <code>PREK_COLOR</code> environment variable.</p><p>[default: auto]</p><p>Possible values:</p>
194
+
<p>Possible values:</p>
195
195
<ul>
196
196
<li><code>auto</code>: Enables colored output only when the output is going to a terminal or TTY with support</li>
197
197
<li><code>always</code>: Enables colored output regardless of the detected environment</li>
@@ -277,7 +277,7 @@ prek list [OPTIONS] [HOOK|PROJECT]...
277
277
278
278
<dlclass="cli-reference"><dtid="prek-list--cd"><ahref="#prek-list--cd"><code>--cd</code></a>, <code>-C</code> <i>dir</i></dt><dd><p>Change to directory before running</p>
279
279
</dd><dtid="prek-list--color"><ahref="#prek-list--color"><code>--color</code></a> <i>color</i></dt><dd><p>Whether to use color in output</p>
280
-
<p>May also be set with the <code>PREK_COLOR</code> environment variable.</p><p>[default: auto]</p><p>Possible values:</p>
280
+
<p>Possible values:</p>
281
281
<ul>
282
282
<li><code>auto</code>: Enables colored output only when the output is going to a terminal or TTY with support</li>
283
283
<li><code>always</code>: Enables colored output regardless of the detected environment</li>
@@ -364,7 +364,7 @@ prek uninstall [OPTIONS]
364
364
365
365
<dlclass="cli-reference"><dtid="prek-uninstall--cd"><ahref="#prek-uninstall--cd"><code>--cd</code></a>, <code>-C</code> <i>dir</i></dt><dd><p>Change to directory before running</p>
366
366
</dd><dtid="prek-uninstall--color"><ahref="#prek-uninstall--color"><code>--color</code></a> <i>color</i></dt><dd><p>Whether to use color in output</p>
367
-
<p>May also be set with the <code>PREK_COLOR</code> environment variable.</p><p>[default: auto]</p><p>Possible values:</p>
367
+
<p>Possible values:</p>
368
368
<ul>
369
369
<li><code>auto</code>: Enables colored output only when the output is going to a terminal or TTY with support</li>
370
370
<li><code>always</code>: Enables colored output regardless of the detected environment</li>
@@ -400,7 +400,7 @@ prek validate-config [OPTIONS] [CONFIG]...
400
400
401
401
<dlclass="cli-reference"><dtid="prek-validate-config--cd"><ahref="#prek-validate-config--cd"><code>--cd</code></a>, <code>-C</code> <i>dir</i></dt><dd><p>Change to directory before running</p>
402
402
</dd><dtid="prek-validate-config--color"><ahref="#prek-validate-config--color"><code>--color</code></a> <i>color</i></dt><dd><p>Whether to use color in output</p>
403
-
<p>May also be set with the <code>PREK_COLOR</code> environment variable.</p><p>[default: auto]</p><p>Possible values:</p>
403
+
<p>Possible values:</p>
404
404
<ul>
405
405
<li><code>auto</code>: Enables colored output only when the output is going to a terminal or TTY with support</li>
406
406
<li><code>always</code>: Enables colored output regardless of the detected environment</li>
@@ -436,7 +436,7 @@ prek validate-manifest [OPTIONS] [MANIFEST]...
436
436
437
437
<dlclass="cli-reference"><dtid="prek-validate-manifest--cd"><ahref="#prek-validate-manifest--cd"><code>--cd</code></a>, <code>-C</code> <i>dir</i></dt><dd><p>Change to directory before running</p>
438
438
</dd><dtid="prek-validate-manifest--color"><ahref="#prek-validate-manifest--color"><code>--color</code></a> <i>color</i></dt><dd><p>Whether to use color in output</p>
439
-
<p>May also be set with the <code>PREK_COLOR</code> environment variable.</p><p>[default: auto]</p><p>Possible values:</p>
439
+
<p>Possible values:</p>
440
440
<ul>
441
441
<li><code>auto</code>: Enables colored output only when the output is going to a terminal or TTY with support</li>
442
442
<li><code>always</code>: Enables colored output regardless of the detected environment</li>
@@ -467,7 +467,7 @@ prek sample-config [OPTIONS]
467
467
468
468
<dlclass="cli-reference"><dtid="prek-sample-config--cd"><ahref="#prek-sample-config--cd"><code>--cd</code></a>, <code>-C</code> <i>dir</i></dt><dd><p>Change to directory before running</p>
469
469
</dd><dtid="prek-sample-config--color"><ahref="#prek-sample-config--color"><code>--color</code></a> <i>color</i></dt><dd><p>Whether to use color in output</p>
470
-
<p>May also be set with the <code>PREK_COLOR</code> environment variable.</p><p>[default: auto]</p><p>Possible values:</p>
470
+
<p>Possible values:</p>
471
471
<ul>
472
472
<li><code>auto</code>: Enables colored output only when the output is going to a terminal or TTY with support</li>
473
473
<li><code>always</code>: Enables colored output regardless of the detected environment</li>
@@ -500,7 +500,7 @@ prek auto-update [OPTIONS]
500
500
<dlclass="cli-reference"><dtid="prek-auto-update--bleeding-edge"><ahref="#prek-auto-update--bleeding-edge"><code>--bleeding-edge</code></a></dt><dd><p>Update to the bleeding edge of the default branch instead of the latest tagged version</p>
501
501
</dd><dtid="prek-auto-update--cd"><ahref="#prek-auto-update--cd"><code>--cd</code></a>, <code>-C</code> <i>dir</i></dt><dd><p>Change to directory before running</p>
502
502
</dd><dtid="prek-auto-update--color"><ahref="#prek-auto-update--color"><code>--color</code></a> <i>color</i></dt><dd><p>Whether to use color in output</p>
503
-
<p>May also be set with the <code>PREK_COLOR</code> environment variable.</p><p>[default: auto]</p><p>Possible values:</p>
503
+
<p>Possible values:</p>
504
504
<ul>
505
505
<li><code>auto</code>: Enables colored output only when the output is going to a terminal or TTY with support</li>
506
506
<li><code>always</code>: Enables colored output regardless of the detected environment</li>
@@ -552,7 +552,7 @@ prek cache dir [OPTIONS]
552
552
553
553
<dlclass="cli-reference"><dtid="prek-cache-dir--cd"><ahref="#prek-cache-dir--cd"><code>--cd</code></a>, <code>-C</code> <i>dir</i></dt><dd><p>Change to directory before running</p>
554
554
</dd><dtid="prek-cache-dir--color"><ahref="#prek-cache-dir--color"><code>--color</code></a> <i>color</i></dt><dd><p>Whether to use color in output</p>
555
-
<p>May also be set with the <code>PREK_COLOR</code> environment variable.</p><p>[default: auto]</p><p>Possible values:</p>
555
+
<p>Possible values:</p>
556
556
<ul>
557
557
<li><code>auto</code>: Enables colored output only when the output is going to a terminal or TTY with support</li>
558
558
<li><code>always</code>: Enables colored output regardless of the detected environment</li>
@@ -583,7 +583,7 @@ prek cache gc [OPTIONS]
583
583
584
584
<dlclass="cli-reference"><dtid="prek-cache-gc--cd"><ahref="#prek-cache-gc--cd"><code>--cd</code></a>, <code>-C</code> <i>dir</i></dt><dd><p>Change to directory before running</p>
585
585
</dd><dtid="prek-cache-gc--color"><ahref="#prek-cache-gc--color"><code>--color</code></a> <i>color</i></dt><dd><p>Whether to use color in output</p>
586
-
<p>May also be set with the <code>PREK_COLOR</code> environment variable.</p><p>[default: auto]</p><p>Possible values:</p>
586
+
<p>Possible values:</p>
587
587
<ul>
588
588
<li><code>auto</code>: Enables colored output only when the output is going to a terminal or TTY with support</li>
589
589
<li><code>always</code>: Enables colored output regardless of the detected environment</li>
@@ -614,7 +614,7 @@ prek cache clean [OPTIONS]
614
614
615
615
<dlclass="cli-reference"><dtid="prek-cache-clean--cd"><ahref="#prek-cache-clean--cd"><code>--cd</code></a>, <code>-C</code> <i>dir</i></dt><dd><p>Change to directory before running</p>
616
616
</dd><dtid="prek-cache-clean--color"><ahref="#prek-cache-clean--color"><code>--color</code></a> <i>color</i></dt><dd><p>Whether to use color in output</p>
617
-
<p>May also be set with the <code>PREK_COLOR</code> environment variable.</p><p>[default: auto]</p><p>Possible values:</p>
617
+
<p>Possible values:</p>
618
618
<ul>
619
619
<li><code>auto</code>: Enables colored output only when the output is going to a terminal or TTY with support</li>
620
620
<li><code>always</code>: Enables colored output regardless of the detected environment</li>
@@ -650,7 +650,7 @@ prek init-template-dir [OPTIONS] <DIRECTORY>
650
650
651
651
<dlclass="cli-reference"><dtid="prek-init-template-dir--cd"><ahref="#prek-init-template-dir--cd"><code>--cd</code></a>, <code>-C</code> <i>dir</i></dt><dd><p>Change to directory before running</p>
652
652
</dd><dtid="prek-init-template-dir--color"><ahref="#prek-init-template-dir--color"><code>--color</code></a> <i>color</i></dt><dd><p>Whether to use color in output</p>
653
-
<p>May also be set with the <code>PREK_COLOR</code> environment variable.</p><p>[default: auto]</p><p>Possible values:</p>
653
+
<p>Possible values:</p>
654
654
<ul>
655
655
<li><code>auto</code>: Enables colored output only when the output is going to a terminal or TTY with support</li>
656
656
<li><code>always</code>: Enables colored output regardless of the detected environment</li>
@@ -715,7 +715,7 @@ prek try-repo [OPTIONS] <REPO> [HOOK|PROJECT]...
715
715
<dlclass="cli-reference"><dtid="prek-try-repo--all-files"><ahref="#prek-try-repo--all-files"><code>--all-files</code></a>, <code>-a</code></dt><dd><p>Run on all files in the repo</p>
716
716
</dd><dtid="prek-try-repo--cd"><ahref="#prek-try-repo--cd"><code>--cd</code></a>, <code>-C</code> <i>dir</i></dt><dd><p>Change to directory before running</p>
717
717
</dd><dtid="prek-try-repo--color"><ahref="#prek-try-repo--color"><code>--color</code></a> <i>color</i></dt><dd><p>Whether to use color in output</p>
718
-
<p>May also be set with the <code>PREK_COLOR</code> environment variable.</p><p>[default: auto]</p><p>Possible values:</p>
718
+
<p>Possible values:</p>
719
719
<ul>
720
720
<li><code>auto</code>: Enables colored output only when the output is going to a terminal or TTY with support</li>
721
721
<li><code>always</code>: Enables colored output regardless of the detected environment</li>
@@ -804,7 +804,7 @@ prek self update [OPTIONS] [TARGET_VERSION]
804
804
805
805
<dlclass="cli-reference"><dtid="prek-self-update--cd"><ahref="#prek-self-update--cd"><code>--cd</code></a>, <code>-C</code> <i>dir</i></dt><dd><p>Change to directory before running</p>
806
806
</dd><dtid="prek-self-update--color"><ahref="#prek-self-update--color"><code>--color</code></a> <i>color</i></dt><dd><p>Whether to use color in output</p>
807
-
<p>May also be set with the <code>PREK_COLOR</code> environment variable.</p><p>[default: auto]</p><p>Possible values:</p>
807
+
<p>Possible values:</p>
808
808
<ul>
809
809
<li><code>auto</code>: Enables colored output only when the output is going to a terminal or TTY with support</li>
810
810
<li><code>always</code>: Enables colored output regardless of the detected environment</li>
0 commit comments