solace-agent-mesh 1.6.1__py3-none-any.whl → 1.13.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of solace-agent-mesh might be problematic. Click here for more details.

Files changed (481) hide show
  1. solace_agent_mesh/agent/adk/alembic/README +74 -0
  2. solace_agent_mesh/agent/adk/alembic/env.py +77 -0
  3. solace_agent_mesh/agent/adk/alembic/script.py.mako +28 -0
  4. solace_agent_mesh/agent/adk/alembic/versions/e2902798564d_adk_session_db_upgrade.py +52 -0
  5. solace_agent_mesh/agent/adk/alembic.ini +112 -0
  6. solace_agent_mesh/agent/adk/app_llm_agent.py +26 -0
  7. solace_agent_mesh/agent/adk/artifacts/filesystem_artifact_service.py +165 -1
  8. solace_agent_mesh/agent/adk/artifacts/s3_artifact_service.py +163 -0
  9. solace_agent_mesh/agent/adk/callbacks.py +852 -109
  10. solace_agent_mesh/agent/adk/embed_resolving_mcp_toolset.py +234 -36
  11. solace_agent_mesh/agent/adk/intelligent_mcp_callbacks.py +52 -5
  12. solace_agent_mesh/agent/adk/mcp_content_processor.py +1 -1
  13. solace_agent_mesh/agent/adk/models/lite_llm.py +77 -21
  14. solace_agent_mesh/agent/adk/models/oauth2_token_manager.py +24 -137
  15. solace_agent_mesh/agent/adk/runner.py +85 -20
  16. solace_agent_mesh/agent/adk/schema_migration.py +88 -0
  17. solace_agent_mesh/agent/adk/services.py +94 -18
  18. solace_agent_mesh/agent/adk/setup.py +281 -65
  19. solace_agent_mesh/agent/adk/stream_parser.py +231 -37
  20. solace_agent_mesh/agent/adk/tool_wrapper.py +3 -0
  21. solace_agent_mesh/agent/protocol/event_handlers.py +472 -137
  22. solace_agent_mesh/agent/proxies/a2a/app.py +3 -2
  23. solace_agent_mesh/agent/proxies/a2a/component.py +572 -75
  24. solace_agent_mesh/agent/proxies/a2a/config.py +80 -4
  25. solace_agent_mesh/agent/proxies/base/app.py +3 -2
  26. solace_agent_mesh/agent/proxies/base/component.py +188 -22
  27. solace_agent_mesh/agent/proxies/base/proxy_task_context.py +3 -1
  28. solace_agent_mesh/agent/sac/app.py +91 -3
  29. solace_agent_mesh/agent/sac/component.py +591 -157
  30. solace_agent_mesh/agent/sac/patch_adk.py +8 -16
  31. solace_agent_mesh/agent/sac/task_execution_context.py +146 -4
  32. solace_agent_mesh/agent/tools/__init__.py +3 -0
  33. solace_agent_mesh/agent/tools/audio_tools.py +3 -3
  34. solace_agent_mesh/agent/tools/builtin_artifact_tools.py +710 -171
  35. solace_agent_mesh/agent/tools/deep_research_tools.py +2161 -0
  36. solace_agent_mesh/agent/tools/dynamic_tool.py +2 -0
  37. solace_agent_mesh/agent/tools/peer_agent_tool.py +82 -15
  38. solace_agent_mesh/agent/tools/time_tools.py +126 -0
  39. solace_agent_mesh/agent/tools/tool_config_types.py +57 -2
  40. solace_agent_mesh/agent/tools/web_search_tools.py +279 -0
  41. solace_agent_mesh/agent/tools/web_tools.py +125 -17
  42. solace_agent_mesh/agent/utils/artifact_helpers.py +248 -6
  43. solace_agent_mesh/agent/utils/context_helpers.py +17 -0
  44. solace_agent_mesh/assets/docs/404.html +6 -6
  45. solace_agent_mesh/assets/docs/assets/css/{styles.906a1503.css → styles.8162edfb.css} +1 -1
  46. solace_agent_mesh/assets/docs/assets/js/05749d90.19ac4f35.js +1 -0
  47. solace_agent_mesh/assets/docs/assets/js/15ba94aa.e186750d.js +1 -0
  48. solace_agent_mesh/assets/docs/assets/js/15e40e79.434bb30f.js +1 -0
  49. solace_agent_mesh/assets/docs/assets/js/17896441.e612dfb4.js +1 -0
  50. solace_agent_mesh/assets/docs/assets/js/2279.550aa580.js +2 -0
  51. solace_agent_mesh/assets/docs/assets/js/{17896441.a5e82f9b.js.LICENSE.txt → 2279.550aa580.js.LICENSE.txt} +6 -0
  52. solace_agent_mesh/assets/docs/assets/js/240a0364.83e37aa8.js +1 -0
  53. solace_agent_mesh/assets/docs/assets/js/2987107d.a80604f9.js +1 -0
  54. solace_agent_mesh/assets/docs/assets/js/2e32b5e0.2f0db237.js +1 -0
  55. solace_agent_mesh/assets/docs/assets/js/3a6c6137.7e61915d.js +1 -0
  56. solace_agent_mesh/assets/docs/assets/js/3ac1795d.7f7ab1c1.js +1 -0
  57. solace_agent_mesh/assets/docs/assets/js/3ff0015d.e53c9b78.js +1 -0
  58. solace_agent_mesh/assets/docs/assets/js/41adc471.0e95b87c.js +1 -0
  59. solace_agent_mesh/assets/docs/assets/js/4667dc50.bf2ad456.js +1 -0
  60. solace_agent_mesh/assets/docs/assets/js/49eed117.493d6f99.js +1 -0
  61. solace_agent_mesh/assets/docs/assets/js/{509e993c.4c7a1a6d.js → 509e993c.a1fbf45a.js} +1 -1
  62. solace_agent_mesh/assets/docs/assets/js/547e15cc.8e6da617.js +1 -0
  63. solace_agent_mesh/assets/docs/assets/js/55b7b518.29d6e75d.js +1 -0
  64. solace_agent_mesh/assets/docs/assets/js/5b8d9c11.d4eb37b8.js +1 -0
  65. solace_agent_mesh/assets/docs/assets/js/5c2bd65f.1ee87753.js +1 -0
  66. solace_agent_mesh/assets/docs/assets/js/60702c0e.a8bdd79b.js +1 -0
  67. solace_agent_mesh/assets/docs/assets/js/631738c7.fa471607.js +1 -0
  68. solace_agent_mesh/assets/docs/assets/js/64195356.09dbd087.js +1 -0
  69. solace_agent_mesh/assets/docs/assets/js/66d4869e.30340bd3.js +1 -0
  70. solace_agent_mesh/assets/docs/assets/js/6a520c9d.b6e3f2ce.js +1 -0
  71. solace_agent_mesh/assets/docs/assets/js/6aaedf65.7253541d.js +1 -0
  72. solace_agent_mesh/assets/docs/assets/js/6ad8f0bd.a5b36a60.js +1 -0
  73. solace_agent_mesh/assets/docs/assets/js/6d84eae0.fd23ba4a.js +1 -0
  74. solace_agent_mesh/assets/docs/assets/js/71da7b71.374b9d54.js +1 -0
  75. solace_agent_mesh/assets/docs/assets/js/729898df.7249e9fd.js +1 -0
  76. solace_agent_mesh/assets/docs/assets/js/7e294c01.7c5f6906.js +1 -0
  77. solace_agent_mesh/assets/docs/assets/js/8024126c.e3467286.js +1 -0
  78. solace_agent_mesh/assets/docs/assets/js/81a99df0.7ed65d45.js +1 -0
  79. solace_agent_mesh/assets/docs/assets/js/82fbfb93.161823a5.js +1 -0
  80. solace_agent_mesh/assets/docs/assets/js/8b032486.91a91afc.js +1 -0
  81. solace_agent_mesh/assets/docs/assets/js/924ffdeb.975e428a.js +1 -0
  82. solace_agent_mesh/assets/docs/assets/js/94e8668d.16083b3f.js +1 -0
  83. solace_agent_mesh/assets/docs/assets/js/9bb13469.4523ae20.js +1 -0
  84. solace_agent_mesh/assets/docs/assets/js/a7d42657.a956689d.js +1 -0
  85. solace_agent_mesh/assets/docs/assets/js/a94703ab.3e5fbcb3.js +1 -0
  86. solace_agent_mesh/assets/docs/assets/js/ab9708a8.3e563275.js +1 -0
  87. solace_agent_mesh/assets/docs/assets/js/ad87452a.9d73dad6.js +1 -0
  88. solace_agent_mesh/assets/docs/assets/js/c93cbaa0.0e0d8baf.js +1 -0
  89. solace_agent_mesh/assets/docs/assets/js/cab03b5b.6a073091.js +1 -0
  90. solace_agent_mesh/assets/docs/assets/js/cbe2e9ea.07e170dd.js +1 -0
  91. solace_agent_mesh/assets/docs/assets/js/da0b5bad.b62f7b08.js +1 -0
  92. solace_agent_mesh/assets/docs/assets/js/dd817ffc.c37a755e.js +1 -0
  93. solace_agent_mesh/assets/docs/assets/js/dd81e2b8.b682e9c2.js +1 -0
  94. solace_agent_mesh/assets/docs/assets/js/de915948.44a432bc.js +1 -0
  95. solace_agent_mesh/assets/docs/assets/js/e04b235d.06d23db6.js +1 -0
  96. solace_agent_mesh/assets/docs/assets/js/e1b6eeb4.deb2b62e.js +1 -0
  97. solace_agent_mesh/assets/docs/assets/js/e3d9abda.1476f570.js +1 -0
  98. solace_agent_mesh/assets/docs/assets/js/e6f9706b.acc800d3.js +1 -0
  99. solace_agent_mesh/assets/docs/assets/js/e92d0134.c147a429.js +1 -0
  100. solace_agent_mesh/assets/docs/assets/js/ee0c2fe7.94d0a351.js +1 -0
  101. solace_agent_mesh/assets/docs/assets/js/f284c35a.cc97854c.js +1 -0
  102. solace_agent_mesh/assets/docs/assets/js/ff4d71f2.74710fc1.js +1 -0
  103. solace_agent_mesh/assets/docs/assets/js/main.d634009f.js +2 -0
  104. solace_agent_mesh/assets/docs/assets/js/runtime~main.27bb82a7.js +1 -0
  105. solace_agent_mesh/assets/docs/docs/documentation/components/agents/index.html +68 -68
  106. solace_agent_mesh/assets/docs/docs/documentation/components/builtin-tools/artifact-management/index.html +50 -50
  107. solace_agent_mesh/assets/docs/docs/documentation/components/builtin-tools/audio-tools/index.html +42 -42
  108. solace_agent_mesh/assets/docs/docs/documentation/components/builtin-tools/data-analysis-tools/index.html +55 -55
  109. solace_agent_mesh/assets/docs/docs/documentation/components/builtin-tools/embeds/index.html +82 -68
  110. solace_agent_mesh/assets/docs/docs/documentation/components/builtin-tools/image-tools/index.html +81 -0
  111. solace_agent_mesh/assets/docs/docs/documentation/components/builtin-tools/index.html +67 -50
  112. solace_agent_mesh/assets/docs/docs/documentation/components/builtin-tools/research-tools/index.html +136 -0
  113. solace_agent_mesh/assets/docs/docs/documentation/components/cli/index.html +178 -144
  114. solace_agent_mesh/assets/docs/docs/documentation/components/gateways/index.html +43 -42
  115. solace_agent_mesh/assets/docs/docs/documentation/components/index.html +20 -18
  116. solace_agent_mesh/assets/docs/docs/documentation/components/orchestrator/index.html +23 -23
  117. solace_agent_mesh/assets/docs/docs/documentation/components/platform-service/index.html +33 -0
  118. solace_agent_mesh/assets/docs/docs/documentation/components/plugins/index.html +45 -45
  119. solace_agent_mesh/assets/docs/docs/documentation/components/projects/index.html +182 -0
  120. solace_agent_mesh/assets/docs/docs/documentation/components/prompts/index.html +147 -0
  121. solace_agent_mesh/assets/docs/docs/documentation/components/proxies/index.html +208 -125
  122. solace_agent_mesh/assets/docs/docs/documentation/components/speech/index.html +52 -0
  123. solace_agent_mesh/assets/docs/docs/documentation/deploying/debugging/index.html +28 -49
  124. solace_agent_mesh/assets/docs/docs/documentation/deploying/deployment-options/index.html +29 -30
  125. solace_agent_mesh/assets/docs/docs/documentation/deploying/index.html +14 -14
  126. solace_agent_mesh/assets/docs/docs/documentation/deploying/kubernetes/index.html +47 -0
  127. solace_agent_mesh/assets/docs/docs/documentation/deploying/kubernetes/kubernetes-deployment-guide/index.html +197 -0
  128. solace_agent_mesh/assets/docs/docs/documentation/deploying/logging/index.html +90 -0
  129. solace_agent_mesh/assets/docs/docs/documentation/deploying/observability/index.html +17 -16
  130. solace_agent_mesh/assets/docs/docs/documentation/deploying/proxy_configuration/index.html +49 -0
  131. solace_agent_mesh/assets/docs/docs/documentation/developing/create-agents/index.html +38 -38
  132. solace_agent_mesh/assets/docs/docs/documentation/developing/create-gateways/index.html +162 -171
  133. solace_agent_mesh/assets/docs/docs/documentation/developing/creating-python-tools/index.html +67 -49
  134. solace_agent_mesh/assets/docs/docs/documentation/developing/creating-service-providers/index.html +17 -17
  135. solace_agent_mesh/assets/docs/docs/documentation/developing/evaluations/index.html +51 -51
  136. solace_agent_mesh/assets/docs/docs/documentation/developing/index.html +22 -22
  137. solace_agent_mesh/assets/docs/docs/documentation/developing/structure/index.html +27 -27
  138. solace_agent_mesh/assets/docs/docs/documentation/developing/tutorials/bedrock-agents/index.html +135 -135
  139. solace_agent_mesh/assets/docs/docs/documentation/developing/tutorials/custom-agent/index.html +66 -66
  140. solace_agent_mesh/assets/docs/docs/documentation/developing/tutorials/event-mesh-gateway/index.html +51 -51
  141. solace_agent_mesh/assets/docs/docs/documentation/developing/tutorials/mcp-integration/index.html +50 -38
  142. solace_agent_mesh/assets/docs/docs/documentation/developing/tutorials/mongodb-integration/index.html +86 -86
  143. solace_agent_mesh/assets/docs/docs/documentation/developing/tutorials/rag-integration/index.html +51 -51
  144. solace_agent_mesh/assets/docs/docs/documentation/developing/tutorials/rest-gateway/index.html +24 -24
  145. solace_agent_mesh/assets/docs/docs/documentation/developing/tutorials/slack-integration/index.html +30 -30
  146. solace_agent_mesh/assets/docs/docs/documentation/developing/tutorials/sql-database/index.html +44 -44
  147. solace_agent_mesh/assets/docs/docs/documentation/developing/tutorials/teams-integration/index.html +115 -0
  148. solace_agent_mesh/assets/docs/docs/documentation/enterprise/agent-builder/index.html +86 -0
  149. solace_agent_mesh/assets/docs/docs/documentation/enterprise/connectors/index.html +67 -0
  150. solace_agent_mesh/assets/docs/docs/documentation/enterprise/index.html +23 -19
  151. solace_agent_mesh/assets/docs/docs/documentation/enterprise/installation/index.html +40 -37
  152. solace_agent_mesh/assets/docs/docs/documentation/enterprise/openapi-tools/index.html +324 -0
  153. solace_agent_mesh/assets/docs/docs/documentation/enterprise/rbac-setup-guide/index.html +112 -87
  154. solace_agent_mesh/assets/docs/docs/documentation/enterprise/secure-user-delegated-access/index.html +440 -0
  155. solace_agent_mesh/assets/docs/docs/documentation/enterprise/single-sign-on/index.html +87 -64
  156. solace_agent_mesh/assets/docs/docs/documentation/enterprise/wheel-installation/index.html +62 -0
  157. solace_agent_mesh/assets/docs/docs/documentation/getting-started/architecture/index.html +44 -44
  158. solace_agent_mesh/assets/docs/docs/documentation/getting-started/index.html +39 -37
  159. solace_agent_mesh/assets/docs/docs/documentation/getting-started/introduction/index.html +30 -30
  160. solace_agent_mesh/assets/docs/docs/documentation/getting-started/try-agent-mesh/index.html +18 -18
  161. solace_agent_mesh/assets/docs/docs/documentation/getting-started/vibe_coding/index.html +62 -0
  162. solace_agent_mesh/assets/docs/docs/documentation/installing-and-configuring/artifact-storage/index.html +311 -0
  163. solace_agent_mesh/assets/docs/docs/documentation/installing-and-configuring/configurations/index.html +39 -42
  164. solace_agent_mesh/assets/docs/docs/documentation/installing-and-configuring/index.html +14 -14
  165. solace_agent_mesh/assets/docs/docs/documentation/installing-and-configuring/installation/index.html +27 -25
  166. solace_agent_mesh/assets/docs/docs/documentation/installing-and-configuring/large_language_models/index.html +69 -69
  167. solace_agent_mesh/assets/docs/docs/documentation/installing-and-configuring/run-project/index.html +72 -72
  168. solace_agent_mesh/assets/docs/docs/documentation/installing-and-configuring/session-storage/index.html +251 -0
  169. solace_agent_mesh/assets/docs/docs/documentation/installing-and-configuring/user-feedback/index.html +88 -0
  170. solace_agent_mesh/assets/docs/docs/documentation/migrations/a2a-upgrade/a2a-gateway-upgrade-to-0.3.0/index.html +42 -42
  171. solace_agent_mesh/assets/docs/docs/documentation/migrations/a2a-upgrade/a2a-technical-migration-map/index.html +20 -20
  172. solace_agent_mesh/assets/docs/docs/documentation/migrations/platform-service-split/index.html +85 -0
  173. solace_agent_mesh/assets/docs/lunr-index-1768329217460.json +1 -0
  174. solace_agent_mesh/assets/docs/lunr-index.json +1 -1
  175. solace_agent_mesh/assets/docs/search-doc-1768329217460.json +1 -0
  176. solace_agent_mesh/assets/docs/search-doc.json +1 -1
  177. solace_agent_mesh/assets/docs/sitemap.xml +1 -1
  178. solace_agent_mesh/cli/__init__.py +1 -1
  179. solace_agent_mesh/cli/commands/add_cmd/__init__.py +3 -1
  180. solace_agent_mesh/cli/commands/add_cmd/agent_cmd.py +6 -1
  181. solace_agent_mesh/cli/commands/add_cmd/proxy_cmd.py +100 -0
  182. solace_agent_mesh/cli/commands/docs_cmd.py +4 -1
  183. solace_agent_mesh/cli/commands/eval_cmd.py +1 -1
  184. solace_agent_mesh/cli/commands/init_cmd/__init__.py +15 -0
  185. solace_agent_mesh/cli/commands/init_cmd/directory_step.py +1 -1
  186. solace_agent_mesh/cli/commands/init_cmd/env_step.py +30 -3
  187. solace_agent_mesh/cli/commands/init_cmd/orchestrator_step.py +3 -4
  188. solace_agent_mesh/cli/commands/init_cmd/platform_service_step.py +85 -0
  189. solace_agent_mesh/cli/commands/init_cmd/webui_gateway_step.py +16 -3
  190. solace_agent_mesh/cli/commands/plugin_cmd/add_cmd.py +2 -1
  191. solace_agent_mesh/cli/commands/plugin_cmd/catalog_cmd.py +1 -0
  192. solace_agent_mesh/cli/commands/plugin_cmd/create_cmd.py +3 -3
  193. solace_agent_mesh/cli/commands/run_cmd.py +64 -49
  194. solace_agent_mesh/cli/commands/tools_cmd.py +315 -0
  195. solace_agent_mesh/cli/main.py +15 -0
  196. solace_agent_mesh/client/webui/frontend/static/assets/{authCallback-BTf6dqwp.js → authCallback-KnKMP_vb.js} +1 -1
  197. solace_agent_mesh/client/webui/frontend/static/assets/client-DpBL2stg.js +25 -0
  198. solace_agent_mesh/client/webui/frontend/static/assets/main-Cd498TV2.js +435 -0
  199. solace_agent_mesh/client/webui/frontend/static/assets/main-rSf8Vu29.css +1 -0
  200. solace_agent_mesh/client/webui/frontend/static/assets/vendor-CGk8Suyh.js +565 -0
  201. solace_agent_mesh/client/webui/frontend/static/auth-callback.html +3 -3
  202. solace_agent_mesh/client/webui/frontend/static/index.html +4 -4
  203. solace_agent_mesh/client/webui/frontend/static/mockServiceWorker.js +336 -0
  204. solace_agent_mesh/client/webui/frontend/static/ui-version.json +6 -0
  205. solace_agent_mesh/common/a2a/events.py +2 -1
  206. solace_agent_mesh/common/a2a/protocol.py +5 -0
  207. solace_agent_mesh/common/a2a/types.py +2 -1
  208. solace_agent_mesh/common/a2a_spec/schemas/artifact_creation_progress.json +23 -6
  209. solace_agent_mesh/common/a2a_spec/schemas/feedback_event.json +51 -0
  210. solace_agent_mesh/common/agent_registry.py +38 -11
  211. solace_agent_mesh/common/data_parts.py +144 -4
  212. solace_agent_mesh/common/error_handlers.py +83 -0
  213. solace_agent_mesh/common/exceptions.py +24 -0
  214. solace_agent_mesh/common/oauth/__init__.py +17 -0
  215. solace_agent_mesh/common/oauth/oauth_client.py +408 -0
  216. solace_agent_mesh/common/oauth/utils.py +50 -0
  217. solace_agent_mesh/common/rag_dto.py +156 -0
  218. solace_agent_mesh/common/sac/sam_component_base.py +97 -19
  219. solace_agent_mesh/common/sam_events/event_service.py +2 -2
  220. solace_agent_mesh/common/services/employee_service.py +1 -1
  221. solace_agent_mesh/common/utils/embeds/constants.py +1 -0
  222. solace_agent_mesh/common/utils/embeds/converter.py +1 -8
  223. solace_agent_mesh/common/utils/embeds/modifiers.py +4 -28
  224. solace_agent_mesh/common/utils/embeds/resolver.py +152 -31
  225. solace_agent_mesh/common/utils/embeds/types.py +9 -0
  226. solace_agent_mesh/common/utils/log_formatters.py +20 -0
  227. solace_agent_mesh/common/utils/mime_helpers.py +12 -5
  228. solace_agent_mesh/common/utils/pydantic_utils.py +90 -3
  229. solace_agent_mesh/common/utils/rbac_utils.py +69 -0
  230. solace_agent_mesh/common/utils/templates/__init__.py +8 -0
  231. solace_agent_mesh/common/utils/templates/liquid_renderer.py +210 -0
  232. solace_agent_mesh/common/utils/templates/template_resolver.py +161 -0
  233. solace_agent_mesh/config_portal/backend/common.py +12 -0
  234. solace_agent_mesh/config_portal/frontend/static/client/assets/_index-CljP4_mv.js +103 -0
  235. solace_agent_mesh/config_portal/frontend/static/client/assets/{components-Rk0n-9cK.js → components-CaC6hG8d.js} +22 -22
  236. solace_agent_mesh/config_portal/frontend/static/client/assets/{entry.client-mvZjNKiz.js → entry.client-H_TM0YBt.js} +3 -3
  237. solace_agent_mesh/config_portal/frontend/static/client/assets/{index-DzNKzXrc.js → index-CnFykb2v.js} +16 -16
  238. solace_agent_mesh/config_portal/frontend/static/client/assets/manifest-f8439d40.js +1 -0
  239. solace_agent_mesh/config_portal/frontend/static/client/assets/root-BIMqslJB.css +1 -0
  240. solace_agent_mesh/config_portal/frontend/static/client/assets/root-mJmTIdIk.js +10 -0
  241. solace_agent_mesh/config_portal/frontend/static/client/index.html +3 -3
  242. solace_agent_mesh/core_a2a/service.py +3 -2
  243. solace_agent_mesh/gateway/adapter/__init__.py +1 -0
  244. solace_agent_mesh/gateway/adapter/base.py +170 -0
  245. solace_agent_mesh/gateway/adapter/types.py +230 -0
  246. solace_agent_mesh/gateway/base/app.py +39 -2
  247. solace_agent_mesh/gateway/base/auth_interface.py +103 -0
  248. solace_agent_mesh/gateway/base/component.py +1027 -151
  249. solace_agent_mesh/gateway/generic/__init__.py +1 -0
  250. solace_agent_mesh/gateway/generic/app.py +50 -0
  251. solace_agent_mesh/gateway/generic/component.py +894 -0
  252. solace_agent_mesh/gateway/http_sse/alembic/env.py +0 -7
  253. solace_agent_mesh/gateway/http_sse/alembic/versions/20251023_add_project_users_table.py +72 -0
  254. solace_agent_mesh/gateway/http_sse/alembic/versions/20251023_add_soft_delete_and_search.py +109 -0
  255. solace_agent_mesh/gateway/http_sse/alembic/versions/20251024_add_default_agent_to_projects.py +26 -0
  256. solace_agent_mesh/gateway/http_sse/alembic/versions/20251024_add_projects_table.py +135 -0
  257. solace_agent_mesh/gateway/http_sse/alembic/versions/20251108_create_prompt_tables_with_sharing.py +154 -0
  258. solace_agent_mesh/gateway/http_sse/alembic/versions/20251115_add_parent_task_id.py +32 -0
  259. solace_agent_mesh/gateway/http_sse/alembic/versions/20251126_add_background_task_fields.py +47 -0
  260. solace_agent_mesh/gateway/http_sse/alembic/versions/20251202_add_versioned_fields_to_prompts.py +52 -0
  261. solace_agent_mesh/gateway/http_sse/alembic.ini +0 -36
  262. solace_agent_mesh/gateway/http_sse/app.py +40 -11
  263. solace_agent_mesh/gateway/http_sse/component.py +285 -160
  264. solace_agent_mesh/gateway/http_sse/dependencies.py +149 -114
  265. solace_agent_mesh/gateway/http_sse/main.py +68 -450
  266. solace_agent_mesh/gateway/http_sse/repository/__init__.py +19 -1
  267. solace_agent_mesh/gateway/http_sse/repository/chat_task_repository.py +2 -2
  268. solace_agent_mesh/gateway/http_sse/repository/entities/project.py +81 -0
  269. solace_agent_mesh/gateway/http_sse/repository/entities/project_user.py +47 -0
  270. solace_agent_mesh/gateway/http_sse/repository/entities/session.py +26 -3
  271. solace_agent_mesh/gateway/http_sse/repository/entities/task.py +7 -0
  272. solace_agent_mesh/gateway/http_sse/repository/feedback_repository.py +47 -0
  273. solace_agent_mesh/gateway/http_sse/repository/interfaces.py +114 -6
  274. solace_agent_mesh/gateway/http_sse/repository/models/__init__.py +13 -0
  275. solace_agent_mesh/gateway/http_sse/repository/models/project_model.py +51 -0
  276. solace_agent_mesh/gateway/http_sse/repository/models/project_user_model.py +75 -0
  277. solace_agent_mesh/gateway/http_sse/repository/models/prompt_model.py +159 -0
  278. solace_agent_mesh/gateway/http_sse/repository/models/session_model.py +8 -2
  279. solace_agent_mesh/gateway/http_sse/repository/models/task_model.py +8 -1
  280. solace_agent_mesh/gateway/http_sse/repository/project_repository.py +172 -0
  281. solace_agent_mesh/gateway/http_sse/repository/project_user_repository.py +186 -0
  282. solace_agent_mesh/gateway/http_sse/repository/session_repository.py +177 -11
  283. solace_agent_mesh/gateway/http_sse/repository/task_repository.py +86 -2
  284. solace_agent_mesh/gateway/http_sse/routers/agent_cards.py +38 -7
  285. solace_agent_mesh/gateway/http_sse/routers/artifacts.py +256 -58
  286. solace_agent_mesh/gateway/http_sse/routers/auth.py +168 -134
  287. solace_agent_mesh/gateway/http_sse/routers/config.py +302 -8
  288. solace_agent_mesh/gateway/http_sse/routers/dto/project_dto.py +69 -0
  289. solace_agent_mesh/gateway/http_sse/routers/dto/prompt_dto.py +255 -0
  290. solace_agent_mesh/gateway/http_sse/routers/dto/requests/project_requests.py +48 -0
  291. solace_agent_mesh/gateway/http_sse/routers/dto/requests/session_requests.py +14 -1
  292. solace_agent_mesh/gateway/http_sse/routers/dto/responses/base_responses.py +1 -1
  293. solace_agent_mesh/gateway/http_sse/routers/dto/responses/project_responses.py +31 -0
  294. solace_agent_mesh/gateway/http_sse/routers/dto/responses/session_responses.py +5 -2
  295. solace_agent_mesh/gateway/http_sse/routers/dto/responses/version_responses.py +31 -0
  296. solace_agent_mesh/gateway/http_sse/routers/feedback.py +133 -2
  297. solace_agent_mesh/gateway/http_sse/routers/people.py +2 -2
  298. solace_agent_mesh/gateway/http_sse/routers/projects.py +768 -0
  299. solace_agent_mesh/gateway/http_sse/routers/prompts.py +1416 -0
  300. solace_agent_mesh/gateway/http_sse/routers/sessions.py +167 -7
  301. solace_agent_mesh/gateway/http_sse/routers/speech.py +355 -0
  302. solace_agent_mesh/gateway/http_sse/routers/sse.py +131 -8
  303. solace_agent_mesh/gateway/http_sse/routers/tasks.py +670 -18
  304. solace_agent_mesh/gateway/http_sse/routers/users.py +1 -1
  305. solace_agent_mesh/gateway/http_sse/routers/version.py +343 -0
  306. solace_agent_mesh/gateway/http_sse/routers/visualization.py +92 -9
  307. solace_agent_mesh/gateway/http_sse/services/audio_service.py +1227 -0
  308. solace_agent_mesh/gateway/http_sse/services/background_task_monitor.py +186 -0
  309. solace_agent_mesh/gateway/http_sse/services/data_retention_service.py +1 -1
  310. solace_agent_mesh/gateway/http_sse/services/feedback_service.py +1 -1
  311. solace_agent_mesh/gateway/http_sse/services/project_service.py +930 -0
  312. solace_agent_mesh/gateway/http_sse/services/prompt_builder_assistant.py +303 -0
  313. solace_agent_mesh/gateway/http_sse/services/session_service.py +361 -12
  314. solace_agent_mesh/gateway/http_sse/services/task_logger_service.py +354 -4
  315. solace_agent_mesh/gateway/http_sse/session_manager.py +15 -15
  316. solace_agent_mesh/gateway/http_sse/sse_manager.py +286 -166
  317. solace_agent_mesh/gateway/http_sse/utils/artifact_copy_utils.py +370 -0
  318. solace_agent_mesh/gateway/http_sse/utils/stim_utils.py +41 -1
  319. solace_agent_mesh/services/__init__.py +0 -0
  320. solace_agent_mesh/services/platform/__init__.py +29 -0
  321. solace_agent_mesh/services/platform/alembic/env.py +85 -0
  322. solace_agent_mesh/services/platform/alembic/script.py.mako +28 -0
  323. solace_agent_mesh/services/platform/alembic.ini +109 -0
  324. solace_agent_mesh/services/platform/api/__init__.py +3 -0
  325. solace_agent_mesh/services/platform/api/dependencies.py +154 -0
  326. solace_agent_mesh/services/platform/api/main.py +314 -0
  327. solace_agent_mesh/services/platform/api/middleware.py +51 -0
  328. solace_agent_mesh/services/platform/api/routers/__init__.py +33 -0
  329. solace_agent_mesh/services/platform/api/routers/health_router.py +31 -0
  330. solace_agent_mesh/services/platform/app.py +215 -0
  331. solace_agent_mesh/services/platform/component.py +777 -0
  332. solace_agent_mesh/shared/__init__.py +14 -0
  333. solace_agent_mesh/shared/api/__init__.py +42 -0
  334. solace_agent_mesh/shared/auth/__init__.py +26 -0
  335. solace_agent_mesh/shared/auth/dependencies.py +204 -0
  336. solace_agent_mesh/shared/auth/middleware.py +347 -0
  337. solace_agent_mesh/shared/database/__init__.py +20 -0
  338. solace_agent_mesh/{gateway/http_sse/shared → shared/database}/base_repository.py +1 -1
  339. solace_agent_mesh/{gateway/http_sse/shared → shared/database}/database_exceptions.py +1 -1
  340. solace_agent_mesh/{gateway/http_sse/shared → shared/database}/database_helpers.py +1 -1
  341. solace_agent_mesh/shared/exceptions/__init__.py +36 -0
  342. solace_agent_mesh/{gateway/http_sse/shared → shared/exceptions}/exception_handlers.py +19 -5
  343. solace_agent_mesh/shared/utils/__init__.py +21 -0
  344. solace_agent_mesh/templates/logging_config_template.yaml +48 -0
  345. solace_agent_mesh/templates/main_orchestrator.yaml +12 -1
  346. solace_agent_mesh/templates/platform.yaml +49 -0
  347. solace_agent_mesh/templates/plugin_readme_template.md +3 -25
  348. solace_agent_mesh/templates/plugin_tool_config_template.yaml +109 -0
  349. solace_agent_mesh/templates/proxy_template.yaml +62 -0
  350. solace_agent_mesh/templates/webui.yaml +148 -6
  351. solace_agent_mesh/tools/web_search/__init__.py +18 -0
  352. solace_agent_mesh/tools/web_search/base.py +84 -0
  353. solace_agent_mesh/tools/web_search/google_search.py +247 -0
  354. solace_agent_mesh/tools/web_search/models.py +99 -0
  355. {solace_agent_mesh-1.6.1.dist-info → solace_agent_mesh-1.13.2.dist-info}/METADATA +31 -12
  356. solace_agent_mesh-1.13.2.dist-info/RECORD +591 -0
  357. {solace_agent_mesh-1.6.1.dist-info → solace_agent_mesh-1.13.2.dist-info}/WHEEL +1 -1
  358. solace_agent_mesh/agent/adk/adk_llm.txt +0 -232
  359. solace_agent_mesh/agent/adk/adk_llm_detail.txt +0 -566
  360. solace_agent_mesh/agent/adk/artifacts/artifacts_llm.txt +0 -171
  361. solace_agent_mesh/agent/adk/models/models_llm.txt +0 -142
  362. solace_agent_mesh/agent/agent_llm.txt +0 -378
  363. solace_agent_mesh/agent/agent_llm_detail.txt +0 -1702
  364. solace_agent_mesh/agent/protocol/protocol_llm.txt +0 -81
  365. solace_agent_mesh/agent/protocol/protocol_llm_detail.txt +0 -92
  366. solace_agent_mesh/agent/sac/sac_llm.txt +0 -189
  367. solace_agent_mesh/agent/sac/sac_llm_detail.txt +0 -200
  368. solace_agent_mesh/agent/testing/testing_llm.txt +0 -57
  369. solace_agent_mesh/agent/testing/testing_llm_detail.txt +0 -68
  370. solace_agent_mesh/agent/tools/tools_llm.txt +0 -263
  371. solace_agent_mesh/agent/tools/tools_llm_detail.txt +0 -274
  372. solace_agent_mesh/agent/utils/utils_llm.txt +0 -138
  373. solace_agent_mesh/agent/utils/utils_llm_detail.txt +0 -149
  374. solace_agent_mesh/assets/docs/assets/js/15ba94aa.932dd2db.js +0 -1
  375. solace_agent_mesh/assets/docs/assets/js/17896441.a5e82f9b.js +0 -2
  376. solace_agent_mesh/assets/docs/assets/js/240a0364.7eac6021.js +0 -1
  377. solace_agent_mesh/assets/docs/assets/js/2e32b5e0.33f5d75b.js +0 -1
  378. solace_agent_mesh/assets/docs/assets/js/3a6c6137.f5940cfa.js +0 -1
  379. solace_agent_mesh/assets/docs/assets/js/3ac1795d.76654dd9.js +0 -1
  380. solace_agent_mesh/assets/docs/assets/js/3ff0015d.2be20244.js +0 -1
  381. solace_agent_mesh/assets/docs/assets/js/547e15cc.2cbb060a.js +0 -1
  382. solace_agent_mesh/assets/docs/assets/js/55b7b518.f2b1d1ba.js +0 -1
  383. solace_agent_mesh/assets/docs/assets/js/5c2bd65f.eda4bcb2.js +0 -1
  384. solace_agent_mesh/assets/docs/assets/js/631738c7.a8b1ef8b.js +0 -1
  385. solace_agent_mesh/assets/docs/assets/js/6a520c9d.ba015d81.js +0 -1
  386. solace_agent_mesh/assets/docs/assets/js/6ad8f0bd.f4b15f3b.js +0 -1
  387. solace_agent_mesh/assets/docs/assets/js/6d84eae0.4a5fbf39.js +0 -1
  388. solace_agent_mesh/assets/docs/assets/js/71da7b71.38583438.js +0 -1
  389. solace_agent_mesh/assets/docs/assets/js/8024126c.56e59919.js +0 -1
  390. solace_agent_mesh/assets/docs/assets/js/81a99df0.07034dd9.js +0 -1
  391. solace_agent_mesh/assets/docs/assets/js/82fbfb93.139a1a1f.js +0 -1
  392. solace_agent_mesh/assets/docs/assets/js/924ffdeb.8095e148.js +0 -1
  393. solace_agent_mesh/assets/docs/assets/js/94e8668d.b5ddb7a1.js +0 -1
  394. solace_agent_mesh/assets/docs/assets/js/9bb13469.dd1c9b54.js +0 -1
  395. solace_agent_mesh/assets/docs/assets/js/a94703ab.0438dbc2.js +0 -1
  396. solace_agent_mesh/assets/docs/assets/js/ab9708a8.3e6dd091.js +0 -1
  397. solace_agent_mesh/assets/docs/assets/js/c93cbaa0.eaff365e.js +0 -1
  398. solace_agent_mesh/assets/docs/assets/js/da0b5bad.d08a9466.js +0 -1
  399. solace_agent_mesh/assets/docs/assets/js/dd817ffc.0aa9630a.js +0 -1
  400. solace_agent_mesh/assets/docs/assets/js/dd81e2b8.d590bc9e.js +0 -1
  401. solace_agent_mesh/assets/docs/assets/js/de915948.27d6b065.js +0 -1
  402. solace_agent_mesh/assets/docs/assets/js/e3d9abda.6b9493d0.js +0 -1
  403. solace_agent_mesh/assets/docs/assets/js/e6f9706b.e74a984d.js +0 -1
  404. solace_agent_mesh/assets/docs/assets/js/e92d0134.cf6d6522.js +0 -1
  405. solace_agent_mesh/assets/docs/assets/js/f284c35a.42f59cdd.js +0 -1
  406. solace_agent_mesh/assets/docs/assets/js/ff4d71f2.15b02f97.js +0 -1
  407. solace_agent_mesh/assets/docs/assets/js/main.b12eac43.js +0 -2
  408. solace_agent_mesh/assets/docs/assets/js/runtime~main.e268214e.js +0 -1
  409. solace_agent_mesh/assets/docs/lunr-index-1761248203150.json +0 -1
  410. solace_agent_mesh/assets/docs/search-doc-1761248203150.json +0 -1
  411. solace_agent_mesh/cli/commands/add_cmd/add_cmd_llm.txt +0 -250
  412. solace_agent_mesh/cli/commands/init_cmd/init_cmd_llm.txt +0 -365
  413. solace_agent_mesh/cli/commands/plugin_cmd/plugin_cmd_llm.txt +0 -305
  414. solace_agent_mesh/client/webui/frontend/static/assets/client-CaY59VuC.js +0 -25
  415. solace_agent_mesh/client/webui/frontend/static/assets/main-B32noGmR.js +0 -342
  416. solace_agent_mesh/client/webui/frontend/static/assets/main-DHJKSW1S.css +0 -1
  417. solace_agent_mesh/client/webui/frontend/static/assets/vendor-BEmvJSYz.js +0 -405
  418. solace_agent_mesh/common/a2a/a2a_llm.txt +0 -182
  419. solace_agent_mesh/common/a2a/a2a_llm_detail.txt +0 -193
  420. solace_agent_mesh/common/a2a_spec/a2a_spec_llm.txt +0 -407
  421. solace_agent_mesh/common/a2a_spec/a2a_spec_llm_detail.txt +0 -736
  422. solace_agent_mesh/common/a2a_spec/schemas/schemas_llm.txt +0 -313
  423. solace_agent_mesh/common/common_llm.txt +0 -251
  424. solace_agent_mesh/common/common_llm_detail.txt +0 -2562
  425. solace_agent_mesh/common/middleware/middleware_llm.txt +0 -174
  426. solace_agent_mesh/common/middleware/middleware_llm_detail.txt +0 -185
  427. solace_agent_mesh/common/sac/sac_llm.txt +0 -71
  428. solace_agent_mesh/common/sac/sac_llm_detail.txt +0 -82
  429. solace_agent_mesh/common/sam_events/sam_events_llm.txt +0 -104
  430. solace_agent_mesh/common/sam_events/sam_events_llm_detail.txt +0 -115
  431. solace_agent_mesh/common/services/providers/providers_llm.txt +0 -80
  432. solace_agent_mesh/common/services/services_llm.txt +0 -363
  433. solace_agent_mesh/common/services/services_llm_detail.txt +0 -459
  434. solace_agent_mesh/common/utils/embeds/embeds_llm.txt +0 -220
  435. solace_agent_mesh/common/utils/utils_llm.txt +0 -336
  436. solace_agent_mesh/common/utils/utils_llm_detail.txt +0 -572
  437. solace_agent_mesh/config_portal/frontend/static/client/assets/_index-ByU1X1HD.js +0 -98
  438. solace_agent_mesh/config_portal/frontend/static/client/assets/manifest-61038fc6.js +0 -1
  439. solace_agent_mesh/config_portal/frontend/static/client/assets/root-BWvk5-gF.js +0 -10
  440. solace_agent_mesh/config_portal/frontend/static/client/assets/root-DxRwaWiE.css +0 -1
  441. solace_agent_mesh/core_a2a/core_a2a_llm.txt +0 -90
  442. solace_agent_mesh/core_a2a/core_a2a_llm_detail.txt +0 -101
  443. solace_agent_mesh/gateway/base/base_llm.txt +0 -224
  444. solace_agent_mesh/gateway/base/base_llm_detail.txt +0 -235
  445. solace_agent_mesh/gateway/gateway_llm.txt +0 -373
  446. solace_agent_mesh/gateway/gateway_llm_detail.txt +0 -3885
  447. solace_agent_mesh/gateway/http_sse/alembic/alembic_llm.txt +0 -295
  448. solace_agent_mesh/gateway/http_sse/alembic/versions/versions_llm.txt +0 -155
  449. solace_agent_mesh/gateway/http_sse/components/components_llm.txt +0 -105
  450. solace_agent_mesh/gateway/http_sse/http_sse_llm.txt +0 -299
  451. solace_agent_mesh/gateway/http_sse/http_sse_llm_detail.txt +0 -3278
  452. solace_agent_mesh/gateway/http_sse/repository/entities/entities_llm.txt +0 -263
  453. solace_agent_mesh/gateway/http_sse/repository/models/models_llm.txt +0 -266
  454. solace_agent_mesh/gateway/http_sse/repository/repository_llm.txt +0 -340
  455. solace_agent_mesh/gateway/http_sse/routers/dto/dto_llm.txt +0 -346
  456. solace_agent_mesh/gateway/http_sse/routers/dto/requests/requests_llm.txt +0 -83
  457. solace_agent_mesh/gateway/http_sse/routers/dto/responses/responses_llm.txt +0 -107
  458. solace_agent_mesh/gateway/http_sse/routers/routers_llm.txt +0 -314
  459. solace_agent_mesh/gateway/http_sse/services/services_llm.txt +0 -297
  460. solace_agent_mesh/gateway/http_sse/shared/__init__.py +0 -146
  461. solace_agent_mesh/gateway/http_sse/shared/shared_llm.txt +0 -285
  462. solace_agent_mesh/gateway/http_sse/utils/utils_llm.txt +0 -47
  463. solace_agent_mesh/llm.txt +0 -228
  464. solace_agent_mesh/llm_detail.txt +0 -2835
  465. solace_agent_mesh/solace_agent_mesh_llm.txt +0 -362
  466. solace_agent_mesh/solace_agent_mesh_llm_detail.txt +0 -8599
  467. solace_agent_mesh/templates/logging_config_template.ini +0 -45
  468. solace_agent_mesh/templates/templates_llm.txt +0 -147
  469. solace_agent_mesh-1.6.1.dist-info/RECORD +0 -525
  470. /solace_agent_mesh/assets/docs/assets/js/{main.b12eac43.js.LICENSE.txt → main.d634009f.js.LICENSE.txt} +0 -0
  471. /solace_agent_mesh/{gateway/http_sse/shared → shared/api}/auth_utils.py +0 -0
  472. /solace_agent_mesh/{gateway/http_sse/shared → shared/api}/pagination.py +0 -0
  473. /solace_agent_mesh/{gateway/http_sse/shared → shared/api}/response_utils.py +0 -0
  474. /solace_agent_mesh/{gateway/http_sse/shared → shared/exceptions}/error_dto.py +0 -0
  475. /solace_agent_mesh/{gateway/http_sse/shared → shared/exceptions}/exceptions.py +0 -0
  476. /solace_agent_mesh/{gateway/http_sse/shared → shared/utils}/enums.py +0 -0
  477. /solace_agent_mesh/{gateway/http_sse/shared → shared/utils}/timestamp_utils.py +0 -0
  478. /solace_agent_mesh/{gateway/http_sse/shared → shared/utils}/types.py +0 -0
  479. /solace_agent_mesh/{gateway/http_sse/shared → shared/utils}/utils.py +0 -0
  480. {solace_agent_mesh-1.6.1.dist-info → solace_agent_mesh-1.13.2.dist-info}/entry_points.txt +0 -0
  481. {solace_agent_mesh-1.6.1.dist-info → solace_agent_mesh-1.13.2.dist-info}/licenses/LICENSE +0 -0
@@ -2,131 +2,144 @@
2
2
  <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-documentation/components/cli" data-has-hydrated="false">
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
- <meta name="generator" content="Docusaurus v3.8.1">
6
- <title data-rh="true">Agent Mesh CLI | Solace Agent Mesh</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://solacelabs.github.io/solace-agent-mesh/img/logo.png"><meta data-rh="true" name="twitter:image" content="https://solacelabs.github.io/solace-agent-mesh/img/logo.png"><meta data-rh="true" property="og:url" content="https://solacelabs.github.io/solace-agent-mesh/docs/documentation/components/cli"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Agent Mesh CLI | Solace Agent Mesh"><meta data-rh="true" name="description" content="Agent Mesh comes with a comprehensive CLI tool that you can use to create, and run an instance of Agent Mesh, which is referred to as an Agent Mesh application. Agent Mesh CLI also allows you to add agents and gateways, manage plugins, help you debug, and much more."><meta data-rh="true" property="og:description" content="Agent Mesh comes with a comprehensive CLI tool that you can use to create, and run an instance of Agent Mesh, which is referred to as an Agent Mesh application. Agent Mesh CLI also allows you to add agents and gateways, manage plugins, help you debug, and much more."><link data-rh="true" rel="icon" href="/solace-agent-mesh/img/logo.png"><link data-rh="true" rel="canonical" href="https://solacelabs.github.io/solace-agent-mesh/docs/documentation/components/cli"><link data-rh="true" rel="alternate" href="https://solacelabs.github.io/solace-agent-mesh/docs/documentation/components/cli" hreflang="en"><link data-rh="true" rel="alternate" href="https://solacelabs.github.io/solace-agent-mesh/docs/documentation/components/cli" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Components","item":"https://solacelabs.github.io/solace-agent-mesh/docs/documentation/components/"},{"@type":"ListItem","position":2,"name":"Agent Mesh CLI","item":"https://solacelabs.github.io/solace-agent-mesh/docs/documentation/components/cli"}]}</script><link rel="stylesheet" href="/solace-agent-mesh/assets/css/styles.906a1503.css">
7
- <script src="/solace-agent-mesh/assets/js/runtime~main.e268214e.js" defer="defer"></script>
8
- <script src="/solace-agent-mesh/assets/js/main.b12eac43.js" defer="defer"></script>
5
+ <meta name="generator" content="Docusaurus v3.9.2">
6
+ <title data-rh="true">Agent Mesh CLI | Solace Agent Mesh</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://solacelabs.github.io/solace-agent-mesh/img/logo.png"><meta data-rh="true" name="twitter:image" content="https://solacelabs.github.io/solace-agent-mesh/img/logo.png"><meta data-rh="true" property="og:url" content="https://solacelabs.github.io/solace-agent-mesh/docs/documentation/components/cli"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Agent Mesh CLI | Solace Agent Mesh"><meta data-rh="true" name="description" content="Agent Mesh comes with a comprehensive CLI tool that you can use to create, and run an instance of Agent Mesh, which is referred to as an Agent Mesh application. Agent Mesh CLI also allows you to add agents and gateways, manage plugins, help you debug, and much more."><meta data-rh="true" property="og:description" content="Agent Mesh comes with a comprehensive CLI tool that you can use to create, and run an instance of Agent Mesh, which is referred to as an Agent Mesh application. Agent Mesh CLI also allows you to add agents and gateways, manage plugins, help you debug, and much more."><link data-rh="true" rel="icon" href="/solace-agent-mesh/img/logo.png"><link data-rh="true" rel="canonical" href="https://solacelabs.github.io/solace-agent-mesh/docs/documentation/components/cli"><link data-rh="true" rel="alternate" href="https://solacelabs.github.io/solace-agent-mesh/docs/documentation/components/cli" hreflang="en"><link data-rh="true" rel="alternate" href="https://solacelabs.github.io/solace-agent-mesh/docs/documentation/components/cli" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Components","item":"https://solacelabs.github.io/solace-agent-mesh/docs/documentation/components/"},{"@type":"ListItem","position":2,"name":"Agent Mesh CLI","item":"https://solacelabs.github.io/solace-agent-mesh/docs/documentation/components/cli"}]}</script><link rel="stylesheet" href="/solace-agent-mesh/assets/css/styles.8162edfb.css">
7
+ <script src="/solace-agent-mesh/assets/js/runtime~main.27bb82a7.js" defer="defer"></script>
8
+ <script src="/solace-agent-mesh/assets/js/main.d634009f.js" defer="defer"></script>
9
9
  </head>
10
10
  <body class="navigation-with-keyboard">
11
- <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"><defs>
11
+ <svg style="display: none;"><defs>
12
12
  <symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
13
13
  </defs></svg>
14
- <script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><link rel="preload" as="image" href="/solace-agent-mesh/img/logo.png"><link rel="preload" as="image" href="/solace-agent-mesh/img/solace-logo.png"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/solace-agent-mesh/docs/documentation/getting-started"><div class="navbar__logo"><img src="/solace-agent-mesh/img/logo.png" alt="Solace Agent Mesh Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/solace-agent-mesh/img/logo.png" alt="Solace Agent Mesh Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">Solace Agent Mesh</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/solace-agent-mesh/docs/documentation/getting-started/">Documentation</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/SolaceLabs/solace-agent-mesh/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/solace-agent-mesh/docs/documentation/getting-started/">Getting Started</a><button aria-label="Collapse sidebar category &#x27;Getting Started&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/getting-started/introduction">What is Agent Mesh?</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/getting-started/try-agent-mesh">Try Agent Mesh</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/getting-started/architecture">Architecture Overview</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/solace-agent-mesh/docs/documentation/components/">Components</a><button aria-label="Collapse sidebar category &#x27;Components&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/agents">Agents</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/orchestrator">Orchestrator</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/proxies">Proxies</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/gateways">Gateways</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/plugins">Plugins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/cli">Agent Mesh CLI</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/builtin-tools/">Built-in Tools</a><button aria-label="Expand sidebar category &#x27;Built-in Tools&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/solace-agent-mesh/docs/documentation/installing-and-configuring/">Installing and Configuring Agent Mesh</a><button aria-label="Expand sidebar category &#x27;Installing and Configuring Agent Mesh&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/solace-agent-mesh/docs/documentation/developing/">Developing with Agent Mesh</a><button aria-label="Expand sidebar category &#x27;Developing with Agent Mesh&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/solace-agent-mesh/docs/documentation/deploying/">Deploying Agent Mesh</a><button aria-label="Expand sidebar category &#x27;Deploying Agent Mesh&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/solace-agent-mesh/docs/documentation/migrations/a2a-upgrade/a2a-gateway-upgrade-to-0.3.0">Migrations</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/solace-agent-mesh/docs/documentation/enterprise/">Agent Mesh Enterprise</a><button aria-label="Expand sidebar category &#x27;Agent Mesh Enterprise&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a class="breadcrumbs__link" href="/solace-agent-mesh/docs/documentation/components/"><span>Components</span></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Agent Mesh CLI</span></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Agent Mesh CLI</h1></header>
14
+ <script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><link rel="preload" as="image" href="/solace-agent-mesh/img/logo.png"><link rel="preload" as="image" href="/solace-agent-mesh/img/solace-logo.png"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/solace-agent-mesh/docs/documentation/getting-started"><div class="navbar__logo"><img src="/solace-agent-mesh/img/logo.png" alt="Solace Agent Mesh Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/solace-agent-mesh/img/logo.png" alt="Solace Agent Mesh Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">Solace Agent Mesh</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/solace-agent-mesh/docs/documentation/getting-started/">Documentation</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/SolaceLabs/solace-agent-mesh/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/solace-agent-mesh/docs/documentation/getting-started/"><span title="Getting Started" class="categoryLinkLabel_W154">Getting Started</span></a><button aria-label="Collapse sidebar category &#x27;Getting Started&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/getting-started/introduction"><span title="What is Agent Mesh?" class="linkLabel_WmDU">What is Agent Mesh?</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/getting-started/try-agent-mesh"><span title="Try Agent Mesh" class="linkLabel_WmDU">Try Agent Mesh</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/getting-started/architecture"><span title="Architecture Overview" class="linkLabel_WmDU">Architecture Overview</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/getting-started/vibe_coding"><span title="Vibe Coding" class="linkLabel_WmDU">Vibe Coding</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--active" href="/solace-agent-mesh/docs/documentation/components/"><span title="Components" class="categoryLinkLabel_W154">Components</span></a><button aria-label="Collapse sidebar category &#x27;Components&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/agents"><span title="Agents" class="linkLabel_WmDU">Agents</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/orchestrator"><span title="Orchestrator" class="linkLabel_WmDU">Orchestrator</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/proxies"><span title="Proxies" class="linkLabel_WmDU">Proxies</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/gateways"><span title="Gateways" class="linkLabel_WmDU">Gateways</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/platform-service"><span title="Platform Service" class="linkLabel_WmDU">Platform Service</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/plugins"><span title="Plugins" class="linkLabel_WmDU">Plugins</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/projects"><span title="Projects" class="linkLabel_WmDU">Projects</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/cli"><span title="Agent Mesh CLI" class="linkLabel_WmDU">Agent Mesh CLI</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/builtin-tools/"><span title="Built-in Tools" class="categoryLinkLabel_W154">Built-in Tools</span></a><button aria-label="Expand sidebar category &#x27;Built-in Tools&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/prompts"><span title="Prompt Library" class="linkLabel_WmDU">Prompt Library</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/solace-agent-mesh/docs/documentation/components/speech"><span title="Speech Integration" class="linkLabel_WmDU">Speech Integration</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/solace-agent-mesh/docs/documentation/installing-and-configuring/"><span title="Installing and Configuring Agent Mesh" class="categoryLinkLabel_W154">Installing and Configuring Agent Mesh</span></a><button aria-label="Expand sidebar category &#x27;Installing and Configuring Agent Mesh&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/solace-agent-mesh/docs/documentation/developing/"><span title="Developing with Agent Mesh" class="categoryLinkLabel_W154">Developing with Agent Mesh</span></a><button aria-label="Expand sidebar category &#x27;Developing with Agent Mesh&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/solace-agent-mesh/docs/documentation/deploying/"><span title="Deploying Agent Mesh" class="categoryLinkLabel_W154">Deploying Agent Mesh</span></a><button aria-label="Expand sidebar category &#x27;Deploying Agent Mesh&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/solace-agent-mesh/docs/documentation/migrations/platform-service-split"><span title="Migrations" class="categoryLinkLabel_W154">Migrations</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist" href="/solace-agent-mesh/docs/documentation/enterprise/"><span title="Agent Mesh Enterprise" class="categoryLinkLabel_W154">Agent Mesh Enterprise</span></a><button aria-label="Expand sidebar category &#x27;Agent Mesh Enterprise&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a class="breadcrumbs__link" href="/solace-agent-mesh/docs/documentation/components/"><span>Components</span></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Agent Mesh CLI</span></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Agent Mesh CLI</h1></header>
15
15
  <p>Agent Mesh comes with a comprehensive CLI tool that you can use to create, and run an instance of Agent Mesh, which is referred to as an Agent Mesh application. Agent Mesh CLI also allows you to add agents and gateways, manage plugins, help you debug, and much more.</p>
16
- <h2 class="anchor anchorWithStickyNavbar_LWe7" id="installation">Installation<a href="#installation" class="hash-link" aria-label="Direct link to Installation" title="Direct link to Installation">​</a></h2>
17
- <p>The Agent Mesh CLI is installed as part of the Agent Mesh package. For more information, see <a href="/solace-agent-mesh/docs/documentation/installing-and-configuring/installation">Installation</a>.</p>
16
+ <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="installation">Installation<a href="#installation" class="hash-link" aria-label="Direct link to Installation" title="Direct link to Installation" translate="no">​</a></h2>
17
+ <p>The Agent Mesh CLI is installed as part of the Agent Mesh package. For more information, see <a class="" href="/solace-agent-mesh/docs/documentation/installing-and-configuring/installation">Installation</a>.</p>
18
18
  <div class="theme-admonition theme-admonition-tip admonition_xJq3 alert alert--success"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>CLI Tips</div><div class="admonitionContent_BuS1"><ul>
19
- <li>The Agent Mesh CLI comes with a short alias of <code>sam</code> which can be used in place of <code>solace-agent-mesh</code>.</li>
20
- <li>You can determine the version of the Agent Mesh CLI by running <code>solace-agent-mesh --version</code>.</li>
21
- <li>You can get help on any command by running <code>solace-agent-mesh [COMMAND] --help</code>.</li>
19
+ <li class="">The Agent Mesh CLI comes with a short alias of <code>sam</code> which can be used in place of <code>solace-agent-mesh</code>.</li>
20
+ <li class="">You can determine the version of the Agent Mesh CLI by running <code>solace-agent-mesh --version</code>.</li>
21
+ <li class="">You can get help on any command by running <code>solace-agent-mesh [COMMAND] --help</code>.</li>
22
22
  </ul></div></div>
23
- <h2 class="anchor anchorWithStickyNavbar_LWe7" id="commands">Commands<a href="#commands" class="hash-link" aria-label="Direct link to Commands" title="Direct link to Commands">​</a></h2>
24
- <h3 class="anchor anchorWithStickyNavbar_LWe7" id="init---initialize-an-agent-mesh-application"><code>init</code> - Initialize an Agent Mesh Application<a href="#init---initialize-an-agent-mesh-application" class="hash-link" aria-label="Direct link to init---initialize-an-agent-mesh-application" title="Direct link to init---initialize-an-agent-mesh-application">​</a></h3>
23
+ <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="commands">Commands<a href="#commands" class="hash-link" aria-label="Direct link to Commands" title="Direct link to Commands" translate="no">​</a></h2>
24
+ <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="init---initialize-an-agent-mesh-application"><code>init</code> - Initialize an Agent Mesh Application<a href="#init---initialize-an-agent-mesh-application" class="hash-link" aria-label="Direct link to init---initialize-an-agent-mesh-application" title="Direct link to init---initialize-an-agent-mesh-application" translate="no">​</a></h3>
25
25
  <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam init [OPTIONS]</span><br></span></code></pre></div></div>
26
26
  <p>When this command is run with no options, it runs in interactive mode. It first prompts you to choose between configuring your project in the terminal or through a browser-based interface.</p>
27
27
  <p>If you choose to use the browser, the Agent Mesh CLI starts a local web configuration portal, available at <code>http://127.0.0.1:5002</code></p>
28
28
  <p>You can skip some questions by providing the appropriate options for that step during the Agent Mesh CLI-based setup.</p>
29
29
  <p>Optionally, you can skip all the questions by providing the <code>--skip</code> option. This option uses the provided or default values for all the questions.</p>
30
30
  <div class="theme-admonition theme-admonition-tip admonition_xJq3 alert alert--success"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>automated workflows</div><div class="admonitionContent_BuS1"><p>Use the <code>--skip</code> option and provide the necessary options to run the command in non-interactive mode, useful for automated workflows.</p></div></div>
31
- <h5 class="anchor anchorWithStickyNavbar_LWe7" id="options">Options:<a href="#options" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:">​</a></h5>
31
+ <h5 class="anchor anchorTargetStickyNavbar_Vzrq" id="options">Options:<a href="#options" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:" translate="no">​</a></h5>
32
32
  <ul>
33
- <li><code>--gui</code> – Launch the browser-based initialization interface directly, skipping the prompt. (Recommended way to configure Agent Mesh applications)</li>
34
- <li><code>--skip</code> – Runs in non-interactive mode, using default values where available.</li>
35
- <li><code>--llm-service-endpoint TEXT</code> – LLM Service Endpoint URL.</li>
36
- <li><code>--llm-service-api-key TEXT</code> – LLM Service API Key.</li>
37
- <li><code>--llm-service-planning-model-name TEXT</code> – LLM Planning Model Name.</li>
38
- <li><code>--llm-service-general-model-name TEXT</code> – LLM General Model Name.</li>
39
- <li><code>--namespace TEXT</code> – Namespace for the project.</li>
40
- <li><code>--broker-type TEXT</code> – Broker type: 1/solace (existing), 2/container (new local), 3/dev (dev mode). Options: 1, 2, 3, solace, container, dev_mode, dev_broker, dev.</li>
41
- <li><code>--broker-url TEXT</code> – Solace broker URL endpoint.</li>
42
- <li><code>--broker-vpn TEXT</code> – Solace broker VPN name.</li>
43
- <li><code>--broker-username TEXT</code> – Solace broker username.</li>
44
- <li><code>--broker-password TEXT</code> – Solace broker password.</li>
45
- <li><code>--container-engine TEXT</code> – Container engine for local broker. Options: podman, docker.</li>
46
- <li><code>--dev-mode</code> – Shortcut to select dev mode for broker (equivalent to --broker-type 3/dev).</li>
47
- <li><code>--agent-name TEXT</code> – Agent name for the main orchestrator.</li>
48
- <li><code>--supports-streaming</code> – Enable streaming support for the agent.</li>
49
- <li><code>--session-service-type TEXT</code> – Session service type. Options: memory, vertex_rag.</li>
50
- <li><code>--session-service-behavior TEXT</code> – Session service behavior. Options: PERSISTENT, RUN_BASED.</li>
51
- <li><code>--artifact-service-type TEXT</code> – Artifact service type. Options: memory, filesystem, gcs.</li>
52
- <li><code>--artifact-service-base-path TEXT</code> – Artifact service base path (for filesystem type).</li>
53
- <li><code>--artifact-service-scope TEXT</code> – Artifact service scope. Options: namespace, app, custom.</li>
54
- <li><code>--artifact-handling-mode TEXT</code> – Artifact handling mode. Options: ignore, embed, reference.</li>
55
- <li><code>--enable-embed-resolution</code> – Enable embed resolution.</li>
56
- <li><code>--enable-artifact-content-instruction</code> – Enable artifact content instruction.</li>
57
- <li><code>--enable-builtin-artifact-tools</code> – Enable built-in artifact tools.</li>
58
- <li><code>--enable-builtin-data-tools</code> – Enable built-in data tools.</li>
59
- <li><code>--agent-card-description TEXT</code> – Agent card description.</li>
60
- <li><code>--agent-card-default-input-modes TEXT</code> – Agent card default input modes (comma-separated).</li>
61
- <li><code>--agent-card-default-output-modes TEXT</code> – Agent card default output modes (comma-separated).</li>
62
- <li><code>--agent-discovery-enabled</code> – Enable agent discovery.</li>
63
- <li><code>--agent-card-publishing-interval INTEGER</code> – Agent card publishing interval (seconds).</li>
64
- <li><code>--inter-agent-communication-allow-list TEXT</code> – Inter-agent communication allow list (comma-separated, use * for all).</li>
65
- <li><code>--inter-agent-communication-deny-list TEXT</code> – Inter-agent communication deny list (comma-separated).</li>
66
- <li><code>--inter-agent-communication-timeout INTEGER</code> – Inter-agent communication timeout (seconds).</li>
67
- <li><code>--add-webui-gateway</code> – Add a default Web UI gateway configuration.</li>
68
- <li><code>--webui-session-secret-key TEXT</code> – Session secret key for Web UI.</li>
69
- <li><code>--webui-fastapi-host TEXT</code> – Host for Web UI FastAPI server.</li>
70
- <li><code>--webui-fastapi-port INTEGER</code> – Port for Web UI FastAPI server.</li>
71
- <li><code>--webui-enable-embed-resolution</code> – Enable embed resolution for Web UI.</li>
72
- <li><code>--webui-frontend-welcome-message TEXT</code> – Frontend welcome message for Web UI.</li>
73
- <li><code>--webui-frontend-bot-name TEXT</code> – Frontend bot name for Web UI.</li>
74
- <li><code>--webui-frontend-collect-feedback</code> – Enable feedback collection in Web UI.</li>
75
- <li><code>-h, --help</code> – Displays the help message and exits.</li>
33
+ <li class=""><code>--gui</code> – Launch the browser-based initialization interface directly, skipping the prompt. (Recommended way to configure Agent Mesh applications)</li>
34
+ <li class=""><code>--skip</code> – Runs in non-interactive mode, using default values where available.</li>
35
+ <li class=""><code>--llm-service-endpoint TEXT</code> – LLM Service Endpoint URL.</li>
36
+ <li class=""><code>--llm-service-api-key TEXT</code> – LLM Service API Key.</li>
37
+ <li class=""><code>--llm-service-planning-model-name TEXT</code> – LLM Planning Model Name.</li>
38
+ <li class=""><code>--llm-service-general-model-name TEXT</code> – LLM General Model Name.</li>
39
+ <li class=""><code>--namespace TEXT</code> – Namespace for the project.</li>
40
+ <li class=""><code>--broker-type TEXT</code> – Broker type: 1/solace (existing), 2/container (new local), 3/dev (dev mode). Options: 1, 2, 3, solace, container, dev_mode, dev_broker, dev.</li>
41
+ <li class=""><code>--broker-url TEXT</code> – Solace broker URL endpoint.</li>
42
+ <li class=""><code>--broker-vpn TEXT</code> – Solace broker VPN name.</li>
43
+ <li class=""><code>--broker-username TEXT</code> – Solace broker username.</li>
44
+ <li class=""><code>--broker-password TEXT</code> – Solace broker password.</li>
45
+ <li class=""><code>--container-engine TEXT</code> – Container engine for local broker. Options: podman, docker.</li>
46
+ <li class=""><code>--dev-mode</code> – Shortcut to select dev mode for broker (equivalent to --broker-type 3/dev).</li>
47
+ <li class=""><code>--agent-name TEXT</code> – Agent name for the main orchestrator.</li>
48
+ <li class=""><code>--supports-streaming</code> – Enable streaming support for the agent.</li>
49
+ <li class=""><code>--session-service-type TEXT</code> – Session service type. Options: memory, vertex_rag.</li>
50
+ <li class=""><code>--session-service-behavior TEXT</code> – Session service behavior. Options: PERSISTENT, RUN_BASED.</li>
51
+ <li class=""><code>--artifact-service-type TEXT</code> – Artifact service type. Options: memory, filesystem, gcs.</li>
52
+ <li class=""><code>--artifact-service-base-path TEXT</code> – Artifact service base path (for filesystem type).</li>
53
+ <li class=""><code>--artifact-service-scope TEXT</code> – Artifact service scope. Options: namespace, app, custom.</li>
54
+ <li class=""><code>--artifact-handling-mode TEXT</code> – Artifact handling mode. Options: ignore, embed, reference.</li>
55
+ <li class=""><code>--enable-embed-resolution</code> – Enable embed resolution.</li>
56
+ <li class=""><code>--enable-artifact-content-instruction</code> – Enable artifact content instruction.</li>
57
+ <li class=""><code>--enable-builtin-artifact-tools</code> – Enable built-in artifact tools.</li>
58
+ <li class=""><code>--enable-builtin-data-tools</code> – Enable built-in data tools.</li>
59
+ <li class=""><code>--agent-card-description TEXT</code> – Agent card description.</li>
60
+ <li class=""><code>--agent-card-default-input-modes TEXT</code> – Agent card default input modes (comma-separated).</li>
61
+ <li class=""><code>--agent-card-default-output-modes TEXT</code> – Agent card default output modes (comma-separated).</li>
62
+ <li class=""><code>--agent-discovery-enabled</code> – Enable agent discovery.</li>
63
+ <li class=""><code>--agent-card-publishing-interval INTEGER</code> – Agent card publishing interval (seconds).</li>
64
+ <li class=""><code>--inter-agent-communication-allow-list TEXT</code> – Inter-agent communication allow list (comma-separated, use * for all).</li>
65
+ <li class=""><code>--inter-agent-communication-deny-list TEXT</code> – Inter-agent communication deny list (comma-separated).</li>
66
+ <li class=""><code>--inter-agent-communication-timeout INTEGER</code> – Inter-agent communication timeout (seconds).</li>
67
+ <li class=""><code>--add-webui-gateway</code> – Add a default Web UI gateway configuration.</li>
68
+ <li class=""><code>--webui-session-secret-key TEXT</code> – Session secret key for Web UI.</li>
69
+ <li class=""><code>--webui-fastapi-host TEXT</code> – Host for Web UI FastAPI server.</li>
70
+ <li class=""><code>--webui-fastapi-port INTEGER</code> – Port for Web UI FastAPI server.</li>
71
+ <li class=""><code>--webui-enable-embed-resolution</code> – Enable embed resolution for Web UI.</li>
72
+ <li class=""><code>--webui-frontend-welcome-message TEXT</code> – Frontend welcome message for Web UI.</li>
73
+ <li class=""><code>--webui-frontend-bot-name TEXT</code> – Frontend bot name for Web UI.</li>
74
+ <li class=""><code>--webui-frontend-logo-url TEXT</code> – URL to a custom logo image for the Web UI interface. Supports PNG, SVG, JPG formats, as well as data URIs for embedded images.</li>
75
+ <li class=""><code>--webui-frontend-collect-feedback</code> – Enable feedback collection in Web UI.</li>
76
+ <li class=""><code>-h, --help</code> – Displays the help message and exits.</li>
76
77
  </ul>
77
- <h3 class="anchor anchorWithStickyNavbar_LWe7" id="add---create-a-new-component"><code>add</code> - Create a New Component<a href="#add---create-a-new-component" class="hash-link" aria-label="Direct link to add---create-a-new-component" title="Direct link to add---create-a-new-component">​</a></h3>
78
- <p>To add a new component, such as an agent or gateway, use the <code>add</code> command with the appropriate options.</p>
79
- <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam add [agent|gateway] [OPTIONS] NAME</span><br></span></code></pre></div></div>
80
- <h4 class="anchor anchorWithStickyNavbar_LWe7" id="add-agent">Add <code>agent</code><a href="#add-agent" class="hash-link" aria-label="Direct link to add-agent" title="Direct link to add-agent">​</a></h4>
78
+ <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="add---create-a-new-component"><code>add</code> - Create a New Component<a href="#add---create-a-new-component" class="hash-link" aria-label="Direct link to add---create-a-new-component" title="Direct link to add---create-a-new-component" translate="no">​</a></h3>
79
+ <p>To add a new component, such as an agent, gateway, or proxy, use the <code>add</code> command with the appropriate options.</p>
80
+ <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam add [agent|gateway|proxy] [OPTIONS] NAME</span><br></span></code></pre></div></div>
81
+ <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="add-agent">Add <code>agent</code><a href="#add-agent" class="hash-link" aria-label="Direct link to add-agent" title="Direct link to add-agent" translate="no">​</a></h4>
81
82
  <p>Use <code>agent</code> to add an agent component.</p>
82
83
  <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam add agent [OPTIONS] [NAME]</span><br></span></code></pre></div></div>
83
- <h5 class="anchor anchorWithStickyNavbar_LWe7" id="options-1">Options:<a href="#options-1" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:">​</a></h5>
84
+ <h5 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-1">Options:<a href="#options-1" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:" translate="no">​</a></h5>
84
85
  <ul>
85
- <li><code>--gui</code> – Launch the browser-based configuration interface for agent setup. (Recommended way to configure agents)</li>
86
- <li><code>--skip</code> – Skip interactive prompts and use defaults (Agent Mesh CLI mode only).</li>
87
- <li><code>--namespace TEXT</code> – namespace (for example, myorg/dev).</li>
88
- <li><code>--supports-streaming BOOLEAN</code> – Enable streaming support.</li>
89
- <li><code>--model-type TEXT</code> – Model type for the agent. Options: planning, general, image_gen, report_gen, multimodal, gemini_pro.</li>
90
- <li><code>--instruction TEXT</code> – Custom instruction for the agent.</li>
91
- <li><code>--session-service-type TEXT</code> – Session service type. Options: memory, vertex_rag.</li>
92
- <li><code>--session-service-behavior TEXT</code> – Session service behavior. Options: PERSISTENT, RUN_BASED.</li>
93
- <li><code>--artifact-service-type TEXT</code> – Artifact service type. Options: memory, filesystem, gcs.</li>
94
- <li><code>--artifact-service-base-path TEXT</code> – Base path for filesystem artifact service.</li>
95
- <li><code>--artifact-service-scope TEXT</code> – Artifact service scope. Options: namespace, app, custom.</li>
96
- <li><code>--artifact-handling-mode TEXT</code> – Artifact handling mode. Options: ignore, embed, reference.</li>
97
- <li><code>--enable-embed-resolution BOOLEAN</code> – Enable embed resolution.</li>
98
- <li><code>--enable-artifact-content-instruction BOOLEAN</code> – Enable artifact content instruction.</li>
99
- <li><code>--enable-builtin-artifact-tools BOOLEAN</code> – Enable built-in artifact tools.</li>
100
- <li><code>--enable-builtin-data-tools BOOLEAN</code> – Enable built-in data tools.</li>
101
- <li><code>--agent-card-description TEXT</code> – Description for the agent card.</li>
102
- <li><code>--agent-card-default-input-modes-str TEXT</code> – Comma-separated default input modes for agent card.</li>
103
- <li><code>--agent-card-default-output-modes-str TEXT</code> – Comma-separated default output modes for agent card.</li>
104
- <li><code>--agent-card-publishing-interval INTEGER</code> – Agent card publishing interval in seconds.</li>
105
- <li><code>--agent-discovery-enabled BOOLEAN</code> – Enable agent discovery.</li>
106
- <li><code>--inter-agent-communication-allow-list-str TEXT</code> – Comma-separated allow list for inter-agent communication.</li>
107
- <li><code>--inter-agent-communication-deny-list-str TEXT</code> – Comma-separated deny list for inter-agent communication.</li>
108
- <li><code>--inter-agent-communication-timeout INTEGER</code> – Timeout in seconds for inter-agent communication.</li>
109
- <li><code>-h, --help</code> – Displays the help message and exits.</li>
86
+ <li class=""><code>--gui</code> – Launch the browser-based configuration interface for agent setup. (Recommended way to configure agents)</li>
87
+ <li class=""><code>--skip</code> – Skip interactive prompts and use defaults (Agent Mesh CLI mode only).</li>
88
+ <li class=""><code>--namespace TEXT</code> – namespace (for example, myorg/dev).</li>
89
+ <li class=""><code>--supports-streaming BOOLEAN</code> – Enable streaming support.</li>
90
+ <li class=""><code>--model-type TEXT</code> – Model type for the agent. Options: planning, general, image_gen, report_gen, multimodal, gemini_pro.</li>
91
+ <li class=""><code>--instruction TEXT</code> – Custom instruction for the agent.</li>
92
+ <li class=""><code>--session-service-type TEXT</code> – Session service type. Options: memory, vertex_rag.</li>
93
+ <li class=""><code>--session-service-behavior TEXT</code> – Session service behavior. Options: PERSISTENT, RUN_BASED.</li>
94
+ <li class=""><code>--artifact-service-type TEXT</code> – Artifact service type. Options: memory, filesystem, gcs.</li>
95
+ <li class=""><code>--artifact-service-base-path TEXT</code> – Base path for filesystem artifact service.</li>
96
+ <li class=""><code>--artifact-service-scope TEXT</code> – Artifact service scope. Options: namespace, app, custom.</li>
97
+ <li class=""><code>--artifact-handling-mode TEXT</code> – Artifact handling mode. Options: ignore, embed, reference.</li>
98
+ <li class=""><code>--enable-embed-resolution BOOLEAN</code> – Enable embed resolution.</li>
99
+ <li class=""><code>--enable-artifact-content-instruction BOOLEAN</code> – Enable artifact content instruction.</li>
100
+ <li class=""><code>--enable-builtin-artifact-tools BOOLEAN</code> – Enable built-in artifact tools.</li>
101
+ <li class=""><code>--enable-builtin-data-tools BOOLEAN</code> – Enable built-in data tools.</li>
102
+ <li class=""><code>--agent-card-description TEXT</code> – Description for the agent card.</li>
103
+ <li class=""><code>--agent-card-default-input-modes-str TEXT</code> – Comma-separated default input modes for agent card.</li>
104
+ <li class=""><code>--agent-card-default-output-modes-str TEXT</code> – Comma-separated default output modes for agent card.</li>
105
+ <li class=""><code>--agent-card-publishing-interval INTEGER</code> – Agent card publishing interval in seconds.</li>
106
+ <li class=""><code>--agent-discovery-enabled BOOLEAN</code> – Enable agent discovery.</li>
107
+ <li class=""><code>--inter-agent-communication-allow-list-str TEXT</code> – Comma-separated allow list for inter-agent communication.</li>
108
+ <li class=""><code>--inter-agent-communication-deny-list-str TEXT</code> – Comma-separated deny list for inter-agent communication.</li>
109
+ <li class=""><code>--inter-agent-communication-timeout INTEGER</code> – Timeout in seconds for inter-agent communication.</li>
110
+ <li class=""><code>-h, --help</code> – Displays the help message and exits.</li>
110
111
  </ul>
111
- <p>For more information, see <a href="/solace-agent-mesh/docs/documentation/components/agents">Agents</a>.</p>
112
- <h4 class="anchor anchorWithStickyNavbar_LWe7" id="add-gateway">Add <code>gateway</code><a href="#add-gateway" class="hash-link" aria-label="Direct link to add-gateway" title="Direct link to add-gateway">​</a></h4>
112
+ <p>For more information, see <a class="" href="/solace-agent-mesh/docs/documentation/components/agents">Agents</a>.</p>
113
+ <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="add-gateway">Add <code>gateway</code><a href="#add-gateway" class="hash-link" aria-label="Direct link to add-gateway" title="Direct link to add-gateway" translate="no">​</a></h4>
113
114
  <p>Use <code>gateway</code> to add a gateway component.</p>
114
115
  <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam add gateway [OPTIONS] [NAME]</span><br></span></code></pre></div></div>
115
- <h5 class="anchor anchorWithStickyNavbar_LWe7" id="options-2">Options:<a href="#options-2" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:">​</a></h5>
116
+ <h5 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-2">Options:<a href="#options-2" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:" translate="no">​</a></h5>
116
117
  <ul>
117
- <li><code>--gui</code> – Launch the browser-based configuration interface for gateway setup. (Recommended way to configure gateways)</li>
118
- <li><code>--skip</code> – Skip interactive prompts and use defaults (Agent Mesh CLI mode only).</li>
119
- <li><code>--namespace TEXT</code> – namespace for the gateway (for example, myorg/dev).</li>
120
- <li><code>--gateway-id TEXT</code> – Custom Gateway ID for the gateway.</li>
121
- <li><code>--artifact-service-type TEXT</code> – Artifact service type for the gateway. Options: memory, filesystem, gcs.</li>
122
- <li><code>--artifact-service-base-path TEXT</code> – Base path for filesystem artifact service (if type is &#x27;filesystem&#x27;).</li>
123
- <li><code>--artifact-service-scope TEXT</code> – Artifact service scope (if not using default shared artifact service). Options: namespace, app, custom.</li>
124
- <li><code>--system-purpose TEXT</code> – System purpose for the gateway (can be multi-line).</li>
125
- <li><code>--response-format TEXT</code> – Response format for the gateway (can be multi-line).</li>
126
- <li><code>-h, --help</code> – Displays the help message and exits.</li>
118
+ <li class=""><code>--gui</code> – Launch the browser-based configuration interface for gateway setup. (Recommended way to configure gateways)</li>
119
+ <li class=""><code>--skip</code> – Skip interactive prompts and use defaults (Agent Mesh CLI mode only).</li>
120
+ <li class=""><code>--namespace TEXT</code> – namespace for the gateway (for example, myorg/dev).</li>
121
+ <li class=""><code>--gateway-id TEXT</code> – Custom Gateway ID for the gateway.</li>
122
+ <li class=""><code>--artifact-service-type TEXT</code> – Artifact service type for the gateway. Options: memory, filesystem, gcs.</li>
123
+ <li class=""><code>--artifact-service-base-path TEXT</code> – Base path for filesystem artifact service (if type is &#x27;filesystem&#x27;).</li>
124
+ <li class=""><code>--artifact-service-scope TEXT</code> – Artifact service scope (if not using default shared artifact service). Options: namespace, app, custom.</li>
125
+ <li class=""><code>--system-purpose TEXT</code> – System purpose for the gateway (can be multi-line).</li>
126
+ <li class=""><code>--response-format TEXT</code> – Response format for the gateway (can be multi-line).</li>
127
+ <li class=""><code>-h, --help</code> – Displays the help message and exits.</li>
127
128
  </ul>
128
- <p>For more information, see <a href="/solace-agent-mesh/docs/documentation/components/gateways">Gateways</a>.</p>
129
- <h3 class="anchor anchorWithStickyNavbar_LWe7" id="run---run-the-agent-mesh-application"><code>run</code> - Run the Agent Mesh Application<a href="#run---run-the-agent-mesh-application" class="hash-link" aria-label="Direct link to run---run-the-agent-mesh-application" title="Direct link to run---run-the-agent-mesh-application">​</a></h3>
129
+ <p>For more information, see <a class="" href="/solace-agent-mesh/docs/documentation/components/gateways">Gateways</a>.</p>
130
+ <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="add-proxy">Add <code>proxy</code><a href="#add-proxy" class="hash-link" aria-label="Direct link to add-proxy" title="Direct link to add-proxy" translate="no">​</a></h4>
131
+ <p>Use <code>proxy</code> to add an A2A proxy component that bridges external HTTP-based agents to the Solace Agent Mesh.</p>
132
+ <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam add proxy [OPTIONS] [NAME]</span><br></span></code></pre></div></div>
133
+ <p>The proxy command creates a configuration file in <code>configs/agents/</code> that you can customize to connect external agents to the mesh.</p>
134
+ <h5 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-3">Options:<a href="#options-3" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:" translate="no">​</a></h5>
135
+ <ul>
136
+ <li class=""><code>--skip</code> – Skip interactive prompts and create the proxy with default template.</li>
137
+ <li class=""><code>-h, --help</code> – Displays the help message and exits.</li>
138
+ </ul>
139
+ <h5 class="anchor anchorTargetStickyNavbar_Vzrq" id="example">Example:<a href="#example" class="hash-link" aria-label="Direct link to Example:" title="Direct link to Example:" translate="no">​</a></h5>
140
+ <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam add proxy myProxy --skip</span><br></span></code></pre></div></div>
141
+ <p>This creates <code>configs/agents/my_proxy_proxy.yaml</code> with the default proxy configuration template.</p>
142
+ <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="run---run-the-agent-mesh-application"><code>run</code> - Run the Agent Mesh Application<a href="#run---run-the-agent-mesh-application" class="hash-link" aria-label="Direct link to run---run-the-agent-mesh-application" title="Direct link to run---run-the-agent-mesh-application" translate="no">​</a></h3>
130
143
  <p>To run the Agent Mesh application, use the <code>run</code> command.</p>
131
144
  <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam run [OPTIONS] [FILES]...</span><br></span></code></pre></div></div>
132
145
  <div class="theme-admonition theme-admonition-info admonition_xJq3 alert alert--info"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>Environment variables</div><div class="admonitionContent_BuS1"><p>The <code>sam run</code> command automatically loads environment variables from your configuration file (typically a <code>.env</code> file at the project root) by default.</p><p>If you want to use your system&#x27;s environment variables instead, you can add the <code>-u</code> or <code>--system-env</code> option.</p></div></div>
@@ -136,83 +149,104 @@
136
149
  <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">solace-agent-mesh run configs/agent1.yaml configs/gateway.yaml</span><br></span></code></pre></div></div>
137
150
  <p>To run all YAML files within the <code>configs</code> directory:</p>
138
151
  <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">solace-agent-mesh run configs/</span><br></span></code></pre></div></div>
139
- <h5 class="anchor anchorWithStickyNavbar_LWe7" id="options-3">Options:<a href="#options-3" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:">​</a></h5>
152
+ <h5 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-4">Options:<a href="#options-4" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:" translate="no">​</a></h5>
140
153
  <ul>
141
- <li><code>-u, --system-env</code> – Use system environment variables only; do not load .env file.</li>
142
- <li><code>-s, --skip TEXT</code> – File name(s) to exclude from the run (for example, -s my_agent.yaml).</li>
143
- <li><code>-h, --help</code> – Displays the help message and exits.</li>
154
+ <li class=""><code>-u, --system-env</code> – Use system environment variables only; do not load .env file.</li>
155
+ <li class=""><code>-s, --skip TEXT</code> – File name(s) to exclude from the run (for example, -s my_agent.yaml).</li>
156
+ <li class=""><code>-h, --help</code> – Displays the help message and exits.</li>
144
157
  </ul>
145
- <h3 class="anchor anchorWithStickyNavbar_LWe7" id="docs---serve-the-documentation-locally"><code>docs</code> - Serve the documentation locally<a href="#docs---serve-the-documentation-locally" class="hash-link" aria-label="Direct link to docs---serve-the-documentation-locally" title="Direct link to docs---serve-the-documentation-locally">​</a></h3>
158
+ <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="docs---serve-the-documentation-locally"><code>docs</code> - Serve the documentation locally<a href="#docs---serve-the-documentation-locally" class="hash-link" aria-label="Direct link to docs---serve-the-documentation-locally" title="Direct link to docs---serve-the-documentation-locally" translate="no">​</a></h3>
146
159
  <p>Serves the project documentation on a local web server.</p>
147
160
  <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam docs [OPTIONS]</span><br></span></code></pre></div></div>
148
161
  <p>This command starts a web server to host the documentation, which is useful for offline viewing or development. By default, it serves the documentation at <code>http://localhost:8585/solace-agent-mesh/</code> and automatically opens your web browser to the getting started page.</p>
149
162
  <p>If a requested page is not found, it will redirect to the main documentation page.</p>
150
- <h5 class="anchor anchorWithStickyNavbar_LWe7" id="options-4">Options:<a href="#options-4" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:">​</a></h5>
163
+ <h5 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-5">Options:<a href="#options-5" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:" translate="no">​</a></h5>
164
+ <ul>
165
+ <li class=""><code>-p, --port INTEGER</code> – Port to run the web server on. (default: 8585)</li>
166
+ <li class=""><code>-h, --help</code> – Displays the help message and exits.</li>
167
+ </ul>
168
+ <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="tools---manage-and-explore-built-in-tools"><code>tools</code> - Manage and Explore Built-in Tools<a href="#tools---manage-and-explore-built-in-tools" class="hash-link" aria-label="Direct link to tools---manage-and-explore-built-in-tools" title="Direct link to tools---manage-and-explore-built-in-tools" translate="no">​</a></h3>
169
+ <p>The <code>tools</code> command allows you to explore and manage built-in tools available in Solace Agent Mesh.</p>
170
+ <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam tools [COMMAND] [OPTIONS]</span><br></span></code></pre></div></div>
171
+ <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="list---list-built-in-tools"><code>list</code> - List Built-in Tools<a href="#list---list-built-in-tools" class="hash-link" aria-label="Direct link to list---list-built-in-tools" title="Direct link to list---list-built-in-tools" translate="no">​</a></h4>
172
+ <p>Lists all built-in tools available in Solace Agent Mesh. By default, shows brief information with tool names and descriptions.</p>
173
+ <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam tools list [OPTIONS]</span><br></span></code></pre></div></div>
174
+ <p>This command is useful for:</p>
175
+ <ul>
176
+ <li class="">Discovering what built-in tools are available for your agents</li>
177
+ <li class="">Understanding tool capabilities and required parameters</li>
178
+ <li class="">Filtering tools by category</li>
179
+ <li class="">Exporting tool information in JSON format</li>
180
+ </ul>
181
+ <h5 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-6">Options:<a href="#options-6" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:" translate="no">​</a></h5>
151
182
  <ul>
152
- <li><code>-p, --port INTEGER</code> – Port to run the web server on. (default: 8585)</li>
153
- <li><code>-h, --help</code> – Displays the help message and exits.</li>
183
+ <li class=""><code>-c, --category TEXT</code> – Filter tools by category (e.g., &#x27;artifact_management&#x27;, &#x27;data_analysis&#x27;, &#x27;web&#x27;).</li>
184
+ <li class=""><code>-d, --detailed</code> – Show detailed information including parameters and required scopes.</li>
185
+ <li class=""><code>--json</code> – Output in JSON format instead of pretty table.</li>
186
+ <li class=""><code>-h, --help</code> – Displays the help message.</li>
154
187
  </ul>
155
- <h3 class="anchor anchorWithStickyNavbar_LWe7" id="plugin---manage-plugins"><code>plugin</code> - Manage Plugins<a href="#plugin---manage-plugins" class="hash-link" aria-label="Direct link to plugin---manage-plugins" title="Direct link to plugin---manage-plugins">​</a></h3>
188
+ <p>For more information about built-in tools, see <a class="" href="/solace-agent-mesh/docs/documentation/components/builtin-tools/">Built-in Tools</a></p>
189
+ <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="plugin---manage-plugins"><code>plugin</code> - Manage Plugins<a href="#plugin---manage-plugins" class="hash-link" aria-label="Direct link to plugin---manage-plugins" title="Direct link to plugin---manage-plugins" translate="no">​</a></h3>
156
190
  <p>The <code>plugin</code> command allows you to manage plugins for Agent Mesh application.</p>
157
191
  <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam plugin [COMMAND] [OPTIONS]</span><br></span></code></pre></div></div>
158
- <p>For more information, see <a href="/solace-agent-mesh/docs/documentation/components/plugins">Plugins</a>.</p>
159
- <h4 class="anchor anchorWithStickyNavbar_LWe7" id="create---create-a-plugin"><code>create</code> - Create a Plugin<a href="#create---create-a-plugin" class="hash-link" aria-label="Direct link to create---create-a-plugin" title="Direct link to create---create-a-plugin">​</a></h4>
192
+ <p>For more information, see <a class="" href="/solace-agent-mesh/docs/documentation/components/plugins">Plugins</a>.</p>
193
+ <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="create---create-a-plugin"><code>create</code> - Create a Plugin<a href="#create---create-a-plugin" class="hash-link" aria-label="Direct link to create---create-a-plugin" title="Direct link to create---create-a-plugin" translate="no">​</a></h4>
160
194
  <p>Initializes and creates a new plugin with customizable options.</p>
161
195
  <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam plugin create [OPTIONS] NAME</span><br></span></code></pre></div></div>
162
196
  <p>When this command is run with no options, it runs in interactive mode and prompts you to provide the necessary information to set up the plugin for Agent Mesh.</p>
163
197
  <p>You can skip some questions by providing the appropriate options for that step.</p>
164
198
  <p>Optionally, you can skip all the questions by providing the <code>--skip</code> option. This option uses the provided or default values for all the questions, which is useful for automated workflows.</p>
165
- <h5 class="anchor anchorWithStickyNavbar_LWe7" id="options-5">Options:<a href="#options-5" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:">​</a></h5>
199
+ <h5 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-7">Options:<a href="#options-7" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:" translate="no">​</a></h5>
166
200
  <ul>
167
- <li><code>--type TEXT</code> – Plugin type. Options: agent, gateway, custom.</li>
168
- <li><code>--author-name TEXT</code> – Author&#x27;s name.</li>
169
- <li><code>--author-email TEXT</code> – Author&#x27;s email.</li>
170
- <li><code>--description TEXT</code> – Plugin description.</li>
171
- <li><code>--version TEXT</code> – Initial plugin version.</li>
172
- <li><code>--skip</code> – Skip interactive prompts and use defaults or provided flags.</li>
173
- <li><code>-h, --help</code> – Displays the help message and exits.</li>
201
+ <li class=""><code>--type TEXT</code> – Plugin type. Options: agent, gateway, custom.</li>
202
+ <li class=""><code>--author-name TEXT</code> – Author&#x27;s name.</li>
203
+ <li class=""><code>--author-email TEXT</code> – Author&#x27;s email.</li>
204
+ <li class=""><code>--description TEXT</code> – Plugin description.</li>
205
+ <li class=""><code>--version TEXT</code> – Initial plugin version.</li>
206
+ <li class=""><code>--skip</code> – Skip interactive prompts and use defaults or provided flags.</li>
207
+ <li class=""><code>-h, --help</code> – Displays the help message and exits.</li>
174
208
  </ul>
175
- <h4 class="anchor anchorWithStickyNavbar_LWe7" id="build---build-the-plugin"><code>build</code> - Build the Plugin<a href="#build---build-the-plugin" class="hash-link" aria-label="Direct link to build---build-the-plugin" title="Direct link to build---build-the-plugin">​</a></h4>
209
+ <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="build---build-the-plugin"><code>build</code> - Build the Plugin<a href="#build---build-the-plugin" class="hash-link" aria-label="Direct link to build---build-the-plugin" title="Direct link to build---build-the-plugin" translate="no">​</a></h4>
176
210
  <p>Compiles and prepares the plugin for use.</p>
177
211
  <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam plugin build [PLUGIN_PATH]</span><br></span></code></pre></div></div>
178
212
  <p>Builds the Agent Mesh plugin in the specified directory (defaults to current directory).</p>
179
- <h5 class="anchor anchorWithStickyNavbar_LWe7" id="options-6">Options:<a href="#options-6" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:">​</a></h5>
213
+ <h5 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-8">Options:<a href="#options-8" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:" translate="no">​</a></h5>
180
214
  <ul>
181
- <li><code>PLUGIN_PATH</code> – Path to the plugin directory (defaults to current directory).</li>
182
- <li><code>-h, --help</code> – Displays the help message and exits.</li>
215
+ <li class=""><code>PLUGIN_PATH</code> – Path to the plugin directory (defaults to current directory).</li>
216
+ <li class=""><code>-h, --help</code> – Displays the help message and exits.</li>
183
217
  </ul>
184
- <h4 class="anchor anchorWithStickyNavbar_LWe7" id="add---add-an-existing-plugin"><code>add</code> - Add an Existing Plugin<a href="#add---add-an-existing-plugin" class="hash-link" aria-label="Direct link to add---add-an-existing-plugin" title="Direct link to add---add-an-existing-plugin">​</a></h4>
218
+ <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="add---add-an-existing-plugin"><code>add</code> - Add an Existing Plugin<a href="#add---add-an-existing-plugin" class="hash-link" aria-label="Direct link to add---add-an-existing-plugin" title="Direct link to add---add-an-existing-plugin" translate="no">​</a></h4>
185
219
  <p>Installs the plugins and creates a new component instance from a specified plugin source.</p>
186
220
  <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam plugin add [OPTIONS] COMPONENT_NAME</span><br></span></code></pre></div></div>
187
- <h5 class="anchor anchorWithStickyNavbar_LWe7" id="options-7">Options:<a href="#options-7" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:">​</a></h5>
221
+ <h5 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-9">Options:<a href="#options-9" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:" translate="no">​</a></h5>
188
222
  <ul>
189
- <li><code>--plugin TEXT</code> – Plugin source: installed module name, local path, or Git URL. (Required)</li>
190
- <li><code>--install-command TEXT</code> – Command to use to install a python package. Must follow the format <code>command {package} args</code>, by default <code>pip3 install {package}</code>. Can also be set through the environment variable SAM_PLUGIN_INSTALL_COMMAND.</li>
191
- <li><code>-h, --help</code> – Displays the help message and exits.</li>
223
+ <li class=""><code>--plugin TEXT</code> – Plugin source: installed module name, local path, or Git URL. (Required)</li>
224
+ <li class=""><code>--install-command TEXT</code> – Command to use to install a python package. Must follow the format <code>command {package} args</code>, by default <code>pip3 install {package}</code>. Can also be set through the environment variable SAM_PLUGIN_INSTALL_COMMAND.</li>
225
+ <li class=""><code>-h, --help</code> – Displays the help message and exits.</li>
192
226
  </ul>
193
- <h4 class="anchor anchorWithStickyNavbar_LWe7" id="installs---installs-a-plugin"><code>installs</code> - Installs a Plugin<a href="#installs---installs-a-plugin" class="hash-link" aria-label="Direct link to installs---installs-a-plugin" title="Direct link to installs---installs-a-plugin">​</a></h4>
227
+ <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="installs---installs-a-plugin"><code>installs</code> - Installs a Plugin<a href="#installs---installs-a-plugin" class="hash-link" aria-label="Direct link to installs---installs-a-plugin" title="Direct link to installs---installs-a-plugin" translate="no">​</a></h4>
194
228
  <p>Installs a plugin from a specified plugin source.</p>
195
229
  <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam plugin install [OPTIONS] PLUGIN_SOURCE</span><br></span></code></pre></div></div>
196
230
  <p>PLUGIN_SOURCE can be:</p>
197
231
  <ul>
198
- <li>A local path to a directory (e.g., &#x27;/path/to/plugin&#x27;)</li>
199
- <li>A local path to a wheel file (e.g., &#x27;/path/to/plugin.whl&#x27;)</li>
200
- <li>A Git URL (e.g., &#x27;<a href="https://github.com/user/repo.git" target="_blank" rel="noopener noreferrer">https://github.com/user/repo.git</a>&#x27;)</li>
201
- <li>The name of the plugin from <a href="https://github.com/SolaceLabs/solace-agent-mesh-core-plugins" target="_blank" rel="noopener noreferrer">https://github.com/SolaceLabs/solace-agent-mesh-core-plugins</a></li>
232
+ <li class="">A local path to a directory (e.g., &#x27;/path/to/plugin&#x27;)</li>
233
+ <li class="">A local path to a wheel file (e.g., &#x27;/path/to/plugin.whl&#x27;)</li>
234
+ <li class="">A Git URL (e.g., &#x27;<a href="https://github.com/user/repo.git" target="_blank" rel="noopener noreferrer" class="">https://github.com/user/repo.git</a>&#x27;)</li>
235
+ <li class="">The name of the plugin from <a href="https://github.com/SolaceLabs/solace-agent-mesh-core-plugins" target="_blank" rel="noopener noreferrer" class="">https://github.com/SolaceLabs/solace-agent-mesh-core-plugins</a></li>
202
236
  </ul>
203
- <h5 class="anchor anchorWithStickyNavbar_LWe7" id="options-8">Options:<a href="#options-8" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:">​</a></h5>
237
+ <h5 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-10">Options:<a href="#options-10" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:" translate="no">​</a></h5>
204
238
  <ul>
205
- <li><code>--install-command TEXT</code> – Command to use to install a python package. Must follow the format <code>command {package} args</code>, by default <code>pip3 install {package}</code>. Can also be set through the environment variable SAM_PLUGIN_INSTALL_COMMAND.</li>
206
- <li><code>-h, --help</code> – Displays the help message and exits.</li>
239
+ <li class=""><code>--install-command TEXT</code> – Command to use to install a python package. Must follow the format <code>command {package} args</code>, by default <code>pip3 install {package}</code>. Can also be set through the environment variable SAM_PLUGIN_INSTALL_COMMAND.</li>
240
+ <li class=""><code>-h, --help</code> – Displays the help message and exits.</li>
207
241
  </ul>
208
- <h4 class="anchor anchorWithStickyNavbar_LWe7" id="catalog---launch-plugin-catalog"><code>catalog</code> - Launch Plugin Catalog<a href="#catalog---launch-plugin-catalog" class="hash-link" aria-label="Direct link to catalog---launch-plugin-catalog" title="Direct link to catalog---launch-plugin-catalog">​</a></h4>
242
+ <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="catalog---launch-plugin-catalog"><code>catalog</code> - Launch Plugin Catalog<a href="#catalog---launch-plugin-catalog" class="hash-link" aria-label="Direct link to catalog---launch-plugin-catalog" title="Direct link to catalog---launch-plugin-catalog" translate="no">​</a></h4>
209
243
  <p>Launch the Agent Mesh Plugin Catalog web interface.</p>
210
244
  <div class="language-sh codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-sh codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">sam plugin catalog [OPTIONS]</span><br></span></code></pre></div></div>
211
- <h5 class="anchor anchorWithStickyNavbar_LWe7" id="options-9">Options:<a href="#options-9" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:">​</a></h5>
245
+ <h5 class="anchor anchorTargetStickyNavbar_Vzrq" id="options-11">Options:<a href="#options-11" class="hash-link" aria-label="Direct link to Options:" title="Direct link to Options:" translate="no">​</a></h5>
212
246
  <ul>
213
- <li><code>--port INTEGER</code> – Port to run the plugin catalog web server on. (default: 5003)</li>
214
- <li><code>--install-command TEXT</code> – Command to use to install a python package. Must follow the format <code>command {package} args</code>.</li>
215
- <li><code>-h, --help</code> – Displays the help message and exits.</li>
216
- </ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/SolaceLabs/solace-agent-mesh/edit/main/docs/docs/documentation/components/cli.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/solace-agent-mesh/docs/documentation/components/plugins"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Plugins</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/solace-agent-mesh/docs/documentation/components/builtin-tools/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Configuring Built-in Tools</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#installation" class="table-of-contents__link toc-highlight">Installation</a></li><li><a href="#commands" class="table-of-contents__link toc-highlight">Commands</a><ul><li><a href="#init---initialize-an-agent-mesh-application" class="table-of-contents__link toc-highlight"><code>init</code> - Initialize an Agent Mesh Application</a></li><li><a href="#add---create-a-new-component" class="table-of-contents__link toc-highlight"><code>add</code> - Create a New Component</a><ul><li><a href="#add-agent" class="table-of-contents__link toc-highlight">Add <code>agent</code></a></li><li><a href="#add-gateway" class="table-of-contents__link toc-highlight">Add <code>gateway</code></a></li></ul></li><li><a href="#run---run-the-agent-mesh-application" class="table-of-contents__link toc-highlight"><code>run</code> - Run the Agent Mesh Application</a></li><li><a href="#docs---serve-the-documentation-locally" class="table-of-contents__link toc-highlight"><code>docs</code> - Serve the documentation locally</a></li><li><a href="#plugin---manage-plugins" class="table-of-contents__link toc-highlight"><code>plugin</code> - Manage Plugins</a><ul><li><a href="#create---create-a-plugin" class="table-of-contents__link toc-highlight"><code>create</code> - Create a Plugin</a></li><li><a href="#build---build-the-plugin" class="table-of-contents__link toc-highlight"><code>build</code> - Build the Plugin</a></li><li><a href="#add---add-an-existing-plugin" class="table-of-contents__link toc-highlight"><code>add</code> - Add an Existing Plugin</a></li><li><a href="#installs---installs-a-plugin" class="table-of-contents__link toc-highlight"><code>installs</code> - Installs a Plugin</a></li><li><a href="#catalog---launch-plugin-catalog" class="table-of-contents__link toc-highlight"><code>catalog</code> - Launch Plugin Catalog</a></li></ul></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Solace Agent Mesh</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/solace-agent-mesh/docs/documentation/getting-started">Documentation</a></li><li class="footer__item"><a href="https://github.com/SolaceLabs/solace-agent-mesh/" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/SolaceLabs/solace-agent-mesh-core-plugins/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Official Plugins<svg width="13.5" height="13.5" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Company</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://solace.com/products/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Products<svg width="13.5" height="13.5" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://solace.com/contact/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Contact<svg width="13.5" height="13.5" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://solace.com/support/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Support<svg width="13.5" height="13.5" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://solace.com/legal/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Privacy and Legal<svg width="13.5" height="13.5" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/solacedotcom/" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/SolaceLabs" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://www.youtube.com/SolaceSystems" target="_blank" rel="noopener noreferrer" class="footer__link-item">YouTube<svg width="13.5" height="13.5" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://twitter.com/solacedotcom" target="_blank" rel="noopener noreferrer" class="footer__link-item">X<svg width="13.5" height="13.5" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><img src="/solace-agent-mesh/img/solace-logo.png" alt="Solace Logo" class="footer__logo themedComponent_mlkZ themedComponent--light_NVdE" width="10%" height="10%"><img src="/solace-agent-mesh/img/solace-logo.png" alt="Solace Logo" class="footer__logo themedComponent_mlkZ themedComponent--dark_xIcU" width="10%" height="10%"></div><div class="footer__copyright">Solace Agent Mesh. Copyright © 2025 Solace. Version: 1.6.1</div></div></div></footer></div>
247
+ <li class=""><code>--port INTEGER</code> – Port to run the plugin catalog web server on. (default: 5003)</li>
248
+ <li class=""><code>--install-command TEXT</code> – Command to use to install a python package. Must follow the format <code>command {package} args</code>.</li>
249
+ <li class=""><code>-h, --help</code> – Displays the help message and exits.</li>
250
+ </ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/SolaceLabs/solace-agent-mesh/edit/main/docs/docs/documentation/components/cli.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/solace-agent-mesh/docs/documentation/components/projects"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Projects</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/solace-agent-mesh/docs/documentation/components/builtin-tools/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Configuring Built-in Tools</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#installation" class="table-of-contents__link toc-highlight">Installation</a></li><li><a href="#commands" class="table-of-contents__link toc-highlight">Commands</a><ul><li><a href="#init---initialize-an-agent-mesh-application" class="table-of-contents__link toc-highlight"><code>init</code> - Initialize an Agent Mesh Application</a></li><li><a href="#add---create-a-new-component" class="table-of-contents__link toc-highlight"><code>add</code> - Create a New Component</a><ul><li><a href="#add-agent" class="table-of-contents__link toc-highlight">Add <code>agent</code></a></li><li><a href="#add-gateway" class="table-of-contents__link toc-highlight">Add <code>gateway</code></a></li><li><a href="#add-proxy" class="table-of-contents__link toc-highlight">Add <code>proxy</code></a></li></ul></li><li><a href="#run---run-the-agent-mesh-application" class="table-of-contents__link toc-highlight"><code>run</code> - Run the Agent Mesh Application</a></li><li><a href="#docs---serve-the-documentation-locally" class="table-of-contents__link toc-highlight"><code>docs</code> - Serve the documentation locally</a></li><li><a href="#tools---manage-and-explore-built-in-tools" class="table-of-contents__link toc-highlight"><code>tools</code> - Manage and Explore Built-in Tools</a><ul><li><a href="#list---list-built-in-tools" class="table-of-contents__link toc-highlight"><code>list</code> - List Built-in Tools</a></li></ul></li><li><a href="#plugin---manage-plugins" class="table-of-contents__link toc-highlight"><code>plugin</code> - Manage Plugins</a><ul><li><a href="#create---create-a-plugin" class="table-of-contents__link toc-highlight"><code>create</code> - Create a Plugin</a></li><li><a href="#build---build-the-plugin" class="table-of-contents__link toc-highlight"><code>build</code> - Build the Plugin</a></li><li><a href="#add---add-an-existing-plugin" class="table-of-contents__link toc-highlight"><code>add</code> - Add an Existing Plugin</a></li><li><a href="#installs---installs-a-plugin" class="table-of-contents__link toc-highlight"><code>installs</code> - Installs a Plugin</a></li><li><a href="#catalog---launch-plugin-catalog" class="table-of-contents__link toc-highlight"><code>catalog</code> - Launch Plugin Catalog</a></li></ul></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Solace Agent Mesh</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/solace-agent-mesh/docs/documentation/getting-started">Documentation</a></li><li class="footer__item"><a href="https://github.com/SolaceLabs/solace-agent-mesh/" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/SolaceLabs/solace-agent-mesh-core-plugins/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Official Plugins<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Company</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://solace.com/products/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Products<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://solace.com/contact/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Contact<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://solace.com/support/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Support<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://solace.com/legal/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Privacy and Legal<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/solacedotcom/" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://github.com/SolaceLabs" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://www.youtube.com/SolaceSystems" target="_blank" rel="noopener noreferrer" class="footer__link-item">YouTube<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li class="footer__item"><a href="https://twitter.com/solacedotcom" target="_blank" rel="noopener noreferrer" class="footer__link-item">X<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><img src="/solace-agent-mesh/img/solace-logo.png" alt="Solace Logo" class="footer__logo themedComponent_mlkZ themedComponent--light_NVdE" width="10%" height="10%"><img src="/solace-agent-mesh/img/solace-logo.png" alt="Solace Logo" class="footer__logo themedComponent_mlkZ themedComponent--dark_xIcU" width="10%" height="10%"></div><div class="footer__copyright">Solace Agent Mesh. Copyright © 2026 Solace. Version: 1.13.2</div></div></div></footer></div>
217
251
  </body>
218
252
  </html>