openc3-cosmos-tool-docs 6.9.0 → 6.9.2

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.
Files changed (327) hide show
  1. checksums.yaml +4 -4
  2. data/tools/staticdocs/404.html +2 -2
  3. data/tools/staticdocs/assets/css/{styles.946be27d.css → styles.41902cce.css} +1 -1
  4. data/tools/staticdocs/assets/images/activity-35dc5e3ab907ff79a599ab728b7a4ace155d86835a09f0c6fa8ceebf184b7984.png +0 -0
  5. data/tools/staticdocs/assets/images/add_role-e99225cd280a9de1e354586f00c92f52d0dae856ac015a561da2dd405de6cb55.png +0 -0
  6. data/tools/staticdocs/assets/images/blank_calendar-e02977fafde5379efc62fbaf82686898bfc4745dd081d62e52e3ee94c46bff69.png +0 -0
  7. data/tools/staticdocs/assets/images/cmd_packets-e7906db3691ccd29600e09cf005f6f53be9d9332ba4c319a1e81e1c8c6b665ed.png +0 -0
  8. data/tools/staticdocs/assets/images/cmd_tlm_server-117772d4be1adbf89805f5b530da301b3dcc0d5085a552d779c9bc692bac4c44.png +0 -0
  9. data/tools/staticdocs/assets/images/command_queue-e5a7c681a35ccb9efa4e6f8af4a6d18afcc334b43b64e3aa30110213d913a6ee.png +0 -0
  10. data/tools/staticdocs/assets/images/create_activity1-5e5a8cee97e818c21e3447d96797b950fe25eb5d0e153ffc899183d28b7fd1be.png +0 -0
  11. data/tools/staticdocs/assets/images/create_activity2-12024f05a06874c9e7b544bac4bec1a263de1715dcb9fa2dc1aea054682e8269.png +0 -0
  12. data/tools/staticdocs/assets/images/create_metadata1-70387fe6ea1aafaee24b4192e76000b31ed60d3a54f957d761cefb5d21498814.png +0 -0
  13. data/tools/staticdocs/assets/images/create_metadata2-ebb8f148142b387c81df70f8a565b27942ff5f6cd5bc098a6d58a27a9b36c09e.png +0 -0
  14. data/tools/staticdocs/assets/images/create_note1-28feb5cf0ad0899db78059dc4ea2567dc9cb03c8c776f1c65dd959f2910481f4.png +0 -0
  15. data/tools/staticdocs/assets/images/create_note2-c0929ea9194606f256465cd6a6c97c60c175cf2ecbf56e6597d4886b4249fe1f.png +0 -0
  16. data/tools/staticdocs/assets/images/data_flows-6796d95b379f3f69e3fcf9629c68aae389f3d9a287db5b4d0bbc385d478134b4.png +0 -0
  17. data/tools/staticdocs/assets/images/edit_role-1ea95cfab9edd9173196018fe14ec39ad0537e0c04c8f0f5af53fcf3173867df.png +0 -0
  18. data/tools/staticdocs/assets/images/gantt_view-3fe75622572f4a5bab2f73311127b71db5bf5aed475b90a2938c9ae61810ea54.png +0 -0
  19. data/tools/staticdocs/assets/images/interface_details-b71797d470007be1e0520bb5b859b4da9cd3411303388be9e6db914a99628dff.png +0 -0
  20. data/tools/staticdocs/assets/images/interfaces-05db0ed276077b796b54a3bca76bd0841bfb0d700456258c878359d332ff9f8f.png +0 -0
  21. data/tools/staticdocs/assets/images/keycloak_user_roles-d4c78e2a5d33c4ea3016250d849b3363deccd21b9562561793b81981acf773fe.png +0 -0
  22. data/tools/staticdocs/assets/images/list_view-edfc7b6fa90e43b85dd862f06c3662dee33b3c79be923a955706001d2f07eca4.png +0 -0
  23. data/tools/staticdocs/assets/images/options-4cb5e315138437db9f25c87feb4be2c61738c03bc3344d46977f44a94b0af738.png +0 -0
  24. data/tools/staticdocs/assets/images/packages-72c40796a00462cca280fe6e87d6baa92f20a2efb378a0a1a60453827c4cd38f.png +0 -0
  25. data/tools/staticdocs/assets/images/plugins-2ecbde86aa0ef62523fb1d17c385551a2fd5ff6a8f2db890f67bfb7adf66973e.png +0 -0
  26. data/tools/staticdocs/assets/images/protocol_details-408f871b0bd8440091ac95ca76cac353bb06d0b3a6c3f756dd11e7e746d7c20c.png +0 -0
  27. data/tools/staticdocs/assets/images/roles-37653453a2f2b704aacdf1c56c45d46b5fe56ac71c38a6d1fe29510fdc3ac203.png +0 -0
  28. data/tools/staticdocs/assets/images/scopes-dd892c6192160e86820a63d0d7798ed75eff4f96a4be9be0fb6bddebb82a9ddc.png +0 -0
  29. data/tools/staticdocs/assets/images/status-9b7ac4d919d196a2bf3379d0cb262c6609fb98074c744533bb9132097cb52155.png +0 -0
  30. data/tools/staticdocs/assets/images/targets-b07f7cd9f19a4ca02d2838a4de58c25168f01ee256e692878e3b27b833632aca.png +0 -0
  31. data/tools/staticdocs/assets/images/timeline-78e3ab74af1b600eb6640831133f0240a9c20047956b18b729263988a66b8e00.png +0 -0
  32. data/tools/staticdocs/assets/images/tlm_packets-18345c00fd6cc01a9f7a1e363fdf8375769ba5afa4ccf22c45925184eefc57ca.png +0 -0
  33. data/tools/staticdocs/assets/js/019369f3.4a1653c3.js +1 -0
  34. data/tools/staticdocs/assets/js/058ffc22.32f2b3f7.js +1 -0
  35. data/tools/staticdocs/assets/js/0686a885.a7333b95.js +1 -0
  36. data/tools/staticdocs/assets/js/078dbab0.64ae8502.js +1 -0
  37. data/tools/staticdocs/assets/js/0f5d161c.7e279344.js +1 -0
  38. data/tools/staticdocs/assets/js/0ff569c9.2aab45f2.js +1 -0
  39. data/tools/staticdocs/assets/js/10209fc9.4565c03f.js +1 -0
  40. data/tools/staticdocs/assets/js/103cc3be.6610d68d.js +1 -0
  41. data/tools/staticdocs/assets/js/13196248.d66fca61.js +1 -0
  42. data/tools/staticdocs/assets/js/13c1b4e4.5bb027bf.js +1 -0
  43. data/tools/staticdocs/assets/js/1c0a0c05.c66d2cd5.js +1 -0
  44. data/tools/staticdocs/assets/js/1e02e6a3.9bd7e41d.js +1 -0
  45. data/tools/staticdocs/assets/js/2047b354.57091c5c.js +1 -0
  46. data/tools/staticdocs/assets/js/22b3ac48.afad8999.js +1 -0
  47. data/tools/staticdocs/assets/js/{26b8abb2.858cb22d.js → 26b8abb2.dcaf4a64.js} +1 -1
  48. data/tools/staticdocs/assets/js/{3326.2db66e1b.js → 2754.1aabb61a.js} +1 -1
  49. data/tools/staticdocs/assets/js/2bb7bf90.417c7c24.js +1 -0
  50. data/tools/staticdocs/assets/js/2c15ad40.9ac78174.js +1 -0
  51. data/tools/staticdocs/assets/js/35398c5c.e106e87e.js +1 -0
  52. data/tools/staticdocs/assets/js/{3dd7ef3b.ceb26a04.js → 3dd7ef3b.d7f8b9cd.js} +1 -1
  53. data/tools/staticdocs/assets/js/40365d27.d9f50fa2.js +1 -0
  54. data/tools/staticdocs/assets/js/411898ad.2ba42394.js +1 -0
  55. data/tools/staticdocs/assets/js/{9623.44668503.js → 4212.6d8bdfa0.js} +1 -1
  56. data/tools/staticdocs/assets/js/42170351.067ef5bf.js +1 -0
  57. data/tools/staticdocs/assets/js/43652efd.658da795.js +1 -0
  58. data/tools/staticdocs/assets/js/4684.14bc5dde.js +1 -0
  59. data/tools/staticdocs/assets/js/{53ca7c5b.3ae5bb0f.js → 53ca7c5b.dfd52859.js} +1 -1
  60. data/tools/staticdocs/assets/js/{54d0d530.2f7aa091.js → 54d0d530.2cb8d081.js} +1 -1
  61. data/tools/staticdocs/assets/js/567dad64.2839bb3d.js +1 -0
  62. data/tools/staticdocs/assets/js/5738ba7a.d3cf18a7.js +1 -0
  63. data/tools/staticdocs/assets/js/59ed27a4.eb69cbc8.js +1 -0
  64. data/tools/staticdocs/assets/js/5b233ba7.c96c3512.js +1 -0
  65. data/tools/staticdocs/assets/js/5bc719f6.1ac7eb68.js +1 -0
  66. data/tools/staticdocs/assets/js/5c6ce5ec.507ee82d.js +1 -0
  67. data/tools/staticdocs/assets/js/{5e3ed378.821e5ed4.js → 5e3ed378.4df9c862.js} +1 -1
  68. data/tools/staticdocs/assets/js/5fe211ef.f88f4388.js +1 -0
  69. data/tools/staticdocs/assets/js/6822.e7d145ca.js +1 -0
  70. data/tools/staticdocs/assets/js/{6831b732.dc5bae56.js → 6831b732.e1f6dba2.js} +1 -1
  71. data/tools/staticdocs/assets/js/{696b4199.d197d085.js → 696b4199.ca5589ac.js} +1 -1
  72. data/tools/staticdocs/assets/js/6b210247.9645038a.js +1 -0
  73. data/tools/staticdocs/assets/js/6b65133b.e20fd90a.js +1 -0
  74. data/tools/staticdocs/assets/js/6f92e431.4af1d84b.js +1 -0
  75. data/tools/staticdocs/assets/js/72c6d8a8.33b4ade8.js +1 -0
  76. data/tools/staticdocs/assets/js/{5525.dd1645b0.js → 7453.c108c718.js} +1 -1
  77. data/tools/staticdocs/assets/js/75e64983.180a00e7.js +1 -0
  78. data/tools/staticdocs/assets/js/7724.decf13c5.js +1 -0
  79. data/tools/staticdocs/assets/js/867640d5.8e389f8a.js +1 -0
  80. data/tools/staticdocs/assets/js/89e76475.19eee62b.js +1 -0
  81. data/tools/staticdocs/assets/js/8b939c74.695b23ba.js +1 -0
  82. data/tools/staticdocs/assets/js/8f7843ee.fffd1922.js +1 -0
  83. data/tools/staticdocs/assets/js/9424f0b3.b69449bb.js +1 -0
  84. data/tools/staticdocs/assets/js/964eb012.ee8b3c36.js +1 -0
  85. data/tools/staticdocs/assets/js/97535711.237fc358.js +1 -0
  86. data/tools/staticdocs/assets/js/99581c43.0582936a.js +1 -0
  87. data/tools/staticdocs/assets/js/{9d6e81d0.879c9e9e.js → 9d6e81d0.2e825d3a.js} +1 -1
  88. data/tools/staticdocs/assets/js/9fb6059a.10a4e6be.js +1 -0
  89. data/tools/staticdocs/assets/js/a677c089.b21f50bd.js +1 -0
  90. data/tools/staticdocs/assets/js/a9987364.7fc39b81.js +1 -0
  91. data/tools/staticdocs/assets/js/a9b2dc27.a75a110f.js +1 -0
  92. data/tools/staticdocs/assets/js/aa6b6c1b.fe979b93.js +1 -0
  93. data/tools/staticdocs/assets/js/b062d239.17662e64.js +1 -0
  94. data/tools/staticdocs/assets/js/b38a6d74.8868b9d0.js +1 -0
  95. data/tools/staticdocs/assets/js/{b4596165.9e7f0be7.js → b4596165.2ed4461b.js} +1 -1
  96. data/tools/staticdocs/assets/js/b6d70f94.5c2fecd8.js +1 -0
  97. data/tools/staticdocs/assets/js/{b9f60ba6.63638354.js → b9f60ba6.b670205f.js} +1 -1
  98. data/tools/staticdocs/assets/js/bd0034eb.4f47d05b.js +1 -0
  99. data/tools/staticdocs/assets/js/c24eae19.59d90845.js +1 -0
  100. data/tools/staticdocs/assets/js/c956ad1e.78603023.js +1 -0
  101. data/tools/staticdocs/assets/js/cb8c3f08.2df335b2.js +1 -0
  102. data/tools/staticdocs/assets/js/cd879be4.c7304d91.js +1 -0
  103. data/tools/staticdocs/assets/js/cf1c01b8.0e7608a1.js +1 -0
  104. data/tools/staticdocs/assets/js/d1b923aa.9f1cb7ab.js +1 -0
  105. data/tools/staticdocs/assets/js/d1bfc316.61e55cb2.js +1 -0
  106. data/tools/staticdocs/assets/js/d24bf9b6.a79f1a36.js +1 -0
  107. data/tools/staticdocs/assets/js/d57a4b5d.1c05ac31.js +1 -0
  108. data/tools/staticdocs/assets/js/d59d8a14.849274f0.js +1 -0
  109. data/tools/staticdocs/assets/js/{d5d77c37.6b4ab31e.js → d5d77c37.efea20c9.js} +1 -1
  110. data/tools/staticdocs/assets/js/d66bf9c0.742ff681.js +1 -0
  111. data/tools/staticdocs/assets/js/d8ca4191.1c930b0b.js +1 -0
  112. data/tools/staticdocs/assets/js/d9b92eba.df6e59c2.js +1 -0
  113. data/tools/staticdocs/assets/js/db8fa1d0.7f3090fa.js +1 -0
  114. data/tools/staticdocs/assets/js/dbe31111.2d5f3225.js +1 -0
  115. data/tools/staticdocs/assets/js/{dc5f7beb.c703e464.js → dc5f7beb.53bef49e.js} +1 -1
  116. data/tools/staticdocs/assets/js/e501b0d1.c2d8ca29.js +1 -0
  117. data/tools/staticdocs/assets/js/f15615f1.7cc36bfe.js +1 -0
  118. data/tools/staticdocs/assets/js/f75a5f33.bc43f96a.js +1 -0
  119. data/tools/staticdocs/assets/js/{fd886806.fb8a587e.js → fd886806.e52d2c97.js} +1 -1
  120. data/tools/staticdocs/assets/js/{main.331b7e10.js → main.1ae7ceb9.js} +6 -6
  121. data/tools/staticdocs/assets/js/runtime~main.44a60fd4.js +1 -0
  122. data/tools/staticdocs/docs/configuration/accessors.html +75 -75
  123. data/tools/staticdocs/docs/configuration/command.html +95 -95
  124. data/tools/staticdocs/docs/configuration/conversions.html +55 -55
  125. data/tools/staticdocs/docs/configuration/format.html +25 -25
  126. data/tools/staticdocs/docs/configuration/interfaces.html +81 -81
  127. data/tools/staticdocs/docs/configuration/limits-response.html +13 -13
  128. data/tools/staticdocs/docs/configuration/plugins.html +131 -131
  129. data/tools/staticdocs/docs/configuration/processors.html +22 -22
  130. data/tools/staticdocs/docs/configuration/protocols.html +80 -80
  131. data/tools/staticdocs/docs/configuration/ssl-tls.html +59 -59
  132. data/tools/staticdocs/docs/configuration/table.html +56 -56
  133. data/tools/staticdocs/docs/configuration/target.html +20 -20
  134. data/tools/staticdocs/docs/configuration/telemetry-screens.html +259 -259
  135. data/tools/staticdocs/docs/configuration/telemetry.html +90 -90
  136. data/tools/staticdocs/docs/configuration.html +2 -2
  137. data/tools/staticdocs/docs/development/curl.html +21 -21
  138. data/tools/staticdocs/docs/development/developing.html +31 -31
  139. data/tools/staticdocs/docs/development/json-api.html +23 -23
  140. data/tools/staticdocs/docs/development/log-structure.html +12 -12
  141. data/tools/staticdocs/docs/development/roadmap.html +5 -5
  142. data/tools/staticdocs/docs/development/streaming-api.html +63 -63
  143. data/tools/staticdocs/docs/development/testing.html +27 -27
  144. data/tools/staticdocs/docs/development.html +2 -2
  145. data/tools/staticdocs/docs/getting-started/cli.html +49 -43
  146. data/tools/staticdocs/docs/getting-started/generators.html +37 -37
  147. data/tools/staticdocs/docs/getting-started/gettingstarted.html +66 -66
  148. data/tools/staticdocs/docs/getting-started/installation.html +30 -30
  149. data/tools/staticdocs/docs/getting-started/key-concepts.html +35 -35
  150. data/tools/staticdocs/docs/getting-started/podman.html +41 -41
  151. data/tools/staticdocs/docs/getting-started/requirements.html +38 -38
  152. data/tools/staticdocs/docs/getting-started/upgrading.html +93 -93
  153. data/tools/staticdocs/docs/getting-started/util.html +112 -0
  154. data/tools/staticdocs/docs/getting-started.html +2 -2
  155. data/tools/staticdocs/docs/guides/bridges.html +25 -25
  156. data/tools/staticdocs/docs/guides/cfs.html +43 -43
  157. data/tools/staticdocs/docs/guides/custom-widgets.html +39 -39
  158. data/tools/staticdocs/docs/guides/dynamic-packets.html +12 -12
  159. data/tools/staticdocs/docs/guides/exposing-microservices.html +23 -23
  160. data/tools/staticdocs/docs/guides/little-endian-bitfields.html +8 -8
  161. data/tools/staticdocs/docs/guides/local-mode.html +14 -14
  162. data/tools/staticdocs/docs/guides/logging.html +11 -11
  163. data/tools/staticdocs/docs/guides/monitoring.html +20 -20
  164. data/tools/staticdocs/docs/guides/performance.html +21 -21
  165. data/tools/staticdocs/docs/guides/raspberrypi.html +42 -42
  166. data/tools/staticdocs/docs/guides/reference-architectures.html +19 -19
  167. data/tools/staticdocs/docs/guides/roles-permissions.html +191 -0
  168. data/tools/staticdocs/docs/guides/script-writing.html +108 -108
  169. data/tools/staticdocs/docs/guides/scripting-api.html +698 -690
  170. data/tools/staticdocs/docs/guides/troubleshooting.html +27 -27
  171. data/tools/staticdocs/docs/guides.html +2 -2
  172. data/tools/staticdocs/docs/meta/contributing.html +24 -24
  173. data/tools/staticdocs/docs/meta/licenses.html +42 -42
  174. data/tools/staticdocs/docs/meta/philosophy.html +9 -9
  175. data/tools/staticdocs/docs/meta/vulnerabilities.html +8 -0
  176. data/tools/staticdocs/docs/meta/xtce.html +85 -85
  177. data/tools/staticdocs/docs/meta.html +2 -2
  178. data/tools/staticdocs/docs/privacy.html +18 -18
  179. data/tools/staticdocs/docs/tools/admin.html +32 -26
  180. data/tools/staticdocs/docs/tools/autonomic.html +19 -19
  181. data/tools/staticdocs/docs/tools/bucket-explorer.html +11 -11
  182. data/tools/staticdocs/docs/tools/calendar.html +34 -21
  183. data/tools/staticdocs/docs/tools/cmd-sender.html +19 -19
  184. data/tools/staticdocs/docs/tools/cmd-tlm-server.html +35 -26
  185. data/tools/staticdocs/docs/tools/command-history.html +7 -7
  186. data/tools/staticdocs/docs/tools/command-queue.html +12 -12
  187. data/tools/staticdocs/docs/tools/data-extractor.html +33 -33
  188. data/tools/staticdocs/docs/tools/data-viewer.html +13 -13
  189. data/tools/staticdocs/docs/tools/handbooks.html +5 -5
  190. data/tools/staticdocs/docs/tools/limits-monitor.html +22 -22
  191. data/tools/staticdocs/docs/tools/log-explorer.html +20 -20
  192. data/tools/staticdocs/docs/tools/packet-viewer.html +20 -20
  193. data/tools/staticdocs/docs/tools/script-runner.html +58 -58
  194. data/tools/staticdocs/docs/tools/systemhealth.html +26 -26
  195. data/tools/staticdocs/docs/tools/table-manager.html +17 -17
  196. data/tools/staticdocs/docs/tools/tlm-grapher.html +28 -28
  197. data/tools/staticdocs/docs/tools/tlm-viewer.html +18 -18
  198. data/tools/staticdocs/docs/tools.html +2 -2
  199. data/tools/staticdocs/docs.html +12 -12
  200. data/tools/staticdocs/img/admin/packages.png +0 -0
  201. data/tools/staticdocs/img/admin/plugins.png +0 -0
  202. data/tools/staticdocs/img/admin/roles.png +0 -0
  203. data/tools/staticdocs/img/admin/scopes.png +0 -0
  204. data/tools/staticdocs/img/calendar/activity.png +0 -0
  205. data/tools/staticdocs/img/calendar/blank_calendar.png +0 -0
  206. data/tools/staticdocs/img/calendar/calendar.png +0 -0
  207. data/tools/staticdocs/img/calendar/create_activity1.png +0 -0
  208. data/tools/staticdocs/img/calendar/create_activity2.png +0 -0
  209. data/tools/staticdocs/img/calendar/create_metadata1.png +0 -0
  210. data/tools/staticdocs/img/calendar/create_metadata2.png +0 -0
  211. data/tools/staticdocs/img/calendar/create_note1.png +0 -0
  212. data/tools/staticdocs/img/calendar/create_note2.png +0 -0
  213. data/tools/staticdocs/img/calendar/gantt_view.png +0 -0
  214. data/tools/staticdocs/img/calendar/list_view.png +0 -0
  215. data/tools/staticdocs/img/calendar/options.png +0 -0
  216. data/tools/staticdocs/img/calendar/timeline.png +0 -0
  217. data/tools/staticdocs/img/cmd_tlm_server/cmd_packets.png +0 -0
  218. data/tools/staticdocs/img/cmd_tlm_server/cmd_tlm_server.png +0 -0
  219. data/tools/staticdocs/img/cmd_tlm_server/data_flows.png +0 -0
  220. data/tools/staticdocs/img/cmd_tlm_server/interface_details.png +0 -0
  221. data/tools/staticdocs/img/cmd_tlm_server/interfaces.png +0 -0
  222. data/tools/staticdocs/img/cmd_tlm_server/protocol_details.png +0 -0
  223. data/tools/staticdocs/img/cmd_tlm_server/routers.png +0 -0
  224. data/tools/staticdocs/img/cmd_tlm_server/status.png +0 -0
  225. data/tools/staticdocs/img/cmd_tlm_server/targets.png +0 -0
  226. data/tools/staticdocs/img/cmd_tlm_server/tlm_packets.png +0 -0
  227. data/tools/staticdocs/img/command_queue/command_queue.png +0 -0
  228. data/tools/staticdocs/img/guides/roles-permissions/add_role.png +0 -0
  229. data/tools/staticdocs/img/guides/roles-permissions/edit_role.png +0 -0
  230. data/tools/staticdocs/img/guides/roles-permissions/keycloak_user_roles.png +0 -0
  231. data/tools/staticdocs/index.html +2 -2
  232. data/tools/staticdocs/lunr-index-1762372934557.json +1 -0
  233. data/tools/staticdocs/lunr-index.json +1 -1
  234. data/tools/staticdocs/markdown-page.html +3 -3
  235. data/tools/staticdocs/search-doc-1762372934557.json +1 -0
  236. data/tools/staticdocs/search-doc.json +1 -1
  237. data/tools/staticdocs/sitemap.xml +1 -1
  238. metadata +137 -108
  239. data/tools/staticdocs/assets/images/blank_calendar-70e605942120937b862bd7039348229bab9af1f9c93d356ddbf401a3e8543c74.png +0 -0
  240. data/tools/staticdocs/assets/images/calendar-dacbcbb05175c76f3406b4aaade0465444c20b72e93366c79fed1f6eec018c42.png +0 -0
  241. data/tools/staticdocs/assets/images/cmd_packets-160c7b28230a14f05433d063cdccc63958bb5d90f4e6b80492cd9568b0761a75.png +0 -0
  242. data/tools/staticdocs/assets/images/cmd_tlm_server-dbc02e99c1c837efabeba52831d1d2a3445904fb06b758aaa747496725423fe5.png +0 -0
  243. data/tools/staticdocs/assets/images/command_queue-1a7f929500f5b51d87c653b83236b886fa2d348127a986d294813de5c52ff80b.png +0 -0
  244. data/tools/staticdocs/assets/images/create_activity1-c05ffc03af2df852aeb3ad246f53f259af504e0e6c64cdac21f9126947c49f95.png +0 -0
  245. data/tools/staticdocs/assets/images/create_activity2-58c7da6f79dd510701148c0c54fae02c830b9ca4af662a7b132987ed3410a8f7.png +0 -0
  246. data/tools/staticdocs/assets/images/create_metadata1-a331ba8f0bd19bf5f8d7f2e083c3c7164e9b7b9936f5a7f83c4141c62a6c46f6.png +0 -0
  247. data/tools/staticdocs/assets/images/create_metadata2-c57b5420d5469b48289030ed7c64758539c2319dc742159caa0d4c8fe35050a8.png +0 -0
  248. data/tools/staticdocs/assets/images/create_note1-472b93e8e0e3e66a2e6198e0d4573cdc38cc356df87be66163f990f18137f6c0.png +0 -0
  249. data/tools/staticdocs/assets/images/create_note2-770501a149ef4aabae24d0b636f46ed61fbdcfda9537c61637c07c60257e9228.png +0 -0
  250. data/tools/staticdocs/assets/images/interfaces-0fe2a4a02d9b8a16bbf178f0d4ee393a79ca606e8cf27ff7d8508bd2cb9b0643.png +0 -0
  251. data/tools/staticdocs/assets/images/list_view-2f36ce06962e67d5a4f1f060956e5089b3f13c8ab57f33103c3781687611e7a9.png +0 -0
  252. data/tools/staticdocs/assets/images/packages-3bfae1a91b0534077280c323a40e879a8ac6a7c3ac45376b3c706a098dab12c3.png +0 -0
  253. data/tools/staticdocs/assets/images/plugins-aabbe060bec19e6fa2490b737f20758af9000066121f5af85f260a3b14f9b3d8.png +0 -0
  254. data/tools/staticdocs/assets/images/status-8ba274306305afaa5642162904c234b69086870b56e1048b1fdffa481aa0e96b.png +0 -0
  255. data/tools/staticdocs/assets/images/targets-6b17daf175185b13bea9eddafd4773e5f41d1ef4e953134f30bee0799c1e5c31.png +0 -0
  256. data/tools/staticdocs/assets/images/tlm_packets-0b02f1f3799948a8278e90f11e7d7f283d9686d3dac18c68b41d25ef49568d22.png +0 -0
  257. data/tools/staticdocs/assets/js/019369f3.64763f3d.js +0 -1
  258. data/tools/staticdocs/assets/js/058ffc22.4be515f5.js +0 -1
  259. data/tools/staticdocs/assets/js/0686a885.3d58085e.js +0 -1
  260. data/tools/staticdocs/assets/js/078dbab0.f2cbcc66.js +0 -1
  261. data/tools/staticdocs/assets/js/0f5d161c.978b9fee.js +0 -1
  262. data/tools/staticdocs/assets/js/0ff569c9.27128023.js +0 -1
  263. data/tools/staticdocs/assets/js/10209fc9.669ef887.js +0 -1
  264. data/tools/staticdocs/assets/js/103cc3be.1a538098.js +0 -1
  265. data/tools/staticdocs/assets/js/13196248.f932d5bd.js +0 -1
  266. data/tools/staticdocs/assets/js/13c1b4e4.9735bb59.js +0 -1
  267. data/tools/staticdocs/assets/js/1c0a0c05.427f2699.js +0 -1
  268. data/tools/staticdocs/assets/js/1e02e6a3.da7b7250.js +0 -1
  269. data/tools/staticdocs/assets/js/2047b354.c86efa5f.js +0 -1
  270. data/tools/staticdocs/assets/js/22b3ac48.1932e5a5.js +0 -1
  271. data/tools/staticdocs/assets/js/2bb7bf90.78594fbb.js +0 -1
  272. data/tools/staticdocs/assets/js/2c15ad40.1b2d4730.js +0 -1
  273. data/tools/staticdocs/assets/js/3402.80344ef5.js +0 -1
  274. data/tools/staticdocs/assets/js/35398c5c.8a74eece.js +0 -1
  275. data/tools/staticdocs/assets/js/40365d27.f6769d57.js +0 -1
  276. data/tools/staticdocs/assets/js/4071.821f3b2b.js +0 -1
  277. data/tools/staticdocs/assets/js/411898ad.8ed3452c.js +0 -1
  278. data/tools/staticdocs/assets/js/42170351.7ff72adc.js +0 -1
  279. data/tools/staticdocs/assets/js/43652efd.ec6bb7e9.js +0 -1
  280. data/tools/staticdocs/assets/js/59ed27a4.695b2435.js +0 -1
  281. data/tools/staticdocs/assets/js/5b233ba7.b0d1a8b1.js +0 -1
  282. data/tools/staticdocs/assets/js/5bc719f6.c731b998.js +0 -1
  283. data/tools/staticdocs/assets/js/5c6ce5ec.211ced47.js +0 -1
  284. data/tools/staticdocs/assets/js/5fe211ef.9d68057c.js +0 -1
  285. data/tools/staticdocs/assets/js/6246.60dfff30.js +0 -1
  286. data/tools/staticdocs/assets/js/6b210247.d400f853.js +0 -1
  287. data/tools/staticdocs/assets/js/6b65133b.3550bdf0.js +0 -1
  288. data/tools/staticdocs/assets/js/6f92e431.0bc45585.js +0 -1
  289. data/tools/staticdocs/assets/js/72c6d8a8.7e6fb4fd.js +0 -1
  290. data/tools/staticdocs/assets/js/75e64983.338d2338.js +0 -1
  291. data/tools/staticdocs/assets/js/867640d5.555ba5ca.js +0 -1
  292. data/tools/staticdocs/assets/js/89e76475.a301b5e3.js +0 -1
  293. data/tools/staticdocs/assets/js/8b939c74.0ebaed2a.js +0 -1
  294. data/tools/staticdocs/assets/js/8f7843ee.e33ef7db.js +0 -1
  295. data/tools/staticdocs/assets/js/9424f0b3.4b6f004e.js +0 -1
  296. data/tools/staticdocs/assets/js/964eb012.c7f626c5.js +0 -1
  297. data/tools/staticdocs/assets/js/97535711.a6342866.js +0 -1
  298. data/tools/staticdocs/assets/js/99581c43.2bd0766d.js +0 -1
  299. data/tools/staticdocs/assets/js/9fb6059a.ce4de002.js +0 -1
  300. data/tools/staticdocs/assets/js/a677c089.758701f0.js +0 -1
  301. data/tools/staticdocs/assets/js/a9987364.e29e8a93.js +0 -1
  302. data/tools/staticdocs/assets/js/a9b2dc27.b7e66efd.js +0 -1
  303. data/tools/staticdocs/assets/js/aa6b6c1b.6bcbf484.js +0 -1
  304. data/tools/staticdocs/assets/js/b062d239.2cebb42b.js +0 -1
  305. data/tools/staticdocs/assets/js/b38a6d74.bb58fcec.js +0 -1
  306. data/tools/staticdocs/assets/js/b6d70f94.5e40680e.js +0 -1
  307. data/tools/staticdocs/assets/js/bd0034eb.9f460215.js +0 -1
  308. data/tools/staticdocs/assets/js/c24eae19.2ef0c706.js +0 -1
  309. data/tools/staticdocs/assets/js/cb8c3f08.28d962a4.js +0 -1
  310. data/tools/staticdocs/assets/js/cd879be4.782edb7f.js +0 -1
  311. data/tools/staticdocs/assets/js/cf1c01b8.7d5b6d66.js +0 -1
  312. data/tools/staticdocs/assets/js/d1b923aa.c012712f.js +0 -1
  313. data/tools/staticdocs/assets/js/d1bfc316.13a64896.js +0 -1
  314. data/tools/staticdocs/assets/js/d24bf9b6.bb93853a.js +0 -1
  315. data/tools/staticdocs/assets/js/d57a4b5d.e9712631.js +0 -1
  316. data/tools/staticdocs/assets/js/d59d8a14.79f4b29e.js +0 -1
  317. data/tools/staticdocs/assets/js/d66bf9c0.ca34a583.js +0 -1
  318. data/tools/staticdocs/assets/js/d8ca4191.599a241b.js +0 -1
  319. data/tools/staticdocs/assets/js/d9b92eba.44fde84d.js +0 -1
  320. data/tools/staticdocs/assets/js/db8fa1d0.39b9fdb6.js +0 -1
  321. data/tools/staticdocs/assets/js/dbe31111.4e811739.js +0 -1
  322. data/tools/staticdocs/assets/js/e501b0d1.c00adfa4.js +0 -1
  323. data/tools/staticdocs/assets/js/f15615f1.8591b830.js +0 -1
  324. data/tools/staticdocs/assets/js/f75a5f33.f16b6dd5.js +0 -1
  325. data/tools/staticdocs/assets/js/runtime~main.53a0c91e.js +0 -1
  326. data/tools/staticdocs/lunr-index-1759527994448.json +0 -1
  327. data/tools/staticdocs/search-doc-1759527994448.json +0 -1
@@ -0,0 +1,112 @@
1
+ <!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-getting-started/util" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.9.2"><title data-rh=true>Utility Commands | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/getting-started/util /><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="Utility Commands | OpenC3 Docs"/><meta data-rh=true name=description content="Using openc3.sh util"/><meta data-rh=true property=og:description content="Using openc3.sh util"/><link data-rh=true rel=icon href=/tools/staticdocs/img/favicon.png /><link data-rh=true rel=canonical href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/util /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/util hreflang=en /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/util hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/getting-started","name":"Getting Started","position":1},{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/getting-started/util","name":"Utility Commands","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.41902cce.css /><script src=/tools/staticdocs/assets/js/runtime~main.44a60fd4.js defer></script><script src=/tools/staticdocs/assets/js/main.1ae7ceb9.js defer></script></head><body class=navigation-with-keyboard><svg style="display: none;"><defs>
2
+ <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>
3
+ </defs></svg>
4
+ <script>!function(){var t;document.documentElement.setAttribute("data-theme",t||"dark"),document.documentElement.setAttribute("data-theme-choice",t||"dark")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())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=/tools/staticdocs/img/logo.svg /><div role=region aria-label="Skip to main content"><a class=skipToContent_Ad3x 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"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_iYMB themedComponent--light__u60"/><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_iYMB themedComponent--dark_bnZ2"/></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_BlpL><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_LBOZ"><div class=docsWrapper_fTY1><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_yH7o" type=button></button><div class=docRoot_stlz><aside class="theme-doc-sidebar-container docSidebarContainer_GDN6"><div class=sidebarViewport_N1UE><div class=sidebar_dl38><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu___bF"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs><span title=Introduction class=linkLabel_XLMJ>Introduction</span></a><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_u_d3 menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/getting-started><span title="Getting Started" class=categoryLinkLabel_RXyj>Getting Started</span></a><button aria-label="Collapse sidebar category 'Getting Started'" 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=/tools/staticdocs/docs/getting-started/key-concepts><span title="Key Concepts" class=linkLabel_XLMJ>Key Concepts</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/installation><span title=Installation class=linkLabel_XLMJ>Installation</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/gettingstarted><span title="Getting Started" class=linkLabel_XLMJ>Getting Started</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/upgrading><span title=Upgrading class=linkLabel_XLMJ>Upgrading</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/cli><span title="Command Line Interface" class=linkLabel_XLMJ>Command Line Interface</span></a><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=/tools/staticdocs/docs/getting-started/util><span title="Utility Commands" class=linkLabel_XLMJ>Utility Commands</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/generators><span title="Code Generators" class=linkLabel_XLMJ>Code Generators</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/podman><span title=Podman class=linkLabel_XLMJ>Podman</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/requirements><span title="Requirements and Design" class=linkLabel_XLMJ>Requirements and Design</span></a></ul><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_u_d3 menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration><span title=Configuration class=categoryLinkLabel_RXyj>Configuration</span></a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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_u_d3 menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools><span title=Tools class=categoryLinkLabel_RXyj>Tools</span></a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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_u_d3 menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides><span title=Guides class=categoryLinkLabel_RXyj>Guides</span></a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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_u_d3 menu__link menu__link--sublist" href=/tools/staticdocs/docs/development><span title=Development class=categoryLinkLabel_RXyj>Development</span></a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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_u_d3 menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta><span title=Meta class=categoryLinkLabel_RXyj>Meta</span></a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy><span title="OpenC3, Inc. Privacy Policy" class=linkLabel_XLMJ>OpenC3, Inc. Privacy Policy</span></a></ul></nav></div></div></aside><main class=docMainContainer_I77d><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_Vt7O"><div class=docItemContainer_E44C><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_j0mV" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_bFVZ><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class=breadcrumbs__item><a class=breadcrumbs__link href=/tools/staticdocs/docs/getting-started><span>Getting Started</span></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Utility Commands</span></ul></nav><div class="tocCollapsible_XYrz theme-doc-toc-mobile tocMobile_SBzZ"><button type=button class="clean-btn tocCollapsibleButton_hLJL">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Utility Commands</h1></header><p>The COSMOS Util is a command on <code>openc3.sh</code> and <code>openc3.bat</code> which are included in the COSMOS <a href=https://github.com/OpenC3/cosmos-project target=_blank rel="noopener noreferrer" class="">project</a> (more about <a class="" href=/tools/staticdocs/docs/getting-started/key-concepts#projects>projects</a>).</p>
5
+ <p>If you followed the <a class="" href=/tools/staticdocs/docs/getting-started/installation>Installation Guide</a> you should already be inside a cloned <a href=https://github.com/OpenC3/cosmos-project target=_blank rel="noopener noreferrer" class="">cosmos-project</a> which is in your PATH (necessary for openc3.bat / openc3.sh to be resolved).</p>
6
+ <div class="theme-admonition theme-admonition-note admonition_C0T0 alert alert--secondary"><div class=admonitionHeading_mLyw><span class=admonitionIcon_OyK8><svg viewBox="0 0 14 16"><path fill-rule=evenodd d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"/></svg></span>note</div><div class=admonitionContent_AIhD><p>The utility script automatically detects and uses either Docker or Podman. If Docker is not found, it will use Podman as a fallback. If neither is available, the script will exit with an error.</div></div>
7
+ <p>To see all the available commands, type the following:</p>
8
+ <div class="language-zsh codeBlockContainer_LH35 theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mFD5><pre tabindex=0 class="prism-code language-zsh codeBlock_RQxj thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_WS_B><span class=token-line style=color:#d6deeb><span class="token plain">❯ ./openc3.sh util</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">Usage: scripts/linux/openc3_util.sh [encode, hash, save, load, tag, push, clean, hostsetup]</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">* encode: encode a string to base64</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">* hash: hash a string using SHA-256</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">* save: save images to a tar file</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">* load: load images from a tar file</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">* tag: tag images</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">* push: push images</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">* clean: remove node_modules, coverage, etc</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">* hostsetup: configure host for redis</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">* hostenter: sh into vm host</span><br/></span></code></pre></div></div>
9
+ <h2 class="anchor anchorTargetStickyNavbar_BQm5" id=encode>Encode<a href=#encode class=hash-link aria-label="Direct link to Encode" title="Direct link to Encode" translate=no>​</a></h2>
10
+ <p>Encode a string to base64. This is useful for encoding credentials or configuration values.</p>
11
+ <div class="language-zsh codeBlockContainer_LH35 theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mFD5><pre tabindex=0 class="prism-code language-zsh codeBlock_RQxj thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_WS_B><span class=token-line style=color:#d6deeb><span class="token plain">❯ ./openc3.sh util encode foo</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">Zm9v</span><br/></span></code></pre></div></div>
12
+ <p><strong>Usage</strong>: <code>encode &lt;STRING></code></p>
13
+ <p>Parameters:</p>
14
+ <ul>
15
+ <li class=""><code>STRING</code>: The string to encode</li>
16
+ </ul>
17
+ <h2 class="anchor anchorTargetStickyNavbar_BQm5" id=hash>Hash<a href=#hash class=hash-link aria-label="Direct link to Hash" title="Direct link to Hash" translate=no>​</a></h2>
18
+ <p>Hash a string using SHA-256. This is useful for generating checksums or verifying data integrity.</p>
19
+ <div class="language-zsh codeBlockContainer_LH35 theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mFD5><pre tabindex=0 class="prism-code language-zsh codeBlock_RQxj thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_WS_B><span class=token-line style=color:#d6deeb><span class="token plain">❯ ./openc3.sh util hash foo</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae</span><br/></span></code></pre></div></div>
20
+ <p><strong>Usage</strong>: <code>hash &lt;STRING></code></p>
21
+ <p>Parameters:</p>
22
+ <ul>
23
+ <li class=""><code>STRING</code>: The string to hash</li>
24
+ </ul>
25
+ <h2 class="anchor anchorTargetStickyNavbar_BQm5" id=save>Save<a href=#save class=hash-link aria-label="Direct link to Save" title="Direct link to Save" translate=no>​</a></h2>
26
+ <p>Save images to tar file. This command pulls all COSMOS Docker images from the specified repository and saves them as tar files in the <code>tmp/</code> directory.</p>
27
+ <div class="language-zsh codeBlockContainer_LH35 theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mFD5><pre tabindex=0 class="prism-code language-zsh codeBlock_RQxj thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_WS_B><span class=token-line style=color:#d6deeb><span class="token plain">❯ ./openc3.sh util save docker.io openc3inc 5.19.0</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">+ docker pull docker.io/openc3inc/openc3-ruby:5.19.0</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">+ docker pull docker.io/openc3inc/openc3-node:5.19.0</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">...</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">+ docker save docker.io/openc3inc/openc3-ruby:5.19.0 -o tmp/openc3-ruby-5.19.0.tar</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">...</span><br/></span></code></pre></div></div>
28
+ <p><strong>Usage</strong>: <code>save &lt;REPO> &lt;NAMESPACE> &lt;TAG> &lt;SUFFIX></code></p>
29
+ <p>Parameters:</p>
30
+ <ul>
31
+ <li class=""><code>REPO</code>: Docker repository (e.g., docker.io)</li>
32
+ <li class=""><code>NAMESPACE</code>: Image namespace (e.g., openc3inc)</li>
33
+ <li class=""><code>TAG</code>: Image tag/version (e.g., 5.19.0)</li>
34
+ <li class=""><code>SUFFIX</code>: (Optional) Image name suffix for custom builds</li>
35
+ </ul>
36
+ <h2 class="anchor anchorTargetStickyNavbar_BQm5" id=load>Load<a href=#load class=hash-link aria-label="Direct link to Load" title="Direct link to Load" translate=no>​</a></h2>
37
+ <p>Load images from tar files in the <code>tmp/</code> directory. This command loads all COSMOS Docker images from previously saved tar files.</p>
38
+ <div class="language-zsh codeBlockContainer_LH35 theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mFD5><pre tabindex=0 class="prism-code language-zsh codeBlock_RQxj thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_WS_B><span class=token-line style=color:#d6deeb><span class="token plain">❯ ./openc3.sh util load 5.19.0</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">+ docker load -i tmp/openc3-ruby-5.19.0.tar</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">+ docker load -i tmp/openc3-node-5.19.0.tar</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">...</span><br/></span></code></pre></div></div>
39
+ <p><strong>Usage</strong>: <code>load &lt;TAG> &lt;SUFFIX></code></p>
40
+ <p>Parameters:</p>
41
+ <ul>
42
+ <li class=""><code>TAG</code>: (Optional) Image tag/version (defaults to "latest")</li>
43
+ <li class=""><code>SUFFIX</code>: (Optional) Image name suffix for custom builds</li>
44
+ </ul>
45
+ <p>Example loading latest:</p>
46
+ <div class="language-zsh codeBlockContainer_LH35 theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mFD5><pre tabindex=0 class="prism-code language-zsh codeBlock_RQxj thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_WS_B><span class=token-line style=color:#d6deeb><span class="token plain">❯ ./openc3.sh util load</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">+ docker load -i tmp/openc3-ruby-latest.tar</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">...</span><br/></span></code></pre></div></div>
47
+ <h2 class="anchor anchorTargetStickyNavbar_BQm5" id=tag>Tag<a href=#tag class=hash-link aria-label="Direct link to Tag" title="Direct link to Tag" translate=no>​</a></h2>
48
+ <p>Tag images from one repository/namespace to another. This is useful for pushing images to a local registry or retagging for different deployments.</p>
49
+ <div class="language-zsh codeBlockContainer_LH35 theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mFD5><pre tabindex=0 class="prism-code language-zsh codeBlock_RQxj thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_WS_B><span class=token-line style=color:#d6deeb><span class="token plain">❯ ./openc3.sh util tag docker.io localhost:12345 openc3inc latest</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">+ docker tag docker.io/openc3inc/openc3-ruby:latest localhost:12345/openc3inc/openc3-ruby:latest</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">+ docker tag docker.io/openc3inc/openc3-node:latest localhost:12345/openc3inc/openc3-node:latest</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">...</span><br/></span></code></pre></div></div>
50
+ <p><strong>Usage</strong>: <code>tag &lt;REPO1> &lt;REPO2> &lt;NAMESPACE1> &lt;TAG1> &lt;NAMESPACE2> &lt;TAG2> &lt;SUFFIX></code></p>
51
+ <p>Parameters:</p>
52
+ <ul>
53
+ <li class=""><code>REPO1</code>: Source repository (e.g., docker.io)</li>
54
+ <li class=""><code>REPO2</code>: Destination repository (e.g., localhost:12345)</li>
55
+ <li class=""><code>NAMESPACE1</code>: Source namespace (e.g., openc3inc)</li>
56
+ <li class=""><code>TAG1</code>: Source tag (e.g., latest)</li>
57
+ <li class=""><code>NAMESPACE2</code>: (Optional) Destination namespace (defaults to NAMESPACE1)</li>
58
+ <li class=""><code>TAG2</code>: (Optional) Destination tag (defaults to TAG1)</li>
59
+ <li class=""><code>SUFFIX</code>: (Optional) Image name suffix for custom builds</li>
60
+ </ul>
61
+ <p>Example with different namespace and tag:</p>
62
+ <div class="language-zsh codeBlockContainer_LH35 theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mFD5><pre tabindex=0 class="prism-code language-zsh codeBlock_RQxj thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_WS_B><span class=token-line style=color:#d6deeb><span class="token plain">❯ ./openc3.sh util tag docker.io localhost:12345 openc3inc latest mycompany 1.0.0</span><br/></span></code></pre></div></div>
63
+ <h2 class="anchor anchorTargetStickyNavbar_BQm5" id=push>Push<a href=#push class=hash-link aria-label="Direct link to Push" title="Direct link to Push" translate=no>​</a></h2>
64
+ <p>Push all COSMOS Docker images to a remote repository.</p>
65
+ <div class="language-zsh codeBlockContainer_LH35 theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mFD5><pre tabindex=0 class="prism-code language-zsh codeBlock_RQxj thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_WS_B><span class=token-line style=color:#d6deeb><span class="token plain">❯ ./openc3.sh util push localhost:12345 openc3inc latest</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">+ docker push localhost:12345/openc3inc/openc3-ruby:latest</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">+ docker push localhost:12345/openc3inc/openc3-node:latest</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">...</span><br/></span></code></pre></div></div>
66
+ <p><strong>Usage</strong>: <code>push &lt;REPO> &lt;NAMESPACE> &lt;TAG> &lt;SUFFIX></code></p>
67
+ <p>Parameters:</p>
68
+ <ul>
69
+ <li class=""><code>REPO</code>: Docker repository (e.g., localhost:12345)</li>
70
+ <li class=""><code>NAMESPACE</code>: Image namespace (e.g., openc3inc)</li>
71
+ <li class=""><code>TAG</code>: Image tag (e.g., latest)</li>
72
+ <li class=""><code>SUFFIX</code>: (Optional) Image name suffix for custom builds</li>
73
+ </ul>
74
+ <h2 class="anchor anchorTargetStickyNavbar_BQm5" id=clean>Clean<a href=#clean class=hash-link aria-label="Direct link to Clean" title="Direct link to Clean" translate=no>​</a></h2>
75
+ <p>Remove development artifacts and lock files from the repository. This command helps clean up your workspace.</p>
76
+ <p>What gets cleaned:</p>
77
+ <ul>
78
+ <li class="">All <code>node_modules</code> directories (removed automatically)</li>
79
+ <li class="">All <code>coverage</code> directories (removed automatically)</li>
80
+ <li class="">All <code>pnpm-lock.yaml</code> files (prompts for confirmation)</li>
81
+ <li class="">All <code>Gemfile.lock</code> files (prompts for confirmation)</li>
82
+ </ul>
83
+ <div class="language-zsh codeBlockContainer_LH35 theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mFD5><pre tabindex=0 class="prism-code language-zsh codeBlock_RQxj thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_WS_B><span class=token-line style=color:#d6deeb><span class="token plain">❯ ./openc3.sh util clean</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">Removing ./openc3/node_modules</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">Removing ./openc3-cosmos-init/plugins/node_modules</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">...</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">remove ./pnpm-lock.yaml? y</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">remove ./openc3/Gemfile.lock? y</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">...</span><br/></span></code></pre></div></div>
84
+ <p><strong>Note</strong>: This command will prompt you before removing lock files to prevent accidental deletion.</p>
85
+ <h2 class="anchor anchorTargetStickyNavbar_BQm5" id=hostsetup>Hostsetup<a href=#hostsetup class=hash-link aria-label="Direct link to Hostsetup" title="Direct link to Hostsetup" translate=no>​</a></h2>
86
+ <p>Configure the Docker/Podman host VM for Redis requirements. This command sets kernel parameters needed for optimal Redis performance.</p>
87
+ <p>This command configures:</p>
88
+ <ul>
89
+ <li class="">Disables transparent huge pages (THP)</li>
90
+ <li class="">Sets <code>vm.max_map_count</code> to 262144</li>
91
+ </ul>
92
+ <div class="language-zsh codeBlockContainer_LH35 theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mFD5><pre tabindex=0 class="prism-code language-zsh codeBlock_RQxj thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_WS_B><span class=token-line style=color:#d6deeb><span class="token plain">❯ ./openc3.sh util hostsetup docker.io openc3inc latest</span><br/></span></code></pre></div></div>
93
+ <p><strong>Usage</strong>: <code>hostsetup &lt;REPO> &lt;NAMESPACE> &lt;TAG></code></p>
94
+ <p>Parameters:</p>
95
+ <ul>
96
+ <li class=""><code>REPO</code>: Docker repository containing the operator image</li>
97
+ <li class=""><code>NAMESPACE</code>: Image namespace (e.g., openc3inc)</li>
98
+ <li class=""><code>TAG</code>: Image tag (e.g., latest)</li>
99
+ </ul>
100
+ <p><strong>Note</strong>: This command requires privileged access and is typically run once during initial setup or when Redis warnings appear.</p>
101
+ <h2 class="anchor anchorTargetStickyNavbar_BQm5" id=hostenter>Hostenter<a href=#hostenter class=hash-link aria-label="Direct link to Hostenter" title="Direct link to Hostenter" translate=no>​</a></h2>
102
+ <p>Open a shell into the Docker/Podman host VM. This is useful for debugging and inspecting the host environment.</p>
103
+ <div class="language-zsh codeBlockContainer_LH35 theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_mFD5><pre tabindex=0 class="prism-code language-zsh codeBlock_RQxj thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_WS_B><span class=token-line style=color:#d6deeb><span class="token plain">❯ ./openc3.sh util hostenter</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">Unable to find image 'alpine:3.21.4' locally</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">3.21.4: Pulling from library/alpine</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">Digest: sha256:b6a6be0ff92ab6db8acd94f5d1b7a6c2f0f5d10ce3c24af348d333ac6da80685</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">Status: Downloaded newer image for alpine:3.21.4</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">sh-5.2# uname -a</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">Linux docker-desktop 6.10.4-linuxkit #1 SMP PREEMPT_DYNAMIC Thu Aug 8 14:33:14 UTC 2024 aarch64 Linux</span><br/></span><span class=token-line style=color:#d6deeb><span class="token plain">sh-5.2# exit</span><br/></span></code></pre></div></div>
104
+ <p><strong>Usage</strong>: <code>hostenter</code></p>
105
+ <p>No parameters required.</p>
106
+ <p><strong>Environment Variables</strong>:</p>
107
+ <ul>
108
+ <li class=""><code>OPENC3_DEPENDENCY_REGISTRY</code>: Registry for the Alpine image (defaults if not set)</li>
109
+ <li class=""><code>ALPINE_VERSION</code>: Alpine Linux version</li>
110
+ <li class=""><code>ALPINE_BUILD</code>: Alpine Linux build number</li>
111
+ </ul>
112
+ <p><strong>Note</strong>: This command requires privileged access and opens an interactive shell. Type <code>exit</code> to leave the host shell.</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_yVnS"><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/util.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_ilel 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"/></g></svg>Edit this page</a></div><div class="col lastUpdated_UZ1E"></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=/tools/staticdocs/docs/getting-started/cli><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Command Line Interface</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/getting-started/generators><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Code Generators</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_Ka_U thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#encode class="table-of-contents__link toc-highlight">Encode</a><li><a href=#hash class="table-of-contents__link toc-highlight">Hash</a><li><a href=#save class="table-of-contents__link toc-highlight">Save</a><li><a href=#load class="table-of-contents__link toc-highlight">Load</a><li><a href=#tag class="table-of-contents__link toc-highlight">Tag</a><li><a href=#push class="table-of-contents__link toc-highlight">Push</a><li><a href=#clean class="table-of-contents__link toc-highlight">Clean</a><li><a href=#hostsetup class="table-of-contents__link toc-highlight">Hostsetup</a><li><a href=#hostenter class="table-of-contents__link toc-highlight">Hostenter</a></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>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></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/openc3 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_IsiZ><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos 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_IsiZ><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div></body>
@@ -1,4 +1,4 @@
1
- <!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.9.1"><title data-rh=true>Getting Started | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/getting-started /><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="Getting Started | OpenC3 Docs"/><meta data-rh=true name=description content="Get started with OpenC3 COSMOS"/><meta data-rh=true property=og:description content="Get started with OpenC3 COSMOS"/><link data-rh=true rel=icon href=/tools/staticdocs/img/favicon.png /><link data-rh=true rel=canonical href=https://docs.openc3.com/tools/staticdocs/docs/getting-started /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started hreflang=en /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/getting-started","name":"Getting Started","position":1}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.946be27d.css /><script src=/tools/staticdocs/assets/js/runtime~main.53a0c91e.js defer></script><script src=/tools/staticdocs/assets/js/main.331b7e10.js defer></script></head><body class=navigation-with-keyboard><svg style="display: none;"><defs>
1
+ <!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.9.2"><title data-rh=true>Getting Started | OpenC3 Docs</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:url content=https://docs.openc3.com/tools/staticdocs/docs/getting-started /><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="Getting Started | OpenC3 Docs"/><meta data-rh=true name=description content="Get started with OpenC3 COSMOS"/><meta data-rh=true property=og:description content="Get started with OpenC3 COSMOS"/><link data-rh=true rel=icon href=/tools/staticdocs/img/favicon.png /><link data-rh=true rel=canonical href=https://docs.openc3.com/tools/staticdocs/docs/getting-started /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started hreflang=en /><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://docs.openc3.com/tools/staticdocs/docs/getting-started","name":"Getting Started","position":1}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.41902cce.css /><script src=/tools/staticdocs/assets/js/runtime~main.44a60fd4.js defer></script><script src=/tools/staticdocs/assets/js/main.1ae7ceb9.js defer></script></head><body class=navigation-with-keyboard><svg style="display: none;"><defs>
2
2
  <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>
3
3
  </defs></svg>
4
- <script>!function(){var t;document.documentElement.setAttribute("data-theme",t||"dark"),document.documentElement.setAttribute("data-theme-choice",t||"dark")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())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=/tools/staticdocs/img/logo.svg /><div role=region aria-label="Skip to main content"><a class=skipToContent_TKVD 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"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--light_cpFH"/><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_hQOn themedComponent--dark_whA_"/></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_YWZZ><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_E2as"><div class=docsWrapper_helv><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_C8jb" type=button></button><div class=docRoot_qfDj><aside class="theme-doc-sidebar-container docSidebarContainer_akt7"><div class=sidebarViewport__oqk><div class=sidebar_mbPS><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_cdbq"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs><span title=Introduction class=linkLabel_THKR>Introduction</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="categoryLink_m86C menu__link menu__link--sublist menu__link--active" aria-current=page href=/tools/staticdocs/docs/getting-started><span title="Getting Started" class=categoryLinkLabel_gwYM>Getting Started</span></a><button aria-label="Collapse sidebar category 'Getting Started'" 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=/tools/staticdocs/docs/getting-started/key-concepts><span title="Key Concepts" class=linkLabel_THKR>Key Concepts</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/installation><span title=Installation class=linkLabel_THKR>Installation</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/gettingstarted><span title="Getting Started" class=linkLabel_THKR>Getting Started</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/upgrading><span title=Upgrading class=linkLabel_THKR>Upgrading</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/cli><span title="Command Line Interface" class=linkLabel_THKR>Command Line Interface</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/generators><span title="Code Generators" class=linkLabel_THKR>Code Generators</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/podman><span title=Podman class=linkLabel_THKR>Podman</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/requirements><span title="Requirements and Design" class=linkLabel_THKR>Requirements and Design</span></a></ul><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_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration><span title=Configuration class=categoryLinkLabel_gwYM>Configuration</span></a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools><span title=Tools class=categoryLinkLabel_gwYM>Tools</span></a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides><span title=Guides class=categoryLinkLabel_gwYM>Guides</span></a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/development><span title=Development class=categoryLinkLabel_gwYM>Development</span></a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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_m86C menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta><span title=Meta class=categoryLinkLabel_gwYM>Meta</span></a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy><span title="OpenC3, Inc. Privacy Policy" class=linkLabel_THKR>OpenC3, Inc. Privacy Policy</span></a></ul></nav></div></div></aside><main class=docMainContainer_Aig4><div class="container padding-top--md padding-bottom--lg"><div class=generatedIndexPage_Elzq><nav class="theme-doc-breadcrumbs breadcrumbsContainer_rdSc" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_u_XA><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Getting Started</span></ul></nav><header><h1 class=title_CPuW>Getting Started</h1><p>Get started with OpenC3 COSMOS</header><article class=margin-top--lg><section class=row><article class="docCardListItem_Sndl col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/key-concepts><h2 class="text--truncate cardTitle_HoSo" title="Key Concepts">💡<!-- --> <!-- -->Key Concepts</h2><p class="text--truncate cardDescription_c27F" title="Projects, Containerization, Frontend, Backend">Projects, Containerization, Frontend, Backend</p></a></article><article class="docCardListItem_Sndl col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/installation><h2 class="text--truncate cardTitle_HoSo" title=Installation>💾<!-- --> <!-- -->Installation</h2><p class="text--truncate cardDescription_c27F" title="Installing OpenC3 COSMOS">Installing OpenC3 COSMOS</p></a></article><article class="docCardListItem_Sndl col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/gettingstarted><h2 class="text--truncate cardTitle_HoSo" title="Getting Started">🧑‍💻<!-- --> <!-- -->Getting Started</h2><p class="text--truncate cardDescription_c27F" title="Getting starting with COSMOS">Getting starting with COSMOS</p></a></article><article class="docCardListItem_Sndl col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/upgrading><h2 class="text--truncate cardTitle_HoSo" title=Upgrading>⬆️<!-- --> <!-- -->Upgrading</h2><p class="text--truncate cardDescription_c27F" title="How to upgrade and migrate COSMOS">How to upgrade and migrate COSMOS</p></a></article><article class="docCardListItem_Sndl col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/cli><h2 class="text--truncate cardTitle_HoSo" title="Command Line Interface">⌨️<!-- --> <!-- -->Command Line Interface</h2><p class="text--truncate cardDescription_c27F" title="Using openc3.sh">Using openc3.sh</p></a></article><article class="docCardListItem_Sndl col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/generators><h2 class="text--truncate cardTitle_HoSo" title="Code Generators">🏭<!-- --> <!-- -->Code Generators</h2><p class="text--truncate cardDescription_c27F" title="Using openc3.sh to generate code">Using openc3.sh to generate code</p></a></article><article class="docCardListItem_Sndl col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/podman><h2 class="text--truncate cardTitle_HoSo" title=Podman>🫛<!-- --> <!-- -->Podman</h2><p class="text--truncate cardDescription_c27F" title="Installing and running COSMOS with Podman">Installing and running COSMOS with Podman</p></a></article><article class="docCardListItem_Sndl col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/requirements><h2 class="text--truncate cardTitle_HoSo" title="Requirements and Design">📑<!-- --> <!-- -->Requirements and Design</h2><p class="text--truncate cardDescription_c27F" title="COSMOS Requirements and Design">COSMOS Requirements and Design</p></a></article></section></article><footer class=margin-top--md><nav class=pagination-nav aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Introduction</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/getting-started/key-concepts><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Key Concepts</div></a></nav></footer></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>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></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/openc3 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_mMqu><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos 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_mMqu><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div></body>
4
+ <script>!function(){var t;document.documentElement.setAttribute("data-theme",t||"dark"),document.documentElement.setAttribute("data-theme-choice",t||"dark")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())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=/tools/staticdocs/img/logo.svg /><div role=region aria-label="Skip to main content"><a class=skipToContent_Ad3x 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"/></svg></button><a class=navbar__brand href=/tools/staticdocs/><div class=navbar__logo><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_iYMB themedComponent--light__u60"/><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_iYMB themedComponent--dark_bnZ2"/></div><b class="navbar__title text--truncate">OpenC3 Docs</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/tools/staticdocs/docs>Documentation</a><a href=https://openc3.com/enterprise/ target=_blank rel="noopener noreferrer" class="navbar__item navbar__link">Enterprise</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><div class=navbarSearchContainer_BlpL><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_LBOZ"><div class=docsWrapper_fTY1><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_yH7o" type=button></button><div class=docRoot_stlz><aside class="theme-doc-sidebar-container docSidebarContainer_GDN6"><div class=sidebarViewport_N1UE><div class=sidebar_dl38><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu___bF"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs><span title=Introduction class=linkLabel_XLMJ>Introduction</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="categoryLink_u_d3 menu__link menu__link--sublist menu__link--active" aria-current=page href=/tools/staticdocs/docs/getting-started><span title="Getting Started" class=categoryLinkLabel_RXyj>Getting Started</span></a><button aria-label="Collapse sidebar category 'Getting Started'" 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=/tools/staticdocs/docs/getting-started/key-concepts><span title="Key Concepts" class=linkLabel_XLMJ>Key Concepts</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/installation><span title=Installation class=linkLabel_XLMJ>Installation</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/gettingstarted><span title="Getting Started" class=linkLabel_XLMJ>Getting Started</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/upgrading><span title=Upgrading class=linkLabel_XLMJ>Upgrading</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/cli><span title="Command Line Interface" class=linkLabel_XLMJ>Command Line Interface</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/util><span title="Utility Commands" class=linkLabel_XLMJ>Utility Commands</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/generators><span title="Code Generators" class=linkLabel_XLMJ>Code Generators</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/podman><span title=Podman class=linkLabel_XLMJ>Podman</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class=menu__link tabindex=0 href=/tools/staticdocs/docs/getting-started/requirements><span title="Requirements and Design" class=linkLabel_XLMJ>Requirements and Design</span></a></ul><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_u_d3 menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration><span title=Configuration class=categoryLinkLabel_RXyj>Configuration</span></a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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_u_d3 menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools><span title=Tools class=categoryLinkLabel_RXyj>Tools</span></a><button aria-label="Expand sidebar category 'Tools'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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_u_d3 menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides><span title=Guides class=categoryLinkLabel_RXyj>Guides</span></a><button aria-label="Expand sidebar category 'Guides'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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_u_d3 menu__link menu__link--sublist" href=/tools/staticdocs/docs/development><span title=Development class=categoryLinkLabel_RXyj>Development</span></a><button aria-label="Expand sidebar category 'Development'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><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_u_d3 menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta><span title=Meta class=categoryLinkLabel_RXyj>Meta</span></a><button aria-label="Expand sidebar category 'Meta'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/tools/staticdocs/docs/privacy><span title="OpenC3, Inc. Privacy Policy" class=linkLabel_XLMJ>OpenC3, Inc. Privacy Policy</span></a></ul></nav></div></div></aside><main class=docMainContainer_I77d><div class="container padding-top--md padding-bottom--lg"><div class=generatedIndexPage_Cx4z><nav class="theme-doc-breadcrumbs breadcrumbsContainer_j0mV" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/tools/staticdocs/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_bFVZ><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Getting Started</span></ul></nav><header><h1 class=title_IUPg>Getting Started</h1><p>Get started with OpenC3 COSMOS</header><article class=margin-top--lg><section class=row><article class="docCardListItem_VoKr col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/key-concepts><h2 class="text--truncate cardTitle_HoSo" title="Key Concepts">💡<!-- --> <!-- -->Key Concepts</h2><p class="text--truncate cardDescription_c27F" title="Projects, Containerization, Frontend, Backend">Projects, Containerization, Frontend, Backend</p></a></article><article class="docCardListItem_VoKr col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/installation><h2 class="text--truncate cardTitle_HoSo" title=Installation>💾<!-- --> <!-- -->Installation</h2><p class="text--truncate cardDescription_c27F" title="Installing OpenC3 COSMOS">Installing OpenC3 COSMOS</p></a></article><article class="docCardListItem_VoKr col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/gettingstarted><h2 class="text--truncate cardTitle_HoSo" title="Getting Started">🧑‍💻<!-- --> <!-- -->Getting Started</h2><p class="text--truncate cardDescription_c27F" title="Getting starting with COSMOS">Getting starting with COSMOS</p></a></article><article class="docCardListItem_VoKr col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/upgrading><h2 class="text--truncate cardTitle_HoSo" title=Upgrading>⬆️<!-- --> <!-- -->Upgrading</h2><p class="text--truncate cardDescription_c27F" title="How to upgrade and migrate COSMOS">How to upgrade and migrate COSMOS</p></a></article><article class="docCardListItem_VoKr col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/cli><h2 class="text--truncate cardTitle_HoSo" title="Command Line Interface">⌨️<!-- --> <!-- -->Command Line Interface</h2><p class="text--truncate cardDescription_c27F" title="Using openc3.sh">Using openc3.sh</p></a></article><article class="docCardListItem_VoKr col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/util><h2 class="text--truncate cardTitle_HoSo" title="Utility Commands">⌨️<!-- --> <!-- -->Utility Commands</h2><p class="text--truncate cardDescription_c27F" title="Using openc3.sh util">Using openc3.sh util</p></a></article><article class="docCardListItem_VoKr col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/generators><h2 class="text--truncate cardTitle_HoSo" title="Code Generators">🏭<!-- --> <!-- -->Code Generators</h2><p class="text--truncate cardDescription_c27F" title="Using openc3.sh to generate code">Using openc3.sh to generate code</p></a></article><article class="docCardListItem_VoKr col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/podman><h2 class="text--truncate cardTitle_HoSo" title=Podman>🫛<!-- --> <!-- -->Podman</h2><p class="text--truncate cardDescription_c27F" title="Installing and running COSMOS with Podman">Installing and running COSMOS with Podman</p></a></article><article class="docCardListItem_VoKr col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/getting-started/requirements><h2 class="text--truncate cardTitle_HoSo" title="Requirements and Design">📑<!-- --> <!-- -->Requirements and Design</h2><p class="text--truncate cardDescription_c27F" title="COSMOS Requirements and Design">COSMOS Requirements and Design</p></a></article></section></article><footer class=margin-top--md><nav class=pagination-nav aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href=/tools/staticdocs/docs><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Introduction</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/getting-started/key-concepts><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Key Concepts</div></a></nav></footer></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>Homepage</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://openc3.com target=_blank rel="noopener noreferrer" class=footer__link-item>Home</a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>Docs</div><ul class="footer__items clean-list"><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs>Documentation</a></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/openc3 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_IsiZ><use href=#theme-svg-external-link /></svg></a></ul></div><div class="theme-layout-footer-column col footer__col"><div class=footer__title>More</div><ul class="footer__items clean-list"><li class=footer__item><a href=https://github.com/OpenC3/cosmos 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_IsiZ><use href=#theme-svg-external-link /></svg></a><li class=footer__item><a class=footer__link-item href=/tools/staticdocs/docs/privacy>Privacy</a></ul></div></div><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2025 OpenC3, Inc.</div></div></div></footer></div></body>