-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Expand file tree
/
Copy pathindex.html
More file actions
1878 lines (1690 loc) · 127 KB
/
Copy pathindex.html
File metadata and controls
1878 lines (1690 loc) · 127 KB
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
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>ADK CLI documentation — ADK CLI 1.33.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
<script src="_static/documentation_options.js?v=aad71706"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<!-- Google Analytics tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-DKHZS27PHP"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-DKHZS27PHP');
</script>
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="adk-cli-documentation">
<h1>ADK CLI documentation<a class="headerlink" href="#adk-cli-documentation" title="Link to this heading">¶</a></h1>
<p>This page contains the auto-generated command-line reference for ADK 1.33.0.</p>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#adk" id="id21">adk</a></p>
<ul>
<li><p><a class="reference internal" href="#adk-api-server" id="id22">api_server</a></p></li>
<li><p><a class="reference internal" href="#adk-conformance" id="id23">conformance</a></p></li>
<li><p><a class="reference internal" href="#adk-create" id="id24">create</a></p></li>
<li><p><a class="reference internal" href="#adk-deploy" id="id25">deploy</a></p></li>
<li><p><a class="reference internal" href="#adk-eval" id="id26">eval</a></p></li>
<li><p><a class="reference internal" href="#adk-eval-set" id="id27">eval_set</a></p></li>
<li><p><a class="reference internal" href="#adk-migrate" id="id28">migrate</a></p></li>
<li><p><a class="reference internal" href="#adk-optimize" id="id29">optimize</a></p></li>
<li><p><a class="reference internal" href="#adk-run" id="id30">run</a></p></li>
<li><p><a class="reference internal" href="#adk-web" id="id31">web</a></p></li>
</ul>
</li>
</ul>
</nav>
<section id="adk">
<h2><a class="toc-backref" href="#id21" role="doc-backlink">adk</a><a class="headerlink" href="#adk" title="Link to this heading">¶</a></h2>
<p>Agent Development Kit CLI tools.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>adk<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>COMMAND<span class="w"> </span><span class="o">[</span>ARGS<span class="o">]</span>...
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-version">
<span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-version" title="Link to this definition">¶</a></dt>
<dd><p>Show the version and exit.</p>
</dd></dl>
<section id="adk-api-server">
<h3><a class="toc-backref" href="#id22" role="doc-backlink">api_server</a><a class="headerlink" href="#adk-api-server" title="Link to this heading">¶</a></h3>
<p>Starts a FastAPI server for agents.</p>
<p>AGENTS_DIR: The directory of agents, where each subdirectory is a single
agent, containing at least <cite>__init__.py</cite> and <cite>agent.py</cite> files.</p>
<p>Example:</p>
<blockquote>
<div><p>adk api_server –session_service_uri=[uri] –port=[port] path/to/agents_dir</p>
</div></blockquote>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>adk<span class="w"> </span>api_server<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span><span class="o">[</span>AGENTS_DIR<span class="o">]</span>
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-enable_features">
<span class="sig-name descname"><span class="pre">--enable_features</span></span><span class="sig-prename descclassname"> <span class="pre"><enable_features></span></span><a class="headerlink" href="#cmdoption-adk-api_server-enable_features" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Comma-separated list of feature names to enable. This provides an alternative to environment variables for enabling experimental features. Example: –enable_features=JSON_SCHEMA_FOR_FUNC_DECL,PROGRESSIVE_SSE_STREAMING</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-disable_features">
<span class="sig-name descname"><span class="pre">--disable_features</span></span><span class="sig-prename descclassname"> <span class="pre"><disable_features></span></span><a class="headerlink" href="#cmdoption-adk-api_server-disable_features" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Comma-separated list of feature names to disable. This provides an alternative to environment variables for disabling features. Example: –disable_features=JSON_SCHEMA_FOR_FUNC_DECL,PROGRESSIVE_SSE_STREAMING</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-host">
<span class="sig-name descname"><span class="pre">--host</span></span><span class="sig-prename descclassname"> <span class="pre"><host></span></span><a class="headerlink" href="#cmdoption-adk-api_server-host" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The binding host of the server</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">'127.0.0.1'</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-port">
<span class="sig-name descname"><span class="pre">--port</span></span><span class="sig-prename descclassname"> <span class="pre"><port></span></span><a class="headerlink" href="#cmdoption-adk-api_server-port" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The port of the server</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-allow_origins">
<span class="sig-name descname"><span class="pre">--allow_origins</span></span><span class="sig-prename descclassname"> <span class="pre"><allow_origins></span></span><a class="headerlink" href="#cmdoption-adk-api_server-allow_origins" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Origins to allow for CORS. Can be literal origins (e.g., ‘<a class="reference external" href="https://example.com">https://example.com</a>’) or regex patterns prefixed with ‘regex:’ (e.g., ‘regex:https://.*.example.com’).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-v">
<span id="cmdoption-adk-api_server-verbose"></span><span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--verbose</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-api_server-v" title="Link to this definition">¶</a></dt>
<dd><p>Enable verbose (DEBUG) logging. Shortcut for –log_level DEBUG.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-log_level">
<span class="sig-name descname"><span class="pre">--log_level</span></span><span class="sig-prename descclassname"> <span class="pre"><log_level></span></span><a class="headerlink" href="#cmdoption-adk-api_server-log_level" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Set the logging level</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>DEBUG | INFO | WARNING | ERROR | CRITICAL</p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-trace_to_cloud">
<span class="sig-name descname"><span class="pre">--trace_to_cloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-api_server-trace_to_cloud" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Whether to enable cloud trace for telemetry.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-otel_to_cloud">
<span class="sig-name descname"><span class="pre">--otel_to_cloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-api_server-otel_to_cloud" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Whether to write OTel data to Google Cloud Observability services - Cloud Trace and Cloud Logging.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-reload">
<span id="cmdoption-adk-api_server-no-reload"></span><span class="sig-name descname"><span class="pre">--reload</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--no-reload</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-api_server-reload" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Whether to enable auto reload for server. Not supported for Cloud Run.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-a2a">
<span class="sig-name descname"><span class="pre">--a2a</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-api_server-a2a" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Whether to enable A2A endpoint.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-reload_agents">
<span class="sig-name descname"><span class="pre">--reload_agents</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-api_server-reload_agents" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Whether to enable live reload for agents changes.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-eval_storage_uri">
<span class="sig-name descname"><span class="pre">--eval_storage_uri</span></span><span class="sig-prename descclassname"> <span class="pre"><eval_storage_uri></span></span><a class="headerlink" href="#cmdoption-adk-api_server-eval_storage_uri" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The evals storage URI to store agent evals, supported URIs: gs://<bucket name>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-extra_plugins">
<span class="sig-name descname"><span class="pre">--extra_plugins</span></span><span class="sig-prename descclassname"> <span class="pre"><extra_plugins></span></span><a class="headerlink" href="#cmdoption-adk-api_server-extra_plugins" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Comma-separated list of extra plugin classes or instances to enable (e.g., my.module.MyPluginClass or my.module.my_plugin_instance).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-url_prefix">
<span class="sig-name descname"><span class="pre">--url_prefix</span></span><span class="sig-prename descclassname"> <span class="pre"><url_prefix></span></span><a class="headerlink" href="#cmdoption-adk-api_server-url_prefix" title="Link to this definition">¶</a></dt>
<dd><p>Optional. URL path prefix when the application is mounted behind a reverse proxy or API gateway (e.g., ‘/api/v1’, ‘/adk’). This ensures generated URLs and redirects work correctly when the app is not served at the root path. Must start with ‘/’ if provided.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-trigger_sources">
<span class="sig-name descname"><span class="pre">--trigger_sources</span></span><span class="sig-prename descclassname"> <span class="pre"><trigger_sources></span></span><a class="headerlink" href="#cmdoption-adk-api_server-trigger_sources" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Comma-separated list of trigger sources to enable (e.g., ‘pubsub,eventarc’). Registers /apps/{app_name}/trigger/* endpoints for batch and event-driven agent invocations.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-session_service_uri">
<span class="sig-name descname"><span class="pre">--session_service_uri</span></span><span class="sig-prename descclassname"> <span class="pre"><session_service_uri></span></span><a class="headerlink" href="#cmdoption-adk-api_server-session_service_uri" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The URI of the session service.
If set, ADK uses this service.</p>
<div class="line-block">
<div class="line">If unset, ADK chooses a default session service (see</div>
<div class="line">–use_local_storage).</div>
<div class="line">- Use ‘agentengine://<agent_engine>’ to connect to Agent Engine</div>
<div class="line-block">
<div class="line">sessions. <agent_engine> can either be the full qualified resource</div>
<div class="line">name ‘projects/abc/locations/us-central1/reasoningEngines/123’ or</div>
<div class="line">the resource id ‘123’.</div>
</div>
<div class="line">- Use ‘memory://’ to run with the in-memory session service.</div>
<div class="line">- Use ‘sqlite://<path_to_sqlite_file>’ to connect to a SQLite DB.</div>
<div class="line">- See <a class="reference external" href="https://docs.sqlalchemy.org/en/20/core/engines.html#backend-specific-urls">https://docs.sqlalchemy.org/en/20/core/engines.html#backend-specific-urls</a></div>
<div class="line-block">
<div class="line">for supported database URIs.</div>
</div>
</div>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-artifact_service_uri">
<span class="sig-name descname"><span class="pre">--artifact_service_uri</span></span><span class="sig-prename descclassname"> <span class="pre"><artifact_service_uri></span></span><a class="headerlink" href="#cmdoption-adk-api_server-artifact_service_uri" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The URI of the artifact service.
If set, ADK uses this service.</p>
<div class="line-block">
<div class="line">If unset, ADK chooses a default artifact service (see</div>
<div class="line">–use_local_storage).</div>
<div class="line">- Use ‘gs://<bucket_name>’ to connect to the GCS artifact service.</div>
<div class="line">- Use ‘memory://’ to force the in-memory artifact service.</div>
<div class="line">- Use ‘<a class="reference external" href="file:/">file:/</a>/<path>’ to store artifacts in a custom local directory.</div>
</div>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-use_local_storage">
<span id="cmdoption-adk-api_server-no_use_local_storage"></span><span class="sig-name descname"><span class="pre">--use_local_storage</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--no_use_local_storage</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-api_server-use_local_storage" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Whether to use local .adk storage when –session_service_uri and –artifact_service_uri are unset. Cannot be combined with explicit service URIs. When the agents directory isn’t writable (common in Cloud Run/Kubernetes), ADK falls back to in-memory unless overridden by ADK_FORCE_LOCAL_STORAGE=1 or ADK_DISABLE_LOCAL_STORAGE=1.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">True</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-memory_service_uri">
<span class="sig-name descname"><span class="pre">--memory_service_uri</span></span><span class="sig-prename descclassname"> <span class="pre"><memory_service_uri></span></span><a class="headerlink" href="#cmdoption-adk-api_server-memory_service_uri" title="Link to this definition">¶</a></dt>
<dd><div class="line-block">
<div class="line">Optional. The URI of the memory service.</div>
<div class="line">- Use ‘rag://<rag_corpus_id>’ to connect to Vertex AI Rag Memory Service.</div>
<div class="line">- Use ‘agentengine://<agent_engine>’ to connect to Agent Engine</div>
<div class="line-block">
<div class="line">sessions. <agent_engine> can either be the full qualified resource</div>
<div class="line">name ‘projects/abc/locations/us-central1/reasoningEngines/123’ or</div>
<div class="line">the resource id ‘123’.</div>
</div>
<div class="line">- Use ‘memory://’ to force the in-memory memory service.</div>
</div>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-session_db_url">
<span class="sig-name descname"><span class="pre">--session_db_url</span></span><span class="sig-prename descclassname"> <span class="pre"><session_db_url></span></span><a class="headerlink" href="#cmdoption-adk-api_server-session_db_url" title="Link to this definition">¶</a></dt>
<dd><p>Deprecated. Use –session_service_uri instead.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-artifact_storage_uri">
<span class="sig-name descname"><span class="pre">--artifact_storage_uri</span></span><span class="sig-prename descclassname"> <span class="pre"><artifact_storage_uri></span></span><a class="headerlink" href="#cmdoption-adk-api_server-artifact_storage_uri" title="Link to this definition">¶</a></dt>
<dd><p>Deprecated. Use –artifact_service_uri instead.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-auto_create_session">
<span class="sig-name descname"><span class="pre">--auto_create_session</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-api_server-auto_create_session" title="Link to this definition">¶</a></dt>
<dd><p>Automatically create a session if it doesn’t exist when calling /run.</p>
</dd></dl>
<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-api_server-arg-AGENTS_DIR">
<span class="sig-name descname"><span class="pre">AGENTS_DIR</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-api_server-arg-AGENTS_DIR" title="Link to this definition">¶</a></dt>
<dd><p>Optional argument</p>
</dd></dl>
</section>
<section id="adk-conformance">
<h3><a class="toc-backref" href="#id23" role="doc-backlink">conformance</a><a class="headerlink" href="#adk-conformance" title="Link to this heading">¶</a></h3>
<p>Conformance testing tools for ADK.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>adk<span class="w"> </span>conformance<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>COMMAND<span class="w"> </span><span class="o">[</span>ARGS<span class="o">]</span>...
</pre></div>
</div>
<section id="adk-conformance-record">
<h4>record<a class="headerlink" href="#adk-conformance-record" title="Link to this heading">¶</a></h4>
<p>Generate ADK conformance test YAML files from TestCaseInput specifications.</p>
<p>NOTE: this is work in progress.</p>
<p>This command reads TestCaseInput specifications from input.yaml files,
executes the specified test cases against agents, and generates conformance
test files with recorded agent interactions as test.yaml files.</p>
<p>Expected directory structure:
category/name/input.yaml (TestCaseInput) -> category/name/test.yaml (TestCase)</p>
<p>PATHS: One or more directories containing test case specifications.
If no paths are provided, defaults to ‘tests/’ directory.</p>
<p>Examples:</p>
<p>Use default directory: adk conformance record</p>
<p>Custom directories: adk conformance record tests/core tests/tools</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>adk<span class="w"> </span>conformance<span class="w"> </span>record<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span><span class="o">[</span>PATHS<span class="o">]</span>...<span class="w"> </span><span class="o">{</span>none<span class="p">|</span>sse<span class="p">|</span>bidi<span class="o">}</span>
</pre></div>
</div>
<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-conformance-record-arg-PATHS">
<span class="sig-name descname"><span class="pre">PATHS</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-conformance-record-arg-PATHS" title="Link to this definition">¶</a></dt>
<dd><p>Optional argument(s)</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-conformance-record-arg-STREAMING_MODE">
<span class="sig-name descname"><span class="pre">STREAMING_MODE</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-conformance-record-arg-STREAMING_MODE" title="Link to this definition">¶</a></dt>
<dd><p>Required argument</p>
</dd></dl>
</section>
<section id="adk-conformance-test">
<h4>test<a class="headerlink" href="#adk-conformance-test" title="Link to this heading">¶</a></h4>
<p>Run conformance tests to verify agent behavior consistency.</p>
<p>Validates that agents produce consistent outputs by comparing against recorded
interactions or evaluating live execution results.</p>
<p>PATHS can be any number of folder paths. Each folder can either:
- Contain a spec.yaml file directly (single test case)
- Contain subdirectories with spec.yaml files (multiple test cases)</p>
<p>If no paths are provided, defaults to searching for the ‘tests’ folder.</p>
<p>TEST MODES:</p>
<div class="line-block">
<div class="line">replay : Verifies agent interactions match previously recorded behaviors</div>
<div class="line-block">
<div class="line">exactly. Compares LLM requests/responses and tool calls/results.</div>
</div>
<div class="line">live : Runs evaluation-based verification (not yet implemented)</div>
</div>
<p>DIRECTORY STRUCTURE:</p>
<p>Test cases must follow this structure:</p>
<div class="line-block">
<div class="line">category/</div>
<div class="line-block">
<div class="line">test_name/</div>
<div class="line-block">
<div class="line">spec.yaml # Test specification</div>
<div class="line">generated-recordings.yaml # Recorded interactions (replay mode)</div>
<div class="line">generated-session.yaml # Session data (replay mode)</div>
<div class="line">generated-recordings-sse.yaml # Recorded SSE interactions (replay mode)</div>
<div class="line">generated-session-sse.yaml # SSE Session data (replay mode)</div>
</div>
</div>
</div>
<p>REPORT GENERATION:</p>
<p>Use –generate_report to create a Markdown report of test results.
Use –report_dir to specify where the report should be saved.</p>
<p>EXAMPLES:</p>
<div class="line-block">
<div class="line"># Run all tests in current directory’s ‘tests’ folder</div>
<div class="line">adk conformance test</div>
</div>
<div class="line-block">
<div class="line"># Run tests from specific folders</div>
<div class="line">adk conformance test tests/core tests/tools</div>
</div>
<div class="line-block">
<div class="line"># Run a single test case</div>
<div class="line">adk conformance test tests/core/description_001</div>
</div>
<div class="line-block">
<div class="line"># Run in live mode (when available)</div>
<div class="line">adk conformance test –mode=live tests/core</div>
</div>
<div class="line-block">
<div class="line"># Generate a test report</div>
<div class="line">adk conformance test –generate_report</div>
</div>
<div class="line-block">
<div class="line"># Generate a test report in a specific directory</div>
<div class="line">adk conformance test –generate_report –report_dir=reports</div>
</div>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>adk<span class="w"> </span>conformance<span class="w"> </span><span class="nb">test</span><span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span><span class="o">[</span>PATHS<span class="o">]</span>...
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-conformance-test-mode">
<span class="sig-name descname"><span class="pre">--mode</span></span><span class="sig-prename descclassname"> <span class="pre"><mode></span></span><a class="headerlink" href="#cmdoption-adk-conformance-test-mode" title="Link to this definition">¶</a></dt>
<dd><p>Test mode: ‘replay’ verifies against recorded interactions, ‘live’ runs evaluation-based verification.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">'replay'</span></code></p>
</dd>
<dt class="field-even">Options<span class="colon">:</span></dt>
<dd class="field-even"><p>replay | live</p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-conformance-test-generate_report">
<span class="sig-name descname"><span class="pre">--generate_report</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-conformance-test-generate_report" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Whether to generate a Markdown report of the test results.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-conformance-test-report_dir">
<span class="sig-name descname"><span class="pre">--report_dir</span></span><span class="sig-prename descclassname"> <span class="pre"><report_dir></span></span><a class="headerlink" href="#cmdoption-adk-conformance-test-report_dir" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Directory to store the generated report. Defaults to current directory.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-conformance-test-streaming-mode">
<span class="sig-name descname"><span class="pre">--streaming-mode</span></span><span class="sig-prename descclassname"> <span class="pre"><streaming_mode></span></span><a class="headerlink" href="#cmdoption-adk-conformance-test-streaming-mode" title="Link to this definition">¶</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>None | sse | bidi</p>
</dd>
</dl>
</dd></dl>
<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-conformance-test-arg-PATHS">
<span class="sig-name descname"><span class="pre">PATHS</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-conformance-test-arg-PATHS" title="Link to this definition">¶</a></dt>
<dd><p>Optional argument(s)</p>
</dd></dl>
</section>
</section>
<section id="adk-create">
<h3><a class="toc-backref" href="#id24" role="doc-backlink">create</a><a class="headerlink" href="#adk-create" title="Link to this heading">¶</a></h3>
<p>Creates a new app in the current folder with prepopulated agent template.</p>
<p>APP_NAME: required, the folder of the agent source code.</p>
<p>Example:</p>
<blockquote>
<div><p>adk create path/to/my_app</p>
</div></blockquote>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>adk<span class="w"> </span>create<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>APP_NAME
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-create-model">
<span class="sig-name descname"><span class="pre">--model</span></span><span class="sig-prename descclassname"> <span class="pre"><model></span></span><a class="headerlink" href="#cmdoption-adk-create-model" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The model used for the root agent.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-create-api_key">
<span class="sig-name descname"><span class="pre">--api_key</span></span><span class="sig-prename descclassname"> <span class="pre"><api_key></span></span><a class="headerlink" href="#cmdoption-adk-create-api_key" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The API Key needed to access the model, e.g. Google AI API Key.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-create-project">
<span class="sig-name descname"><span class="pre">--project</span></span><span class="sig-prename descclassname"> <span class="pre"><project></span></span><a class="headerlink" href="#cmdoption-adk-create-project" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The Google Cloud Project for using VertexAI as backend.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-create-region">
<span class="sig-name descname"><span class="pre">--region</span></span><span class="sig-prename descclassname"> <span class="pre"><region></span></span><a class="headerlink" href="#cmdoption-adk-create-region" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The Google Cloud Region for using VertexAI as backend.</p>
</dd></dl>
<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-create-arg-APP_NAME">
<span class="sig-name descname"><span class="pre">APP_NAME</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-create-arg-APP_NAME" title="Link to this definition">¶</a></dt>
<dd><p>Required argument</p>
</dd></dl>
</section>
<section id="adk-deploy">
<h3><a class="toc-backref" href="#id25" role="doc-backlink">deploy</a><a class="headerlink" href="#adk-deploy" title="Link to this heading">¶</a></h3>
<p>Deploys agent to hosted environments.</p>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>adk<span class="w"> </span>deploy<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>COMMAND<span class="w"> </span><span class="o">[</span>ARGS<span class="o">]</span>...
</pre></div>
</div>
<section id="adk-deploy-agent-engine">
<h4>agent_engine<a class="headerlink" href="#adk-deploy-agent-engine" title="Link to this heading">¶</a></h4>
<p>Deploys an agent to Agent Engine.</p>
<p>Example:</p>
<blockquote>
<div><p>
# With Express Mode API Key
adk deploy agent_engine –api_key=[api_key] my_agent</p>
<p>
# With Google Cloud Project and Region
adk deploy agent_engine –project=[project] –region=[region]</p>
<blockquote>
<div><p>–display_name=[app_name] my_agent</p>
</div></blockquote>
</div></blockquote>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>adk<span class="w"> </span>deploy<span class="w"> </span>agent_engine<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>AGENT
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-api_key">
<span class="sig-name descname"><span class="pre">--api_key</span></span><span class="sig-prename descclassname"> <span class="pre"><api_key></span></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-api_key" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The API key to use for Express Mode. If not provided, the API key from the GOOGLE_API_KEY environment variable will be used. It will only be used if GOOGLE_GENAI_USE_VERTEXAI is true. (It will override GOOGLE_API_KEY in the .env file if it exists.)</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-project">
<span class="sig-name descname"><span class="pre">--project</span></span><span class="sig-prename descclassname"> <span class="pre"><project></span></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-project" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Google Cloud project to deploy the agent. It will override GOOGLE_CLOUD_PROJECT in the .env file (if it exists). It will be ignored if api_key is set.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-region">
<span class="sig-name descname"><span class="pre">--region</span></span><span class="sig-prename descclassname"> <span class="pre"><region></span></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-region" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Google Cloud region to deploy the agent. It will override GOOGLE_CLOUD_LOCATION in the .env file (if it exists). It will be ignored if api_key is set.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-staging_bucket">
<span class="sig-name descname"><span class="pre">--staging_bucket</span></span><span class="sig-prename descclassname"> <span class="pre"><staging_bucket></span></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-staging_bucket" title="Link to this definition">¶</a></dt>
<dd><p>Deprecated. This argument is no longer required or used.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-agent_engine_id">
<span class="sig-name descname"><span class="pre">--agent_engine_id</span></span><span class="sig-prename descclassname"> <span class="pre"><agent_engine_id></span></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-agent_engine_id" title="Link to this definition">¶</a></dt>
<dd><p>Optional. ID of the Agent Engine instance to update if it exists (default: None, which means a new instance will be created). If project and region are set, this should be the resource ID, and the corresponding resource name in Agent Engine will be: <cite>projects/{project}/locations/{region}/reasoningEngines/{agent_engine_id}</cite>. If api_key is set, then agent_engine_id is required to be the full resource name (i.e. <cite>projects/*/locations/*/reasoningEngines/*</cite>).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-trace_to_cloud">
<span id="cmdoption-adk-deploy-agent_engine-no-trace_to_cloud"></span><span class="sig-name descname"><span class="pre">--trace_to_cloud</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--no-trace_to_cloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-trace_to_cloud" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Whether to enable Cloud Trace for Agent Engine.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-otel_to_cloud">
<span class="sig-name descname"><span class="pre">--otel_to_cloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-otel_to_cloud" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Whether to enable OpenTelemetry for Agent Engine.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-display_name">
<span class="sig-name descname"><span class="pre">--display_name</span></span><span class="sig-prename descclassname"> <span class="pre"><display_name></span></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-display_name" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Display name of the agent in Agent Engine.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-description">
<span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre"><description></span></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-description" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Description of the agent in Agent Engine.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-adk_app">
<span class="sig-name descname"><span class="pre">--adk_app</span></span><span class="sig-prename descclassname"> <span class="pre"><adk_app></span></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-adk_app" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Python file for defining the ADK application (default: a file named agent_engine_app.py)</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-temp_folder">
<span class="sig-name descname"><span class="pre">--temp_folder</span></span><span class="sig-prename descclassname"> <span class="pre"><temp_folder></span></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-temp_folder" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Temp folder for the generated Agent Engine source files. If the folder already exists, its contents will be removed. (default: a timestamped folder in the current working directory).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-adk_app_object">
<span class="sig-name descname"><span class="pre">--adk_app_object</span></span><span class="sig-prename descclassname"> <span class="pre"><adk_app_object></span></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-adk_app_object" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Python object corresponding to the root ADK agent or app. It can only be <cite>root_agent</cite> or <cite>app</cite>. (default: <cite>root_agent</cite>)</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-env_file">
<span class="sig-name descname"><span class="pre">--env_file</span></span><span class="sig-prename descclassname"> <span class="pre"><env_file></span></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-env_file" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The filepath to the <cite>.env</cite> file for environment variables. (default: the <cite>.env</cite> file in the <cite>agent</cite> directory, if any.)</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-requirements_file">
<span class="sig-name descname"><span class="pre">--requirements_file</span></span><span class="sig-prename descclassname"> <span class="pre"><requirements_file></span></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-requirements_file" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The filepath to the <cite>requirements.txt</cite> file to use. (default: the <cite>requirements.txt</cite> file in the <cite>agent</cite> directory, if any.)</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-absolutize_imports">
<span class="sig-name descname"><span class="pre">--absolutize_imports</span></span><span class="sig-prename descclassname"> <span class="pre"><absolutize_imports></span></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-absolutize_imports" title="Link to this definition">¶</a></dt>
<dd><p>NOTE: This flag is deprecated and will be removed in the future.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-agent_engine_config_file">
<span class="sig-name descname"><span class="pre">--agent_engine_config_file</span></span><span class="sig-prename descclassname"> <span class="pre"><agent_engine_config_file></span></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-agent_engine_config_file" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The filepath to the <cite>.agent_engine_config.json</cite> file to use. The values in this file will be overridden by the values set by other flags. (default: the <cite>.agent_engine_config.json</cite> file in the <cite>agent</cite> directory, if any.)</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-validate-agent-import">
<span id="cmdoption-adk-deploy-agent_engine-no-validate-agent-import"></span><span class="sig-name descname"><span class="pre">--validate-agent-import</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--no-validate-agent-import</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-validate-agent-import" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Validate that the agent module can be imported before deployment. This requires your local environment to have the same dependencies as the deployment environment. (default: disabled)</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-skip-agent-import-validation">
<span class="sig-name descname"><span class="pre">--skip-agent-import-validation</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-skip-agent-import-validation" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Skip pre-deployment import validation of <cite>agent.py</cite>. This is the default; use –validate-agent-import to enable validation.</p>
</dd></dl>
<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-agent_engine-arg-AGENT">
<span class="sig-name descname"><span class="pre">AGENT</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-deploy-agent_engine-arg-AGENT" title="Link to this definition">¶</a></dt>
<dd><p>Required argument</p>
</dd></dl>
</section>
<section id="adk-deploy-cloud-run">
<h4>cloud_run<a class="headerlink" href="#adk-deploy-cloud-run" title="Link to this heading">¶</a></h4>
<p>Deploys an agent to Cloud Run.</p>
<p>AGENT: The path to the agent source code folder.</p>
<p>Use ‘–’ to separate gcloud arguments from adk arguments.</p>
<p>Examples:</p>
<blockquote>
<div><p>adk deploy cloud_run –project=[project] –region=[region] path/to/my_agent</p>
<dl class="simple">
<dt>adk deploy cloud_run –project=[project] –region=[region] path/to/my_agent</dt><dd><p>– –no-allow-unauthenticated –min-instances=2</p>
</dd>
</dl>
</div></blockquote>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>adk<span class="w"> </span>deploy<span class="w"> </span>cloud_run<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>AGENT
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-project">
<span class="sig-name descname"><span class="pre">--project</span></span><span class="sig-prename descclassname"> <span class="pre"><project></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-project" title="Link to this definition">¶</a></dt>
<dd><p>Required. Google Cloud project to deploy the agent. When absent, default project from gcloud config is used.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-region">
<span class="sig-name descname"><span class="pre">--region</span></span><span class="sig-prename descclassname"> <span class="pre"><region></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-region" title="Link to this definition">¶</a></dt>
<dd><p>Required. Google Cloud region to deploy the agent. When absent, gcloud run deploy will prompt later.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-service_name">
<span class="sig-name descname"><span class="pre">--service_name</span></span><span class="sig-prename descclassname"> <span class="pre"><service_name></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-service_name" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The service name to use in Cloud Run (default: ‘adk-default-service-name’).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-app_name">
<span class="sig-name descname"><span class="pre">--app_name</span></span><span class="sig-prename descclassname"> <span class="pre"><app_name></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-app_name" title="Link to this definition">¶</a></dt>
<dd><p>Optional. App name of the ADK API server (default: the folder name of the AGENT source code).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-port">
<span class="sig-name descname"><span class="pre">--port</span></span><span class="sig-prename descclassname"> <span class="pre"><port></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-port" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The port of the ADK API server (default: 8000).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-trace_to_cloud">
<span class="sig-name descname"><span class="pre">--trace_to_cloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-trace_to_cloud" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Whether to enable Cloud Trace export for Cloud Run deployments.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-otel_to_cloud">
<span class="sig-name descname"><span class="pre">--otel_to_cloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-otel_to_cloud" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Whether to enable OpenTelemetry export to GCP for Cloud Run deployments.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-with_ui">
<span class="sig-name descname"><span class="pre">--with_ui</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-with_ui" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Deploy ADK Web UI if set. (default: deploy ADK API server only). WARNING: The web UI is for development and testing only — do not use in production.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-temp_folder">
<span class="sig-name descname"><span class="pre">--temp_folder</span></span><span class="sig-prename descclassname"> <span class="pre"><temp_folder></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-temp_folder" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Temp folder for the generated Cloud Run source files (default: a timestamped folder in the system temp directory).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-log_level">
<span class="sig-name descname"><span class="pre">--log_level</span></span><span class="sig-prename descclassname"> <span class="pre"><log_level></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-log_level" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Set the logging level</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>DEBUG | INFO | WARNING | ERROR | CRITICAL</p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-verbosity">
<span class="sig-name descname"><span class="pre">--verbosity</span></span><span class="sig-prename descclassname"> <span class="pre"><verbosity></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-verbosity" title="Link to this definition">¶</a></dt>
<dd><p>Deprecated. Use –log_level instead.</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>DEBUG | INFO | WARNING | ERROR | CRITICAL</p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-adk_version">
<span class="sig-name descname"><span class="pre">--adk_version</span></span><span class="sig-prename descclassname"> <span class="pre"><adk_version></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-adk_version" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The ADK version used in Cloud Run deployment. (default: the version in the dev environment)</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">'1.33.0'</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-a2a">
<span class="sig-name descname"><span class="pre">--a2a</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-a2a" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Whether to enable A2A endpoint.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-trigger_sources">
<span class="sig-name descname"><span class="pre">--trigger_sources</span></span><span class="sig-prename descclassname"> <span class="pre"><trigger_sources></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-trigger_sources" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Comma-separated list of trigger sources to enable (e.g., ‘pubsub,eventarc’). Registers /trigger/* endpoints for batch and event-driven agent invocations.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-allow_origins">
<span class="sig-name descname"><span class="pre">--allow_origins</span></span><span class="sig-prename descclassname"> <span class="pre"><allow_origins></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-allow_origins" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Origins to allow for CORS. Can be literal origins (e.g., ‘<a class="reference external" href="https://example.com">https://example.com</a>’) or regex patterns prefixed with ‘regex:’ (e.g., ‘regex:https://.*.example.com’).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-session_service_uri">
<span class="sig-name descname"><span class="pre">--session_service_uri</span></span><span class="sig-prename descclassname"> <span class="pre"><session_service_uri></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-session_service_uri" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The URI of the session service.
If set, ADK uses this service.</p>
<div class="line-block">
<div class="line">If unset, ADK chooses a default session service (see</div>
<div class="line">–use_local_storage).</div>
<div class="line">- Use ‘agentengine://<agent_engine>’ to connect to Agent Engine</div>
<div class="line-block">
<div class="line">sessions. <agent_engine> can either be the full qualified resource</div>
<div class="line">name ‘projects/abc/locations/us-central1/reasoningEngines/123’ or</div>
<div class="line">the resource id ‘123’.</div>
</div>
<div class="line">- Use ‘memory://’ to run with the in-memory session service.</div>
<div class="line">- Use ‘sqlite://<path_to_sqlite_file>’ to connect to a SQLite DB.</div>
<div class="line">- See <a class="reference external" href="https://docs.sqlalchemy.org/en/20/core/engines.html#backend-specific-urls">https://docs.sqlalchemy.org/en/20/core/engines.html#backend-specific-urls</a></div>
<div class="line-block">
<div class="line">for supported database URIs.</div>
</div>
</div>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-artifact_service_uri">
<span class="sig-name descname"><span class="pre">--artifact_service_uri</span></span><span class="sig-prename descclassname"> <span class="pre"><artifact_service_uri></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-artifact_service_uri" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The URI of the artifact service.
If set, ADK uses this service.</p>
<div class="line-block">
<div class="line">If unset, ADK chooses a default artifact service (see</div>
<div class="line">–use_local_storage).</div>
<div class="line">- Use ‘gs://<bucket_name>’ to connect to the GCS artifact service.</div>
<div class="line">- Use ‘memory://’ to force the in-memory artifact service.</div>
<div class="line">- Use ‘<a class="reference external" href="file:/">file:/</a>/<path>’ to store artifacts in a custom local directory.</div>
</div>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-use_local_storage">
<span id="cmdoption-adk-deploy-cloud_run-no_use_local_storage"></span><span class="sig-name descname"><span class="pre">--use_local_storage</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--no_use_local_storage</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-use_local_storage" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Whether to use local .adk storage when –session_service_uri and –artifact_service_uri are unset. Cannot be combined with explicit service URIs. When the agents directory isn’t writable (common in Cloud Run/Kubernetes), ADK falls back to in-memory unless overridden by ADK_FORCE_LOCAL_STORAGE=1 or ADK_DISABLE_LOCAL_STORAGE=1.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-memory_service_uri">
<span class="sig-name descname"><span class="pre">--memory_service_uri</span></span><span class="sig-prename descclassname"> <span class="pre"><memory_service_uri></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-memory_service_uri" title="Link to this definition">¶</a></dt>
<dd><div class="line-block">
<div class="line">Optional. The URI of the memory service.</div>
<div class="line">- Use ‘rag://<rag_corpus_id>’ to connect to Vertex AI Rag Memory Service.</div>
<div class="line">- Use ‘agentengine://<agent_engine>’ to connect to Agent Engine</div>
<div class="line-block">
<div class="line">sessions. <agent_engine> can either be the full qualified resource</div>
<div class="line">name ‘projects/abc/locations/us-central1/reasoningEngines/123’ or</div>
<div class="line">the resource id ‘123’.</div>
</div>
<div class="line">- Use ‘memory://’ to force the in-memory memory service.</div>
</div>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-session_db_url">
<span class="sig-name descname"><span class="pre">--session_db_url</span></span><span class="sig-prename descclassname"> <span class="pre"><session_db_url></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-session_db_url" title="Link to this definition">¶</a></dt>
<dd><p>Deprecated. Use –session_service_uri instead.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-artifact_storage_uri">
<span class="sig-name descname"><span class="pre">--artifact_storage_uri</span></span><span class="sig-prename descclassname"> <span class="pre"><artifact_storage_uri></span></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-artifact_storage_uri" title="Link to this definition">¶</a></dt>
<dd><p>Deprecated. Use –artifact_service_uri instead.</p>
</dd></dl>
<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-cloud_run-arg-AGENT">
<span class="sig-name descname"><span class="pre">AGENT</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-deploy-cloud_run-arg-AGENT" title="Link to this definition">¶</a></dt>
<dd><p>Required argument</p>
</dd></dl>
</section>
<section id="adk-deploy-gke">
<h4>gke<a class="headerlink" href="#adk-deploy-gke" title="Link to this heading">¶</a></h4>
<p>Deploys an agent to GKE.</p>
<p>AGENT: The path to the agent source code folder.</p>
<p>Example:</p>
<blockquote>
<div><dl class="simple">
<dt>adk deploy gke –project=[project] –region=[region]</dt><dd><p>–cluster_name=[cluster_name] path/to/my_agent</p>
</dd>
</dl>
</div></blockquote>
<p class="rubric">Usage</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>adk<span class="w"> </span>deploy<span class="w"> </span>gke<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>AGENT
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-gke-project">
<span class="sig-name descname"><span class="pre">--project</span></span><span class="sig-prename descclassname"> <span class="pre"><project></span></span><a class="headerlink" href="#cmdoption-adk-deploy-gke-project" title="Link to this definition">¶</a></dt>
<dd><p>Required. Google Cloud project to deploy the agent. When absent, default project from gcloud config is used.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-gke-region">
<span class="sig-name descname"><span class="pre">--region</span></span><span class="sig-prename descclassname"> <span class="pre"><region></span></span><a class="headerlink" href="#cmdoption-adk-deploy-gke-region" title="Link to this definition">¶</a></dt>
<dd><p>Required. Google Cloud region to deploy the agent. When absent, gcloud run deploy will prompt later.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-gke-cluster_name">
<span class="sig-name descname"><span class="pre">--cluster_name</span></span><span class="sig-prename descclassname"> <span class="pre"><cluster_name></span></span><a class="headerlink" href="#cmdoption-adk-deploy-gke-cluster_name" title="Link to this definition">¶</a></dt>
<dd><p>Required. The name of the GKE cluster.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-gke-service_name">
<span class="sig-name descname"><span class="pre">--service_name</span></span><span class="sig-prename descclassname"> <span class="pre"><service_name></span></span><a class="headerlink" href="#cmdoption-adk-deploy-gke-service_name" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The service name to use in GKE (default: ‘adk-default-service-name’).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-gke-app_name">
<span class="sig-name descname"><span class="pre">--app_name</span></span><span class="sig-prename descclassname"> <span class="pre"><app_name></span></span><a class="headerlink" href="#cmdoption-adk-deploy-gke-app_name" title="Link to this definition">¶</a></dt>
<dd><p>Optional. App name of the ADK API server (default: the folder name of the AGENT source code).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-gke-port">
<span class="sig-name descname"><span class="pre">--port</span></span><span class="sig-prename descclassname"> <span class="pre"><port></span></span><a class="headerlink" href="#cmdoption-adk-deploy-gke-port" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The port of the ADK API server (default: 8000).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-gke-trace_to_cloud">
<span class="sig-name descname"><span class="pre">--trace_to_cloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-deploy-gke-trace_to_cloud" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Whether to enable Cloud Trace for GKE.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-gke-otel_to_cloud">
<span class="sig-name descname"><span class="pre">--otel_to_cloud</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-deploy-gke-otel_to_cloud" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Whether to enable OpenTelemetry for GKE.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-gke-with_ui">
<span class="sig-name descname"><span class="pre">--with_ui</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-adk-deploy-gke-with_ui" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Deploy ADK Web UI if set. (default: deploy ADK API server only). WARNING: The web UI is for development and testing only — do not use in production.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-gke-log_level">
<span class="sig-name descname"><span class="pre">--log_level</span></span><span class="sig-prename descclassname"> <span class="pre"><log_level></span></span><a class="headerlink" href="#cmdoption-adk-deploy-gke-log_level" title="Link to this definition">¶</a></dt>
<dd><p>Optional. Set the logging level</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>DEBUG | INFO | WARNING | ERROR | CRITICAL</p>
</dd>
</dl>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-adk-deploy-gke-service_type">
<span class="sig-name descname"><span class="pre">--service_type</span></span><span class="sig-prename descclassname"> <span class="pre"><service_type></span></span><a class="headerlink" href="#cmdoption-adk-deploy-gke-service_type" title="Link to this definition">¶</a></dt>
<dd><p>Optional. The Kubernetes Service type for the deployed agent. ClusterIP (default) keeps the service cluster-internal; use LoadBalancer to expose a public IP.</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">'ClusterIP'</span></code></p>
</dd>
<dt class="field-even">Options<span class="colon">:</span></dt>
<dd class="field-even"><p>ClusterIP | LoadBalancer</p>
</dd>
</dl>