forked from vercel/turbo
/
turbo-help.t
314 lines (285 loc) · 21.2 KB
/
turbo-help.t
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
Setup
$ . ${TESTDIR}/../../helpers/setup.sh
Test help flag
$ ${TURBO} -h
The build system that makes ship happen
Usage: turbo(\.exe)? \[OPTIONS\] \[COMMAND\] (re)
Commands:
bin Get the path to the Turbo binary
completion Generate the autocompletion script for the specified shell
daemon Runs the Turborepo background daemon
generate Generate a new app / package
telemetry Enable or disable anonymous telemetry
scan Turbo your monorepo by running a number of 'repo lints' to identify common issues, suggest fixes, and improve performance
link Link your local directory to a Vercel organization and enable remote caching
login Login to your Vercel account
logout Logout to your Vercel account
prune Prepare a subset of your monorepo
run Run tasks across projects in your monorepo
unlink Unlink the current directory from your Vercel organization and disable Remote Caching
Options:
--version
--skip-infer Skip any attempts to infer which version of Turbo the project is configured to use
--no-update-notifier Disable the turbo update notification
--api <API> Override the endpoint for API calls
--color Force color usage in the terminal
--cpuprofile <CPU_PROFILE> Specify a file to save a cpu profile
--cwd <CWD> The directory in which to run turbo
--heap <HEAP> Specify a file to save a pprof heap profile
--login <LOGIN> Override the login endpoint
--no-color Suppress color usage in the terminal
--preflight When enabled, turbo will precede HTTP requests with an OPTIONS request for authorization
--remote-cache-timeout <TIMEOUT> Set a timeout for all HTTP requests
--team <TEAM> Set the team slug for API calls
--token <TOKEN> Set the auth token for API calls
--trace <TRACE> Specify a file to save a pprof trace
--verbosity <COUNT> Verbosity level
-h, --help Print help
Run Arguments:
--cache-dir <CACHE_DIR>
Override the filesystem cache directory [env: TURBO_CACHE_DIR=]
--cache-workers <CACHE_WORKERS>
Set the number of concurrent cache operations (default 10) [default: 10]
--concurrency <CONCURRENCY>
Limit the concurrency of task execution. Use 1 for serial (i.e. one-at-a-time) execution
--continue
Continue execution even if a task exits with an error or non-zero exit code. The default behavior is to bail
--dry-run [<DRY_RUN>]
[possible values: text, json]
--single-package
Run turbo in single-package mode
--force [<FORCE>]
Ignore the existing cache (to force execution) [env: TURBO_FORCE=] [possible values: true, false]
--framework-inference [<BOOL>]
Specify whether or not to do framework inference for tasks [default: true] [possible values: true, false]
--global-deps <GLOBAL_DEPS>
Specify glob of global filesystem dependencies to be hashed. Useful for .env and files
--graph [<GRAPH>]
Generate a graph of the task execution and output to a file when a filename is specified (.svg, .png, .jpg, .pdf, .json, .html, .mermaid, .dot). Outputs dot graph to stdout when if no filename is provided
--env-mode [<ENV_MODE>]
Environment variable mode. Use "loose" to pass the entire existing environment. Use "strict" to use an allowlist specified in turbo.json. Use "infer" to defer to existence of "passThroughEnv" or "globalPassThroughEnv" in turbo.json. (default infer) [default: infer] [possible values: infer, loose, strict]
-F, --filter <FILTER>
Use the given selector to specify package(s) to act as entry points. The syntax mirrors pnpm's syntax, and additional documentation and examples can be found in turbo's documentation https://turbo.build/repo/docs/reference/command-line-reference/run#--filter
--scope <SCOPE>
DEPRECATED: Specify package(s) to act as entry points for task execution. Supports globs
--ignore <IGNORE>
Files to ignore when calculating changed files from '--filter'. Supports globs
--since <SINCE>
DEPRECATED: Limit/Set scope to changed packages since a mergebase. This uses the git diff ${target_branch}... mechanism to identify which packages have changed
--include-dependencies
DEPRECATED: Include the dependencies of tasks in execution
--no-deps
DEPRECATED: Exclude dependent task consumers from execution
--no-cache
Avoid saving task results to the cache. Useful for development/watch tasks
--daemon
--no-daemon
Force turbo to either use or not use the local daemon. If unset turbo will use the default detection logic
--output-logs <OUTPUT_LOGS>
Set type of process output logging. Use "full" to show all output. Use "hash-only" to show only turbo-computed task hashes. Use "new-only" to show only new output with only hashes for cached tasks. Use "none" to hide process output. (default full) [possible values: full, none, hash-only, new-only, errors-only]
--log-order <LOG_ORDER>
Set type of task output order. Use "stream" to show output as soon as it is available. Use "grouped" to show output when a command has finished execution. Use "auto" to let turbo decide based on its own heuristics. (default auto) [env: TURBO_LOG_ORDER=] [default: auto] [possible values: auto, stream, grouped]
--only
Only executes the tasks specified, does not execute parent tasks
--parallel
Execute all tasks in parallel
--profile <PROFILE>
File to write turbo's performance profile output into. You can load the file up in chrome://tracing to see which parts of your build were slow
--anon-profile <ANON_PROFILE>
File to write turbo's performance profile output into. All identifying data omitted from the profile
--remote-only [<BOOL>]
Ignore the local filesystem cache for all tasks. Only allow reading and caching artifacts using the remote cache [env: TURBO_REMOTE_ONLY=] [default: false] [possible values: true, false]
--remote-cache-read-only [<BOOL>]
Treat remote cache as read only [env: TURBO_REMOTE_CACHE_READ_ONLY=] [default: false] [possible values: true, false]
--summarize [<SUMMARIZE>]
Generate a summary of the turbo run [env: TURBO_RUN_SUMMARY=] [possible values: true, false]
--log-prefix <LOG_PREFIX>
Use "none" to remove prefixes from task logs. Use "task" to get task id prefixing. Use "auto" to let turbo decide how to prefix the logs based on the execution environment. In most cases this will be the same as "task". Note that tasks running in parallel interleave their logs, so removing prefixes can make it difficult to associate logs with tasks. Use --log-order=grouped to prevent interleaving. (default auto) [default: auto] [possible values: auto, none, task]
$ ${TURBO} --help
The build system that makes ship happen
Usage: turbo(\.exe)? \[OPTIONS\] \[COMMAND\] (re)
Commands:
bin Get the path to the Turbo binary
completion Generate the autocompletion script for the specified shell
daemon Runs the Turborepo background daemon
generate Generate a new app / package
telemetry Enable or disable anonymous telemetry
scan Turbo your monorepo by running a number of 'repo lints' to identify common issues, suggest fixes, and improve performance
link Link your local directory to a Vercel organization and enable remote caching
login Login to your Vercel account
logout Logout to your Vercel account
prune Prepare a subset of your monorepo
run Run tasks across projects in your monorepo
unlink Unlink the current directory from your Vercel organization and disable Remote Caching
Options:
--version
--skip-infer Skip any attempts to infer which version of Turbo the project is configured to use
--no-update-notifier Disable the turbo update notification
--api <API> Override the endpoint for API calls
--color Force color usage in the terminal
--cpuprofile <CPU_PROFILE> Specify a file to save a cpu profile
--cwd <CWD> The directory in which to run turbo
--heap <HEAP> Specify a file to save a pprof heap profile
--login <LOGIN> Override the login endpoint
--no-color Suppress color usage in the terminal
--preflight When enabled, turbo will precede HTTP requests with an OPTIONS request for authorization
--remote-cache-timeout <TIMEOUT> Set a timeout for all HTTP requests
--team <TEAM> Set the team slug for API calls
--token <TOKEN> Set the auth token for API calls
--trace <TRACE> Specify a file to save a pprof trace
--verbosity <COUNT> Verbosity level
-h, --help Print help
Run Arguments:
--cache-dir <CACHE_DIR>
Override the filesystem cache directory [env: TURBO_CACHE_DIR=]
--cache-workers <CACHE_WORKERS>
Set the number of concurrent cache operations (default 10) [default: 10]
--concurrency <CONCURRENCY>
Limit the concurrency of task execution. Use 1 for serial (i.e. one-at-a-time) execution
--continue
Continue execution even if a task exits with an error or non-zero exit code. The default behavior is to bail
--dry-run [<DRY_RUN>]
[possible values: text, json]
--single-package
Run turbo in single-package mode
--force [<FORCE>]
Ignore the existing cache (to force execution) [env: TURBO_FORCE=] [possible values: true, false]
--framework-inference [<BOOL>]
Specify whether or not to do framework inference for tasks [default: true] [possible values: true, false]
--global-deps <GLOBAL_DEPS>
Specify glob of global filesystem dependencies to be hashed. Useful for .env and files
--graph [<GRAPH>]
Generate a graph of the task execution and output to a file when a filename is specified (.svg, .png, .jpg, .pdf, .json, .html, .mermaid, .dot). Outputs dot graph to stdout when if no filename is provided
--env-mode [<ENV_MODE>]
Environment variable mode. Use "loose" to pass the entire existing environment. Use "strict" to use an allowlist specified in turbo.json. Use "infer" to defer to existence of "passThroughEnv" or "globalPassThroughEnv" in turbo.json. (default infer) [default: infer] [possible values: infer, loose, strict]
-F, --filter <FILTER>
Use the given selector to specify package(s) to act as entry points. The syntax mirrors pnpm's syntax, and additional documentation and examples can be found in turbo's documentation https://turbo.build/repo/docs/reference/command-line-reference/run#--filter
--scope <SCOPE>
DEPRECATED: Specify package(s) to act as entry points for task execution. Supports globs
--ignore <IGNORE>
Files to ignore when calculating changed files from '--filter'. Supports globs
--since <SINCE>
DEPRECATED: Limit/Set scope to changed packages since a mergebase. This uses the git diff ${target_branch}... mechanism to identify which packages have changed
--include-dependencies
DEPRECATED: Include the dependencies of tasks in execution
--no-deps
DEPRECATED: Exclude dependent task consumers from execution
--no-cache
Avoid saving task results to the cache. Useful for development/watch tasks
--daemon
--no-daemon
Force turbo to either use or not use the local daemon. If unset turbo will use the default detection logic
--output-logs <OUTPUT_LOGS>
Set type of process output logging. Use "full" to show all output. Use "hash-only" to show only turbo-computed task hashes. Use "new-only" to show only new output with only hashes for cached tasks. Use "none" to hide process output. (default full) [possible values: full, none, hash-only, new-only, errors-only]
--log-order <LOG_ORDER>
Set type of task output order. Use "stream" to show output as soon as it is available. Use "grouped" to show output when a command has finished execution. Use "auto" to let turbo decide based on its own heuristics. (default auto) [env: TURBO_LOG_ORDER=] [default: auto] [possible values: auto, stream, grouped]
--only
Only executes the tasks specified, does not execute parent tasks
--parallel
Execute all tasks in parallel
--profile <PROFILE>
File to write turbo's performance profile output into. You can load the file up in chrome://tracing to see which parts of your build were slow
--anon-profile <ANON_PROFILE>
File to write turbo's performance profile output into. All identifying data omitted from the profile
--remote-only [<BOOL>]
Ignore the local filesystem cache for all tasks. Only allow reading and caching artifacts using the remote cache [env: TURBO_REMOTE_ONLY=] [default: false] [possible values: true, false]
--remote-cache-read-only [<BOOL>]
Treat remote cache as read only [env: TURBO_REMOTE_CACHE_READ_ONLY=] [default: false] [possible values: true, false]
--summarize [<SUMMARIZE>]
Generate a summary of the turbo run [env: TURBO_RUN_SUMMARY=] [possible values: true, false]
--log-prefix <LOG_PREFIX>
Use "none" to remove prefixes from task logs. Use "task" to get task id prefixing. Use "auto" to let turbo decide how to prefix the logs based on the execution environment. In most cases this will be the same as "task". Note that tasks running in parallel interleave their logs, so removing prefixes can make it difficult to associate logs with tasks. Use --log-order=grouped to prevent interleaving. (default auto) [default: auto] [possible values: auto, none, task]
Test help flag for link command
$ ${TURBO} link -h
Link your local directory to a Vercel organization and enable remote caching
Usage: turbo(\.exe)? link \[OPTIONS\] (re)
Options:
--no-gitignore Do not create or modify .gitignore (default false)
--version
--skip-infer Skip any attempts to infer which version of Turbo the project is configured to use
--target <TARGET> Specify what should be linked (default "remote cache") [default: remote-cache] [possible values: remote-cache, spaces]
--no-update-notifier Disable the turbo update notification
--api <API> Override the endpoint for API calls
--color Force color usage in the terminal
--cpuprofile <CPU_PROFILE> Specify a file to save a cpu profile
--cwd <CWD> The directory in which to run turbo
--heap <HEAP> Specify a file to save a pprof heap profile
--login <LOGIN> Override the login endpoint
--no-color Suppress color usage in the terminal
--preflight When enabled, turbo will precede HTTP requests with an OPTIONS request for authorization
--remote-cache-timeout <TIMEOUT> Set a timeout for all HTTP requests
--team <TEAM> Set the team slug for API calls
--token <TOKEN> Set the auth token for API calls
--trace <TRACE> Specify a file to save a pprof trace
--verbosity <COUNT> Verbosity level
-h, --help Print help
Test help flag for unlink command
$ ${TURBO} unlink -h
Unlink the current directory from your Vercel organization and disable Remote Caching
Usage: turbo(\.exe)? unlink \[OPTIONS\] (re)
Options:
--target <TARGET> Specify what should be unlinked (default "remote cache") [default: remote-cache] [possible values: remote-cache, spaces]
--version
--skip-infer Skip any attempts to infer which version of Turbo the project is configured to use
--no-update-notifier Disable the turbo update notification
--api <API> Override the endpoint for API calls
--color Force color usage in the terminal
--cpuprofile <CPU_PROFILE> Specify a file to save a cpu profile
--cwd <CWD> The directory in which to run turbo
--heap <HEAP> Specify a file to save a pprof heap profile
--login <LOGIN> Override the login endpoint
--no-color Suppress color usage in the terminal
--preflight When enabled, turbo will precede HTTP requests with an OPTIONS request for authorization
--remote-cache-timeout <TIMEOUT> Set a timeout for all HTTP requests
--team <TEAM> Set the team slug for API calls
--token <TOKEN> Set the auth token for API calls
--trace <TRACE> Specify a file to save a pprof trace
--verbosity <COUNT> Verbosity level
-h, --help Print help
Test help flag for login command
$ ${TURBO} login -h
Login to your Vercel account
Usage: turbo(\.exe)? login \[OPTIONS\] (re)
Options:
--sso-team <SSO_TEAM>
--version
-f, --force Force a login to receive a new token. Will overwrite any existing tokens for the given login url
--skip-infer Skip any attempts to infer which version of Turbo the project is configured to use
--no-update-notifier Disable the turbo update notification
--api <API> Override the endpoint for API calls
--color Force color usage in the terminal
--cpuprofile <CPU_PROFILE> Specify a file to save a cpu profile
--cwd <CWD> The directory in which to run turbo
--heap <HEAP> Specify a file to save a pprof heap profile
--login <LOGIN> Override the login endpoint
--no-color Suppress color usage in the terminal
--preflight When enabled, turbo will precede HTTP requests with an OPTIONS request for authorization
--remote-cache-timeout <TIMEOUT> Set a timeout for all HTTP requests
--team <TEAM> Set the team slug for API calls
--token <TOKEN> Set the auth token for API calls
--trace <TRACE> Specify a file to save a pprof trace
--verbosity <COUNT> Verbosity level
-h, --help Print help
Test help flag for logout command
$ ${TURBO} logout -h
Logout to your Vercel account
Usage: turbo(\.exe)? logout \[OPTIONS\] (re)
Options:
--invalidate Invalidate the token on the server
--version
--skip-infer Skip any attempts to infer which version of Turbo the project is configured to use
--no-update-notifier Disable the turbo update notification
--api <API> Override the endpoint for API calls
--color Force color usage in the terminal
--cpuprofile <CPU_PROFILE> Specify a file to save a cpu profile
--cwd <CWD> The directory in which to run turbo
--heap <HEAP> Specify a file to save a pprof heap profile
--login <LOGIN> Override the login endpoint
--no-color Suppress color usage in the terminal
--preflight When enabled, turbo will precede HTTP requests with an OPTIONS request for authorization
--remote-cache-timeout <TIMEOUT> Set a timeout for all HTTP requests
--team <TEAM> Set the team slug for API calls
--token <TOKEN> Set the auth token for API calls
--trace <TRACE> Specify a file to save a pprof trace
--verbosity <COUNT> Verbosity level
-h, --help Print help