-
Notifications
You must be signed in to change notification settings - Fork 10
/
invoking.html
562 lines (540 loc) · 29.4 KB
/
invoking.html
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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
<!DOCTYPE html>
<html lang="en">
<!--
Copyright 2014 Pants project contributors (see CONTRIBUTORS.md).
Licensed under the Apache License, Version 2.0 (see LICENSE).
-->
<head>
<meta charset="utf-8"/>
<title>Invoking Pants</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="pants-logo.ico">
<!-- In case this is a "test publish", tell search engines where real version lives: -->
<link rel="canonical" href="http://pantsbuild.org/invoking.html">
<link rel="stylesheet" href="bootstrap-custom.min.css">
<link rel="stylesheet" href="bootstrap-custom-theme.min.css">
<link rel="stylesheet" href="docsite.css">
</head>
<body>
<div class="header">
<nav class="navbar navbar-default navbar-static-top">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand navbar-brand-img" href="index.html">
<img src="pants-logo.ico" alt="[pantsbuild logo]">
</a>
<a class="navbar-brand" href="index.html">
Pants v1
</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="/">Docs</a></li>
<li><a href="community.html">Community</a></li>
<li><a href="https://www.github.com/pantsbuild/pants">GitHub</a></li>
<li>
<form class="navbar-form navbar-left search" role="search" action="https://www.google.com/search">
<div class="form-group">
<input type="text" name="as_q" class="form-control query" placeholder="Search">
<input name="as_sitesearch" value="pantsbuild.org" type="hidden">
</div>
</form>
</li>
</ul>
</div><!--/.nav-collapse -->
</div>
<div class="deprecated">Pants v1 is no longer maintained. See <a href="https://www.pantsbuild.org/">here</a> for the Pants v2 documentation.</div>
</nav>
</div>
<div class="page">
<div class="container-fluid">
<div class="row">
<div class="col-md-1">
</div>
<div class="col-md-2">
<div class="site-toc">
<ul>
<li class="toc-h1 toc-heading">
Getting Started
</li>
<li class="toc-h1 toc-link ">
<a href="install.html">Installing Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="setup_repo.html">Setting Up Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="first_tutorial.html">Tutorial</a>
</li>
<li class="toc-h1 toc-link ">
<a href="common_tasks.html">Common Tasks</a>
</li>
<li class="toc-h1 toc-link ">
<a href="orgs.html">Pants for Organizations</a>
</li>
<li class="toc-h1 toc-heading">
Pants Basics
</li>
<li class="toc-h1 toc-link ">
<a href="why_use_pants.html">Why Use Pants?</a>
</li>
<li class="toc-h1 toc-link ">
<a href="first_concepts.html">Pants Concepts</a>
</li>
<li class="toc-h1 toc-link ">
<a href="build_files.html">BUILD files</a>
</li>
<li class="toc-h1 toc-link ">
<a href="target_addresses.html">Target Addresses</a>
</li>
<li class="toc-h1 toc-link ">
<a href="3rdparty.html">Third-Party Dependencies</a>
</li>
<li class="toc-h1 toc-link ">
<a href="options.html">Pants Options</a>
</li>
<li class="toc-h1 toc-link toc-here">
Invoking Pants
</li>
<li class="toc-h1 toc-link ">
<a href="reporting_server.html">Reporting Server</a>
</li>
<li class="toc-h1 toc-link ">
<a href="ide_support.html">IDE Support</a>
</li>
<li class="toc-h1">
<a class="sidebar-nav-heading" class="toc-drop" data-toggle="collapse" href="#JVM-Support" aria-expanded="false" aria-controls="JVM-Support">JVM Support<span class="caret"></span></a>
<ul class="collapse sidebar-nav sidebar-submenu" id="JVM-Support">
<li class="toc-h1 toc-link ">
<a href="jvm_projects.html">JVM Projects with Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="3rdparty_jvm.html">JVM Dependency Management</a>
</li>
<li class="toc-h1 toc-link ">
<a href="scala.html">Scala Support</a>
</li>
<li class="toc-h1 toc-link ">
<a href="publish.html">Publishing Artifacts</a>
</li>
<li class="toc-h1 toc-link ">
<a href="from_maven.html">Pants for Maven Experts</a>
</li>
</ul>
</li>
<li class="toc-h1">
<a class="sidebar-nav-heading" class="toc-drop" data-toggle="collapse" href="#Python-Support" aria-expanded="false" aria-controls="Python-Support">Python Support<span class="caret"></span></a>
<ul class="collapse sidebar-nav sidebar-submenu" id="Python-Support">
<li class="toc-h1 toc-link ">
<a href="python_readme.html">Python Projects with Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="3rdparty_py.html">Python 3rdparty Pattern</a>
</li>
</ul>
</li>
<li class="toc-h1 toc-link ">
<a href="go_readme.html">Go support for Pants</a>
</li>
<li class="toc-h1 toc-link ">
<a href="node_readme.html">Node.js Support</a>
</li>
<li class="toc-h1 toc-heading">
Code & Doc Generation
</li>
<li class="toc-h1 toc-link ">
<a href="thrift_deps.html">Thrift</a>
</li>
<li class="toc-h1 toc-link ">
<a href="grpcio_gen.html">Python gRPC + protobufs</a>
</li>
<li class="toc-h1 toc-link ">
<a href="page.html">Markdown</a>
</li>
<li class="toc-h1 toc-heading">
Getting Help
</li>
<li class="toc-h1 toc-link ">
<a href="tshoot.html">Troubleshooting</a>
</li>
<li class="toc-h1 toc-link ">
<a href="community.html">Community</a>
</li>
<li class="toc-h1 toc-heading">
Reference
</li>
<li class="toc-h1 toc-link ">
<a href="build_dictionary.html">Pants BUILD Dictionary</a>
</li>
<li class="toc-h1 toc-link ">
<a href="options_reference.html">Pants Reference</a>
</li>
<li class="toc-h1">
<a class="sidebar-nav-heading" class="toc-drop" data-toggle="collapse" href="#Release-Notes" aria-expanded="false" aria-controls="Release-Notes">Release Notes<span class="caret"></span></a>
<ul class="collapse sidebar-nav sidebar-submenu" id="Release-Notes">
<li class="toc-h1 toc-link ">
<a href="notes-1.30.x.html">1.30.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.29.x.html">1.29.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.28.x.html">1.28.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.27.x.html">1.27.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.26.x.html">1.26.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.25.x.html">1.25.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.24.x.html">1.24.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.23.x.html">1.23.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.22.x.html">1.22.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.21.x.html">1.21.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.20.x.html">1.20.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.19.x.html">1.19.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.18.x.html">1.18.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.17.x.html">1.17.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.16.x.html">1.16.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.15.x.html">1.15.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.14.x.html">1.14.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.13.x.html">1.13.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.12.x.html">1.12.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.11.x.html">1.11.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.10.x.html">1.10.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.9.x.html">1.9.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.8.x.html">1.8.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.7.x.html">1.7.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.6.x.html">1.6.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.5.x.html">1.5.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.4.x.html">1.4.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.3.x.html">1.3.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.2.x.html">1.2.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.1.x.html">1.1.x Stable Releases</a>
</li>
<li class="toc-h1 toc-link ">
<a href="notes-1.0.x.html">1.0.x Stable Releases</a>
</li>
</ul>
</li>
<li class="toc-h1 toc-heading">
Developer
</li>
<li class="toc-h1 toc-link ">
<a href="dev.html">Pants Developer Center</a>
</li>
<li class="toc-h1 toc-link ">
<a href="export.html">Export Format</a>
</li>
<li class="toc-h1 toc-link ">
<a href="architecture.html">Architecture</a>
</li>
<li class="toc-h1 toc-heading">
Blogs
</li>
<li class="toc-h1 toc-link ">
<a href="coursier_migration.html">Twitter's Coursier Migration</a>
</li>
</ul>
</div> <!-- site-toc -->
</div>
<div class="col-md-8">
<div class="content">
<div class="mainflow">
<nav class="pagetoc">
<ul>
<li class="toc-h1"><a href="#order-of-arguments">Order of Arguments</a></li>
<li class="toc-h1"><a href="#how-to-use-shorthand-flags">How to Use Shorthand Flags</a></li>
<li class="toc-h1"><a href="#passthrough-args">Passthrough Args</a></li>
<li class="toc-h1"><a href="#the-pants-daemon-pantsd">The Pants Daemon (pantsd)</a></li>
<li class="toc-h2"><a href="#benefits">Benefits</a></li>
<li class="toc-h2"><a href="#caveats">Caveats</a></li>
<li class="toc-h2"><a href="#usage">Usage</a></li>
<li class="toc-h3"><a href="#killing-the-daemon">Killing the Daemon</a></li>
<li class="toc-h3"><a href="#observation-tools">Observation Tools</a></li>
<li class="toc-h2"><a href="#rollout">Rollout</a></li>
<li class="toc-h1"><a href="#profiling-pants">Profiling Pants</a></li>
</ul>
</nav>
<!-- main content start -->
<!-- generated by pants! -->
<style>
.codehilite .hll { background-color: #ffffcc }
.codehilite { background: #f0f0f0; }
.codehilite .c { color: #60a0b0; font-style: italic } /* Comment */
.codehilite .err { border: 1px solid #FF0000 } /* Error */
.codehilite .k { color: #007020; font-weight: bold } /* Keyword */
.codehilite .o { color: #666666 } /* Operator */
.codehilite .ch { color: #60a0b0; font-style: italic } /* Comment.Hashbang */
.codehilite .cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */
.codehilite .cp { color: #007020 } /* Comment.Preproc */
.codehilite .cpf { color: #60a0b0; font-style: italic } /* Comment.PreprocFile */
.codehilite .c1 { color: #60a0b0; font-style: italic } /* Comment.Single */
.codehilite .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */
.codehilite .gd { color: #A00000 } /* Generic.Deleted */
.codehilite .ge { font-style: italic } /* Generic.Emph */
.codehilite .gr { color: #FF0000 } /* Generic.Error */
.codehilite .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.codehilite .gi { color: #00A000 } /* Generic.Inserted */
.codehilite .go { color: #888888 } /* Generic.Output */
.codehilite .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.codehilite .gs { font-weight: bold } /* Generic.Strong */
.codehilite .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.codehilite .gt { color: #0044DD } /* Generic.Traceback */
.codehilite .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.codehilite .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.codehilite .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.codehilite .kp { color: #007020 } /* Keyword.Pseudo */
.codehilite .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.codehilite .kt { color: #902000 } /* Keyword.Type */
.codehilite .m { color: #40a070 } /* Literal.Number */
.codehilite .s { color: #4070a0 } /* Literal.String */
.codehilite .na { color: #4070a0 } /* Name.Attribute */
.codehilite .nb { color: #007020 } /* Name.Builtin */
.codehilite .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.codehilite .no { color: #60add5 } /* Name.Constant */
.codehilite .nd { color: #555555; font-weight: bold } /* Name.Decorator */
.codehilite .ni { color: #d55537; font-weight: bold } /* Name.Entity */
.codehilite .ne { color: #007020 } /* Name.Exception */
.codehilite .nf { color: #06287e } /* Name.Function */
.codehilite .nl { color: #002070; font-weight: bold } /* Name.Label */
.codehilite .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.codehilite .nt { color: #062873; font-weight: bold } /* Name.Tag */
.codehilite .nv { color: #bb60d5 } /* Name.Variable */
.codehilite .ow { color: #007020; font-weight: bold } /* Operator.Word */
.codehilite .w { color: #bbbbbb } /* Text.Whitespace */
.codehilite .mb { color: #40a070 } /* Literal.Number.Bin */
.codehilite .mf { color: #40a070 } /* Literal.Number.Float */
.codehilite .mh { color: #40a070 } /* Literal.Number.Hex */
.codehilite .mi { color: #40a070 } /* Literal.Number.Integer */
.codehilite .mo { color: #40a070 } /* Literal.Number.Oct */
.codehilite .sa { color: #4070a0 } /* Literal.String.Affix */
.codehilite .sb { color: #4070a0 } /* Literal.String.Backtick */
.codehilite .sc { color: #4070a0 } /* Literal.String.Char */
.codehilite .dl { color: #4070a0 } /* Literal.String.Delimiter */
.codehilite .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.codehilite .s2 { color: #4070a0 } /* Literal.String.Double */
.codehilite .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.codehilite .sh { color: #4070a0 } /* Literal.String.Heredoc */
.codehilite .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.codehilite .sx { color: #c65d09 } /* Literal.String.Other */
.codehilite .sr { color: #235388 } /* Literal.String.Regex */
.codehilite .s1 { color: #4070a0 } /* Literal.String.Single */
.codehilite .ss { color: #517918 } /* Literal.String.Symbol */
.codehilite .bp { color: #007020 } /* Name.Builtin.Pseudo */
.codehilite .fm { color: #06287e } /* Name.Function.Magic */
.codehilite .vc { color: #bb60d5 } /* Name.Variable.Class */
.codehilite .vg { color: #bb60d5 } /* Name.Variable.Global */
.codehilite .vi { color: #bb60d5 } /* Name.Variable.Instance */
.codehilite .vm { color: #bb60d5 } /* Name.Variable.Magic */
.codehilite .il { color: #40a070 } /* Literal.Number.Integer.Long */
</style>
<h1 id="invoking-pants">Invoking Pants</h1>
<p>This page discusses advanced usage when invoking Pants on the command line.
We assume you already know the <a href="first_tutorial.html">basic command-line structure</a>.</p>
<ul>
<li>For details on how to specify target addresses, see <a href="target_addresses.html">Target Addresses</a>.</li>
<li>For details on how to specify options, see <a href="options.html">Options</a>.</li>
<li>For a list of Pants' goals and their options, see the <a href="options_reference.html">Options Reference</a>.</li>
</ul>
<h2 id="order-of-arguments">Order of Arguments</h2>
<p>A simple Pants command line looks like <code>./pants goal target</code>. E.g., <code>./pants compile src/java/::</code>.</p>
<p>The full command line specification is:</p>
<div class="codehilite"><pre><span></span>./pants <global and fully-qualified flags> <span class="se">\</span>
<goal1.task1> <shorthand flags <span class="k">for</span> task1> <span class="se">\</span>
<goal2.task2> <shorthand flags <span class="k">for</span> task2> <span class="se">\</span>
... <span class="se">\</span>
<target1> <target2> ... <span class="o">[</span>-- passthrough options <span class="k">for</span> last goal<span class="o">]</span>
</pre></div>
<p>Fully qualified flags can be passed anywhere on the command line
before the <code>--</code> separator for passthrough args, but
shorthand flags must immediately follow the goal they apply to.</p>
<p>Consider the following command:</p>
<div class="codehilite"><pre><span></span>./pants --level<span class="o">=</span>debug compile.rsc --no-delete-scratch --resolve-ivy-open src::
</pre></div>
<ul>
<li><code>--level</code> is a global flag.</li>
<li>The goal and task to run are <code>compile.rsc</code>.</li>
<li>The <code>--no-delete-scratch</code> is shorthand for the
<code>--compile-rsc-no-delete-scratch</code> flag.</li>
<li>The <code>--resolve-ivy-open</code> command is a fully qualified flag and
applies to the <code>resolve.ivy</code> task. Although the task <code>resolve.ivy</code>
isn't specified on the command line it implicitly runs because
<code>compile.rsc</code> task depends on it.</li>
</ul>
<p>You can pass options to pants using the a config file, the
environment, or command line flags. See the
<a href="options.html">Options</a> page for more details.</p>
<h2 id="how-to-use-shorthand-flags">How to Use Shorthand Flags</h2>
<p>Either fully qualified or shorthand flags can be used to pass an
option to a task. The fully qualified (or long form) options are
listed in the <code>help</code> output and the <a href="options_reference.html">Options Reference</a>.
The long form is more foolproof to use because it can go almost anywhere on
the command line, but the shorthand version can save typing.</p>
<p>For many goals, there is only a single task registered. For example,
to specify the <code>--list-sep</code> option for the <code>list</code> goal you could use
the long form:</p>
<div class="codehilite"><pre><span></span>./pants list --list-sep<span class="o">=</span><span class="s1">'|'</span> examples/src/python/example:
</pre></div>
<p>or you could use the short form:</p>
<div class="codehilite"><pre><span></span>./pants list --sep<span class="o">=</span><span class="s1">'|'</span> examples/src/python/example:
</pre></div>
<p>When a goal has multiple tasks registered, you must fully specify the
task and goal name to use the short form flag. Here's an example of
using the long form to pass an option to the <code>zinc</code> task:</p>
<div class="codehilite"><pre><span></span>./pants --no-compile-rsc-delete-scratch compile src::
</pre></div>
<p>To use the shorthand form of the option, specify both goal and task
name as <code>compile.rsc</code>:</p>
<div class="codehilite"><pre><span></span>./pants compile.rsc --no-delete-scratch src::
</pre></div>
<p>This is especially handy if you have lots of options to type:</p>
<div class="codehilite"><pre><span></span>./pants publish.jar --named-snapshot<span class="o">=</span><span class="m">1</span>.2.3-SNAPSHOT --no-dryrun --force src/java::
</pre></div>
<p>You can use shorthand even when you want to pass options to multiple
tasks by listing each task. For example:</p>
<div class="codehilite"><pre><span></span>./pants compile --compile-rsc-no-delete-scratch --resolve-ivy-open src::
</pre></div>
<p>can also be expressed using shorthand flags:</p>
<div class="codehilite"><pre><span></span>./pants --level<span class="o">=</span>debug compile.rsc --no-delete-scratch resolve.ivy --open src::
</pre></div>
<h2 id="passthrough-args">Passthrough Args</h2>
<p>In some cases Pants allows you to pass arguments directly through to the underlying tool it invokes.
These are specified last on the command line after a double-hyphen, and are passed through the
last goal specified.</p>
<p>E.g., to pass <code>-k foo</code> to <code>pytest</code> (to say "only run tests whose names contain <code>foo</code>"):</p>
<div class="codehilite"><pre><span></span>./pants test.pytest tests/python/pants_test/tasks -- -k foo
</pre></div>
<p>You can use <code>test</code> instead of <code>test.pytest</code> above; Pants then applies the passthrough args
through all tasks in <code>test</code> that support them. In this case, it would pass them to JUnit as well.
So it only makes sense to do this if you know that JUnit won't be invoked in practice (because
you're not invoking Pants on any Java tests).</p>
<h2 id="the-pants-daemon-pantsd">The Pants Daemon (pantsd)</h2>
<p>The <code>1.3.0</code> release of pants included an alpha release of a daemon (<code>pantsd</code>) to accelerate common
graph operations including build file parsing and source fingerprinting. As of the <code>1.4.0</code> release,
we now consider the daemon to be of late beta quality: it's nearly ready to be enabled by default!</p>
<h3 id="benefits">Benefits</h3>
<p>The daemon caches many filesystem operations run over run, and uses watchman to invalidate that
cache. This can significantly improve the performance of incremental and noop builds (ie,
cases where relatively small portions of the repo have changed since the previous build).</p>
<h3 id="caveats">Caveats</h3>
<p>As of <code>1.4.0</code>, there is one remaining set of caveats to using the daemon:</p>
<ul>
<li>Although <code>./pants repl</code> works, it is missing some advanced TTY integrations which prevent line
editing and some control sequences from being propagated. Ammonite in particular has a known issue
-- see <a href="https://github.com/pantsbuild/pants/issues/5223">#5223</a>.</li>
</ul>
<h3 id="usage">Usage</h3>
<p>To enable the daemon, turn on the <code>--enable-pantsd</code> global option via CLI arg, environment variable, or <code>pants.toml</code> (see <a href="options.html">Options</a>).</p>
<h4 id="killing-the-daemon">Killing the Daemon</h4>
<p>To kill the daemon, you can run either <code>clean-all</code> or <code>kill-pantsd</code>:</p>
<div class="codehilite"><pre><span></span>./pants clean-all
./pants kill-pantsd
</pre></div>
<h4 id="observation-tools">Observation Tools</h4>
<p>To see what's going on with the daemon, you can tail the pantsd log file in another window:</p>
<div class="codehilite"><pre><span></span><span class="nb">cd</span> <span class="nv">$SOURCE</span>
tail -F .pants.d/pantsd/pantsd.log
</pre></div>
<p>To see what's going on with the client and daemon processes, you can watch the process table:</p>
<div class="codehilite"><pre><span></span>watch -n.1 <span class="s2">"ps -ef | grep -v grep | grep pants"</span>
</pre></div>
<h3 id="rollout">Rollout</h3>
<p>The daemon will be in beta until the caveat mentioned above is addressed, but we hope to
enable the daemon by default soon.</p>
<h2 id="profiling-pants">Profiling Pants</h2>
<p>There are three environment variables that profile various parts of a pants run.</p>
<ul>
<li><code>PANTS_PROFILE</code> - Covers the entire run when pantsd is disabled, or the post-fork portion
of a pantsd run.</li>
<li><code>PANTSC_PROFILE</code> - Covers the client in a pantsd run, which connects to pantsd and then
communicates on the socket until the run completes.</li>
<li><code>PANTSD_PROFILE</code> - Covers the graph warming operations pre-fork in a pantsd run.</li>
</ul>
<p>To enable profiling, set the relevant environment variable to a path to write a profile to, and
then run pants:</p>
<div class="codehilite"><pre><span></span><span class="nv">PANTS_PROFILE</span><span class="o">=</span>myprofile.prof ./pants ..
</pre></div>
<p>Once you have a profile file, you can use any visualizer that supports python profiles, such as
<code>snakeviz</code> or <code>gprof2dot</code>.</p>
<!-- main content end -->
<div class="generated">
Generated by <a href="docs.html">publish_docs</a>
from dist/markdown/html/src/docs/invoking.html 2022-12-03T01:08:59.554157
</div>
</div> <!-- mainflow -->
</div> <!-- content -->
</div>
<div class="col-md-1">
</div>
</div> <!-- row -->
</div> <!-- container-fluid -->
</div> <!-- page -->
<script src="https://code.jquery.com/jquery-2.2.3.min.js" integrity="sha384-I6F5OKECLVtK/BL+8iSLDEHowSAfUo76ZL9+kGAgTRdiByINKJaqTPH/QVNS1VDb" crossorigin="anonymous"></script>
<script src="bootstrap-custom.min.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-78111411-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>