openc3-cosmos-tool-docs 6.4.2 → 6.5.0
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.
- checksums.yaml +4 -4
- data/tools/staticdocs/404.html +1 -1
- data/tools/staticdocs/assets/images/alert_logs-8273c6912804a4a16ce15d59cedf266f32d8c0a4ace2ab25fd8d3f149fb7fed2.png +0 -0
- data/tools/staticdocs/assets/images/alert_notifications-c68f0ff77eec9c2bc0d31bd6693fce4055d21722f985e418c05533992be71631.png +0 -0
- data/tools/staticdocs/assets/images/checks_rb-4e28c3a8422638404e790054f83f6a61592f5cf848ff6d9bd1ce228813622c9a.png +0 -0
- data/tools/staticdocs/assets/images/disk_usage-c91c5ef35de6ec1c4ebcf485c6f74c68daeac6215bf185691ed613b7fd2a95cf.png +0 -0
- data/tools/staticdocs/assets/images/environment_variables-72bbb71e6f428ec5efa340eb402289b6d42a84d3c5ce724025d32415242dec09.png +0 -0
- data/tools/staticdocs/assets/images/process_metrics-534358ca0a064ed4c24ff1a29f48686d1189e331da23e0f7a6625405278b31eb.png +0 -0
- data/tools/staticdocs/assets/images/redis_metrics-646d362a7855604a8b6de1b7064f6949914be7b84ad1ab78822990d56d6ebcc1.png +0 -0
- data/tools/staticdocs/assets/images/refresh_interval-8673071593ce24cb2bb0adedfd0e7fc4d612496c393c7f3f52ba37db497f9344.png +0 -0
- data/tools/staticdocs/assets/images/right_click-81df09085fe9f75805cf35b5876177789eef0d879b54a734a8395e3817f1959d.png +0 -0
- data/tools/staticdocs/assets/images/script_suite-0d1f45f9226d3ac0ed12d5ce91220dccf88402fd8582c4512acc8886a3cf2249.png +0 -0
- data/tools/staticdocs/assets/images/system_health_configuration-728cde02f1da6b75e606152e113e288b6d949dd1f4183c4691b0f61c4c47b30e.png +0 -0
- data/tools/staticdocs/assets/images/system_overview_gauges-3975fb0011287cf4f98af7dfdf9dba681943913c0b47642645cd19b583e35b74.png +0 -0
- data/tools/staticdocs/assets/images/systemhealth-fc26a7d9cda6242569255ecd4264d1c91ad47d85a3805b610d3c946e0d10cfbf.png +0 -0
- data/tools/staticdocs/assets/js/019369f3.52424baa.js +1 -0
- data/tools/staticdocs/assets/js/058ffc22.82c2873e.js +1 -0
- data/tools/staticdocs/assets/js/0686a885.f620e3dc.js +1 -0
- data/tools/staticdocs/assets/js/{078dbab0.43788fd9.js → 078dbab0.babf69ab.js} +1 -1
- data/tools/staticdocs/assets/js/0f5d161c.bc74590c.js +1 -0
- data/tools/staticdocs/assets/js/0ff569c9.14ed0a79.js +1 -0
- data/tools/staticdocs/assets/js/103cc3be.b15ac140.js +1 -0
- data/tools/staticdocs/assets/js/13196248.e1f20841.js +1 -0
- data/tools/staticdocs/assets/js/13c1b4e4.58a03be2.js +1 -0
- data/tools/staticdocs/assets/js/1602.a7ddd3dc.js +1 -0
- data/tools/staticdocs/assets/js/1e02e6a3.68a73184.js +1 -0
- data/tools/staticdocs/assets/js/2047b354.58bf5de8.js +1 -0
- data/tools/staticdocs/assets/js/22b3ac48.5ab6a17a.js +1 -0
- data/tools/staticdocs/assets/js/2368.4443f5c4.js +4 -0
- data/tools/staticdocs/assets/js/2bb7bf90.882f03a1.js +1 -0
- data/tools/staticdocs/assets/js/2c15ad40.a56e1a40.js +1 -0
- data/tools/staticdocs/assets/js/35398c5c.d6cb2a82.js +1 -0
- data/tools/staticdocs/assets/js/3687.062fee32.js +101 -0
- data/tools/staticdocs/assets/js/3dd7ef3b.4782cafe.js +1 -0
- data/tools/staticdocs/assets/js/40365d27.cdd0a061.js +1 -0
- data/tools/staticdocs/assets/js/411898ad.63be48ce.js +1 -0
- data/tools/staticdocs/assets/js/42170351.49ebb70c.js +1 -0
- data/tools/staticdocs/assets/js/43652efd.deefbd37.js +1 -0
- data/tools/staticdocs/assets/js/54d0d530.9fccf082.js +1 -0
- data/tools/staticdocs/assets/js/59ed27a4.6a4d4905.js +1 -0
- data/tools/staticdocs/assets/js/5b233ba7.169a9701.js +1 -0
- data/tools/staticdocs/assets/js/5bc719f6.adbdce65.js +1 -0
- data/tools/staticdocs/assets/js/5c6ce5ec.1827793d.js +1 -0
- data/tools/staticdocs/assets/js/5fe211ef.866de8e9.js +1 -0
- data/tools/staticdocs/assets/js/6831b732.d0e1b5a6.js +1 -0
- data/tools/staticdocs/assets/js/696b4199.adf3731a.js +1 -0
- data/tools/staticdocs/assets/js/6b210247.bb5dedd5.js +1 -0
- data/tools/staticdocs/assets/js/6b65133b.c431a22a.js +1 -0
- data/tools/staticdocs/assets/js/6f92e431.13b5aeef.js +1 -0
- data/tools/staticdocs/assets/js/72c6d8a8.8f66ae6e.js +1 -0
- data/tools/staticdocs/assets/js/75e64983.31d1e579.js +1 -0
- data/tools/staticdocs/assets/js/7719.d199daa3.js +1 -0
- data/tools/staticdocs/assets/js/80c97f38.4f6a5637.js +1 -0
- data/tools/staticdocs/assets/js/{867640d5.32ca371f.js → 867640d5.9dd71bf3.js} +1 -1
- data/tools/staticdocs/assets/js/89e76475.a0353bb2.js +1 -0
- data/tools/staticdocs/assets/js/8b939c74.5fd8e3e8.js +1 -0
- data/tools/staticdocs/assets/js/8f7843ee.b3358f6f.js +1 -0
- data/tools/staticdocs/assets/js/9424f0b3.b8d6d2bf.js +1 -0
- data/tools/staticdocs/assets/js/964eb012.cb76dd8a.js +1 -0
- data/tools/staticdocs/assets/js/97535711.c3a1a5a1.js +1 -0
- data/tools/staticdocs/assets/js/99581c43.c9f8e384.js +1 -0
- data/tools/staticdocs/assets/js/9fb6059a.91edfcba.js +1 -0
- data/tools/staticdocs/assets/js/a677c089.d33ab1ca.js +1 -0
- data/tools/staticdocs/assets/js/a9987364.530c9592.js +1 -0
- data/tools/staticdocs/assets/js/a9b2dc27.50f54e80.js +1 -0
- data/tools/staticdocs/assets/js/{aa6b6c1b.bc122746.js → aa6b6c1b.dc1c4a62.js} +1 -1
- data/tools/staticdocs/assets/js/{b062d239.4e8142cb.js → b062d239.ff2df9fd.js} +1 -1
- data/tools/staticdocs/assets/js/b38a6d74.62bc94a3.js +1 -0
- data/tools/staticdocs/assets/js/b4596165.a2357781.js +1 -0
- data/tools/staticdocs/assets/js/b6d70f94.22ca3e8a.js +1 -0
- data/tools/staticdocs/assets/js/b9f60ba6.677e8e46.js +1 -0
- data/tools/staticdocs/assets/js/{bd0034eb.a201a4a7.js → bd0034eb.09d6bbbc.js} +1 -1
- data/tools/staticdocs/assets/js/c24eae19.3db158fe.js +1 -0
- data/tools/staticdocs/assets/js/cb8c3f08.0de82997.js +1 -0
- data/tools/staticdocs/assets/js/cd879be4.d650ab29.js +1 -0
- data/tools/staticdocs/assets/js/d1b923aa.240ccf18.js +1 -0
- data/tools/staticdocs/assets/js/d1bfc316.5c7b9c2f.js +1 -0
- data/tools/staticdocs/assets/js/{d24bf9b6.e348c06d.js → d24bf9b6.ea1e95ab.js} +1 -1
- data/tools/staticdocs/assets/js/d57a4b5d.82790d9f.js +1 -0
- data/tools/staticdocs/assets/js/d5d77c37.a1299467.js +1 -0
- data/tools/staticdocs/assets/js/d66bf9c0.8018f0a0.js +1 -0
- data/tools/staticdocs/assets/js/d8ca4191.ca5f5dde.js +1 -0
- data/tools/staticdocs/assets/js/d9b92eba.41086b81.js +1 -0
- data/tools/staticdocs/assets/js/db8fa1d0.5107d903.js +1 -0
- data/tools/staticdocs/assets/js/dbe31111.8f1677f3.js +1 -0
- data/tools/staticdocs/assets/js/dc5f7beb.dfbe012c.js +1 -0
- data/tools/staticdocs/assets/js/e501b0d1.512e0a0b.js +1 -0
- data/tools/staticdocs/assets/js/{f15615f1.a4d98d69.js → f15615f1.d668576a.js} +1 -1
- data/tools/staticdocs/assets/js/f75a5f33.d3a97a44.js +1 -0
- data/tools/staticdocs/assets/js/main.8c741ee1.js +38 -0
- data/tools/staticdocs/assets/js/runtime~main.7674b06d.js +1 -0
- data/tools/staticdocs/docs/configuration/accessors.html +2 -2
- data/tools/staticdocs/docs/configuration/command.html +2 -2
- data/tools/staticdocs/docs/configuration/conversions.html +10 -8
- data/tools/staticdocs/docs/configuration/format.html +2 -2
- data/tools/staticdocs/docs/configuration/interfaces.html +2 -2
- data/tools/staticdocs/docs/configuration/limits-response.html +19 -0
- data/tools/staticdocs/docs/configuration/plugins.html +9 -3
- data/tools/staticdocs/docs/configuration/processors.html +42 -0
- data/tools/staticdocs/docs/configuration/protocols.html +2 -2
- data/tools/staticdocs/docs/configuration/ssl-tls.html +2 -2
- data/tools/staticdocs/docs/configuration/table.html +3 -3
- data/tools/staticdocs/docs/configuration/target.html +2 -2
- data/tools/staticdocs/docs/configuration/telemetry-screens.html +9 -9
- data/tools/staticdocs/docs/configuration/telemetry.html +4 -2
- data/tools/staticdocs/docs/configuration.html +2 -2
- data/tools/staticdocs/docs/development/curl.html +1 -1
- data/tools/staticdocs/docs/development/developing.html +1 -1
- data/tools/staticdocs/docs/development/json-api.html +1 -1
- data/tools/staticdocs/docs/development/log-structure.html +1 -1
- data/tools/staticdocs/docs/development/roadmap.html +1 -1
- data/tools/staticdocs/docs/development/streaming-api.html +1 -1
- data/tools/staticdocs/docs/development/testing.html +1 -1
- data/tools/staticdocs/docs/development.html +1 -1
- data/tools/staticdocs/docs/getting-started/cli.html +16 -5
- data/tools/staticdocs/docs/getting-started/generators.html +19 -21
- data/tools/staticdocs/docs/getting-started/gettingstarted.html +1 -1
- data/tools/staticdocs/docs/getting-started/installation.html +1 -1
- data/tools/staticdocs/docs/getting-started/key-concepts.html +1 -1
- data/tools/staticdocs/docs/getting-started/podman.html +5 -2
- data/tools/staticdocs/docs/getting-started/requirements.html +1 -1
- data/tools/staticdocs/docs/getting-started/upgrading.html +2 -2
- data/tools/staticdocs/docs/getting-started.html +1 -1
- data/tools/staticdocs/docs/guides/bridges.html +1 -1
- data/tools/staticdocs/docs/guides/cfs.html +1 -1
- data/tools/staticdocs/docs/guides/custom-widgets.html +1 -1
- data/tools/staticdocs/docs/guides/dynamic-packets.html +3 -1
- data/tools/staticdocs/docs/guides/exposing-microservices.html +1 -1
- data/tools/staticdocs/docs/guides/little-endian-bitfields.html +1 -1
- data/tools/staticdocs/docs/guides/local-mode.html +1 -1
- data/tools/staticdocs/docs/guides/logging.html +1 -1
- data/tools/staticdocs/docs/guides/monitoring.html +1 -1
- data/tools/staticdocs/docs/guides/performance.html +1 -1
- data/tools/staticdocs/docs/guides/raspberrypi.html +1 -1
- data/tools/staticdocs/docs/guides/reference-architectures.html +1 -1
- data/tools/staticdocs/docs/guides/script-writing.html +1 -1
- data/tools/staticdocs/docs/guides/scripting-api.html +2 -2
- data/tools/staticdocs/docs/guides.html +1 -1
- data/tools/staticdocs/docs/meta/contributing.html +1 -1
- data/tools/staticdocs/docs/meta/licenses.html +1 -1
- data/tools/staticdocs/docs/meta/philosophy.html +1 -1
- data/tools/staticdocs/docs/meta/xtce.html +1 -1
- data/tools/staticdocs/docs/meta.html +1 -1
- data/tools/staticdocs/docs/privacy.html +1 -1
- data/tools/staticdocs/docs/tools/admin.html +2 -2
- data/tools/staticdocs/docs/tools/autonomic.html +2 -2
- data/tools/staticdocs/docs/tools/bucket-explorer.html +2 -2
- data/tools/staticdocs/docs/tools/calendar.html +2 -2
- data/tools/staticdocs/docs/tools/cmd-sender.html +2 -2
- data/tools/staticdocs/docs/tools/cmd-tlm-server.html +2 -2
- data/tools/staticdocs/docs/tools/command_history.html +2 -2
- data/tools/staticdocs/docs/tools/data-extractor.html +2 -2
- data/tools/staticdocs/docs/tools/data-viewer.html +2 -2
- data/tools/staticdocs/docs/tools/handbooks.html +2 -2
- data/tools/staticdocs/docs/tools/limits-monitor.html +2 -2
- data/tools/staticdocs/docs/tools/packet-viewer.html +2 -2
- data/tools/staticdocs/docs/tools/script-runner.html +12 -6
- data/tools/staticdocs/docs/tools/systemhealth.html +42 -0
- data/tools/staticdocs/docs/tools/table-manager.html +3 -3
- data/tools/staticdocs/docs/tools/tlm-grapher.html +2 -2
- data/tools/staticdocs/docs/tools/tlm-viewer.html +2 -2
- data/tools/staticdocs/docs/tools.html +2 -2
- data/tools/staticdocs/docs.html +1 -1
- data/tools/staticdocs/img/script_runner/checks_rb.png +0 -0
- data/tools/staticdocs/img/script_runner/environment_variables.png +0 -0
- data/tools/staticdocs/img/script_runner/right_click.png +0 -0
- data/tools/staticdocs/img/script_runner/script_suite.png +0 -0
- data/tools/staticdocs/img/systemhealth/alert_logs.png +0 -0
- data/tools/staticdocs/img/systemhealth/alert_notifications.png +0 -0
- data/tools/staticdocs/img/systemhealth/disk_usage.png +0 -0
- data/tools/staticdocs/img/systemhealth/process_metrics.png +0 -0
- data/tools/staticdocs/img/systemhealth/redis_metrics.png +0 -0
- data/tools/staticdocs/img/systemhealth/refresh_interval.png +0 -0
- data/tools/staticdocs/img/systemhealth/system_health_configuration.png +0 -0
- data/tools/staticdocs/img/systemhealth/system_overview_gauges.png +0 -0
- data/tools/staticdocs/img/systemhealth/systemhealth.png +0 -0
- data/tools/staticdocs/index.html +1 -1
- data/tools/staticdocs/lunr-index-1749788530521.json +1 -0
- data/tools/staticdocs/lunr-index.json +1 -1
- data/tools/staticdocs/markdown-page.html +1 -1
- data/tools/staticdocs/search-doc-1749788530521.json +1 -0
- data/tools/staticdocs/search-doc.json +1 -1
- data/tools/staticdocs/sitemap.xml +1 -1
- metadata +105 -79
- data/tools/staticdocs/assets/images/checks_rb-89f400098ff47774008ea420860c665c15ebf06819c3ee7050bed301ea0a9f46.png +0 -0
- data/tools/staticdocs/assets/images/right_click-371e3683026c0bb2b27187277b4e99727c6b52965e0190a5f81335248f40ef9b.png +0 -0
- data/tools/staticdocs/assets/images/script_suite-16647c3b3de01a8749f1b5c4ab2f8b452630df8c0470e5be38652acacfc98b5d.png +0 -0
- data/tools/staticdocs/assets/js/019369f3.5dd06a57.js +0 -1
- data/tools/staticdocs/assets/js/058ffc22.ed3ac5fa.js +0 -1
- data/tools/staticdocs/assets/js/0686a885.ef66a55c.js +0 -1
- data/tools/staticdocs/assets/js/0f5d161c.7aacaf90.js +0 -1
- data/tools/staticdocs/assets/js/0ff569c9.7aa50138.js +0 -1
- data/tools/staticdocs/assets/js/103cc3be.ff33b528.js +0 -1
- data/tools/staticdocs/assets/js/13196248.14de6ce1.js +0 -1
- data/tools/staticdocs/assets/js/13c1b4e4.2dafa283.js +0 -1
- data/tools/staticdocs/assets/js/1602.502ef9b1.js +0 -1
- data/tools/staticdocs/assets/js/1e02e6a3.d99a363c.js +0 -1
- data/tools/staticdocs/assets/js/2047b354.d91543a5.js +0 -1
- data/tools/staticdocs/assets/js/22b3ac48.5eb8d876.js +0 -1
- data/tools/staticdocs/assets/js/2368.fd1bb46a.js +0 -4
- data/tools/staticdocs/assets/js/2bb7bf90.1eee5bcb.js +0 -1
- data/tools/staticdocs/assets/js/2c15ad40.7f30b517.js +0 -1
- data/tools/staticdocs/assets/js/35398c5c.4f30c5da.js +0 -1
- data/tools/staticdocs/assets/js/3687.8bc61ef3.js +0 -101
- data/tools/staticdocs/assets/js/3dd7ef3b.dfbe9bb7.js +0 -1
- data/tools/staticdocs/assets/js/40365d27.42b05c12.js +0 -1
- data/tools/staticdocs/assets/js/411898ad.e55efd5d.js +0 -1
- data/tools/staticdocs/assets/js/42170351.2de491d4.js +0 -1
- data/tools/staticdocs/assets/js/43652efd.f7c95691.js +0 -1
- data/tools/staticdocs/assets/js/54d0d530.7cc2c5cc.js +0 -1
- data/tools/staticdocs/assets/js/5b233ba7.29533a03.js +0 -1
- data/tools/staticdocs/assets/js/5bc719f6.62d9a8b8.js +0 -1
- data/tools/staticdocs/assets/js/5c6ce5ec.40e0caf8.js +0 -1
- data/tools/staticdocs/assets/js/5fe211ef.2d29f3fb.js +0 -1
- data/tools/staticdocs/assets/js/6831b732.ec0009ac.js +0 -1
- data/tools/staticdocs/assets/js/696b4199.1c205c60.js +0 -1
- data/tools/staticdocs/assets/js/6b210247.32ded6d5.js +0 -1
- data/tools/staticdocs/assets/js/6b65133b.b2a62736.js +0 -1
- data/tools/staticdocs/assets/js/6f92e431.7bd2a1f1.js +0 -1
- data/tools/staticdocs/assets/js/72c6d8a8.21321ecc.js +0 -1
- data/tools/staticdocs/assets/js/75e64983.e0eb7741.js +0 -1
- data/tools/staticdocs/assets/js/7719.0d312792.js +0 -1
- data/tools/staticdocs/assets/js/80c97f38.a0dfbdf7.js +0 -1
- data/tools/staticdocs/assets/js/89e76475.20b3a636.js +0 -1
- data/tools/staticdocs/assets/js/8f7843ee.6d7c9cd4.js +0 -1
- data/tools/staticdocs/assets/js/9424f0b3.75b12400.js +0 -1
- data/tools/staticdocs/assets/js/964eb012.0eee94ba.js +0 -1
- data/tools/staticdocs/assets/js/97535711.630cee4d.js +0 -1
- data/tools/staticdocs/assets/js/99581c43.73b5cd90.js +0 -1
- data/tools/staticdocs/assets/js/9fb6059a.715fc441.js +0 -1
- data/tools/staticdocs/assets/js/a677c089.76d13f14.js +0 -1
- data/tools/staticdocs/assets/js/a9987364.3b3e7379.js +0 -1
- data/tools/staticdocs/assets/js/a9b2dc27.da1da6f1.js +0 -1
- data/tools/staticdocs/assets/js/b38a6d74.4a10f506.js +0 -1
- data/tools/staticdocs/assets/js/b4596165.08749f15.js +0 -1
- data/tools/staticdocs/assets/js/b6d70f94.776bc00f.js +0 -1
- data/tools/staticdocs/assets/js/b9f60ba6.ce400445.js +0 -1
- data/tools/staticdocs/assets/js/c24eae19.77326c08.js +0 -1
- data/tools/staticdocs/assets/js/cb8c3f08.73cefada.js +0 -1
- data/tools/staticdocs/assets/js/cd879be4.dc2adfcc.js +0 -1
- data/tools/staticdocs/assets/js/d1b923aa.57f5e162.js +0 -1
- data/tools/staticdocs/assets/js/d1bfc316.73bb876f.js +0 -1
- data/tools/staticdocs/assets/js/d57a4b5d.885590b1.js +0 -1
- data/tools/staticdocs/assets/js/d5d77c37.1143a9d4.js +0 -1
- data/tools/staticdocs/assets/js/d66bf9c0.0ffb9759.js +0 -1
- data/tools/staticdocs/assets/js/d8ca4191.fe602968.js +0 -1
- data/tools/staticdocs/assets/js/d9b92eba.a115a366.js +0 -1
- data/tools/staticdocs/assets/js/db8fa1d0.1aefa4e7.js +0 -1
- data/tools/staticdocs/assets/js/dbe31111.9c957b0c.js +0 -1
- data/tools/staticdocs/assets/js/dc5f7beb.ddc630ca.js +0 -1
- data/tools/staticdocs/assets/js/e501b0d1.f9c2d1fc.js +0 -1
- data/tools/staticdocs/assets/js/main.ba1fa268.js +0 -38
- data/tools/staticdocs/assets/js/runtime~main.ca894d1e.js +0 -1
- data/tools/staticdocs/lunr-index-1748640055686.json +0 -1
- data/tools/staticdocs/search-doc-1748640055686.json +0 -1
@@ -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><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.
|
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><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.1"><title data-rh=true>Development | 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/development><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="Development | OpenC3 Docs"><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/development><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/development hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/development 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/development","name":"Development","position":1}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.1a361da6.css><script src=/tools/staticdocs/assets/js/runtime~main.7674b06d.js defer></script><script src=/tools/staticdocs/assets/js/main.8c741ee1.js defer></script><body class=navigation-with-keyboard><svg xmlns=http://www.w3.org/2000/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
4
|
<script>!function(){var t="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),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_G6ar 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_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></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_bmvg><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_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><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>Introduction</a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="menu__link menu__link--sublist" href=/tools/staticdocs/docs/getting-started>Getting Started</a><button aria-label="Expand sidebar category 'Getting Started'" 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="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</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="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</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="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</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"><div class="menu__list-item-collapsible menu__list-item-collapsible--active"><a class="menu__link menu__link--sublist menu__link--active" aria-current=page href=/tools/staticdocs/docs/development>Development</a><button aria-label="Collapse sidebar category 'Development'" 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/development/curl>Testing with Curl</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/development/developing>Developing COSMOS</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/development/json-api>JSON API</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/development/log-structure>Log Structure</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/development/roadmap>Roadmap</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/development/streaming-api>Streaming API</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/development/testing>Testing COSMOS</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="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</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>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=generatedIndexPage_ak01><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" 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_JFrk><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>Development</span></ul></nav><header><h1 class=title_AulG>Development</h1></header><article class=margin-top--lg><section class=row><article class="docCardListItem_h8oi col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/development/curl><h2 class="text--truncate cardTitle_HoSo" title="Testing with Curl">🌊<!-- --> <!-- -->Testing with Curl</h2><p class="text--truncate cardDescription_c27F" title="How to use Curl to hit the COSMOS APIs">How to use Curl to hit the COSMOS APIs</p></a></article><article class="docCardListItem_h8oi col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/development/developing><h2 class="text--truncate cardTitle_HoSo" title="Developing COSMOS">💻<!-- --> <!-- -->Developing COSMOS</h2><p class="text--truncate cardDescription_c27F" title="Building COSMOS and developing the frontend and backend">Building COSMOS and developing the frontend and backend</p></a></article><article class="docCardListItem_h8oi col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/development/json-api><h2 class="text--truncate cardTitle_HoSo" title="JSON API">🖥️<!-- --> <!-- -->JSON API</h2><p class="text--truncate cardDescription_c27F" title="Interfacing to the COSMOS APIs using JSON-RPC">Interfacing to the COSMOS APIs using JSON-RPC</p></a></article><article class="docCardListItem_h8oi col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/development/log-structure><h2 class="text--truncate cardTitle_HoSo" title="Log Structure">🪵<!-- --> <!-- -->Log Structure</h2><p class="text--truncate cardDescription_c27F" title="Structure of the COSMOS log file">Structure of the COSMOS log file</p></a></article><article class="docCardListItem_h8oi col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/development/roadmap><h2 class="text--truncate cardTitle_HoSo" title=Roadmap>🗺️<!-- --> <!-- -->Roadmap</h2><p class="text--truncate cardDescription_c27F" title="COSMOS roadmap now and into the future">COSMOS roadmap now and into the future</p></a></article><article class="docCardListItem_h8oi col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/development/streaming-api><h2 class="text--truncate cardTitle_HoSo" title="Streaming API">📝<!-- --> <!-- -->Streaming API</h2><p class="text--truncate cardDescription_c27F" title="Using the websocket streaming API to retrieve data">Using the websocket streaming API to retrieve data</p></a></article><article class="docCardListItem_h8oi col col--6"><a class="card padding--lg cardContainer_S8oU" href=/tools/staticdocs/docs/development/testing><h2 class="text--truncate cardTitle_HoSo" title="Testing COSMOS">📋<!-- --> <!-- -->Testing COSMOS</h2><p class="text--truncate cardDescription_c27F" title="Running the Playwright integration tests and unit tests">Running the Playwright integration tests and unit tests</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/guides/scripting-api><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Scripting API Guide</div></a><a class="pagination-nav__link pagination-nav__link--next" href=/tools/staticdocs/docs/development/curl><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Testing with Curl</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-hidden=true class=iconExternalLink_awgD><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-hidden=true class=iconExternalLink_awgD><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>
|
@@ -1,9 +1,9 @@
|
|
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/cli" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.
|
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/cli" data-has-hydrated=false><meta charset=UTF-8><meta name=generator content="Docusaurus v3.8.1"><title data-rh=true>Command Line Interface | 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/cli><meta data-rh=true property=og:locale content=en><meta data-rh=true name=docusaurus_locale content=en><meta data-rh=true name=docsearch:language content=en><meta data-rh=true name=docusaurus_version content=current><meta data-rh=true name=docusaurus_tag content=docs-default-current><meta data-rh=true name=docsearch:version content=current><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current><meta data-rh=true property=og:title content="Command Line Interface | OpenC3 Docs"><meta data-rh=true name=description content="Using openc3.sh"><meta data-rh=true property=og:description content="Using openc3.sh"><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/cli><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/cli hreflang=en><link data-rh=true rel=alternate href=https://docs.openc3.com/tools/staticdocs/docs/getting-started/cli 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/cli","name":"Command Line Interface","position":2}]}</script><link rel=stylesheet href=/tools/staticdocs/assets/css/styles.1a361da6.css><script src=/tools/staticdocs/assets/js/runtime~main.7674b06d.js defer></script><script src=/tools/staticdocs/assets/js/main.8c741ee1.js defer></script><body class=navigation-with-keyboard><svg xmlns=http://www.w3.org/2000/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
4
|
<script>!function(){var t="dark",e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",e||t),document.documentElement.setAttribute("data-theme-choice",e||t)}(),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_G6ar 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_DHUr themedComponent--light_DIHH"><img src=/tools/staticdocs/img/logo.svg alt="OpenC3 Logo" class="themedComponent_DHUr themedComponent--dark_Bv2M"></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_bmvg><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_UyTV"><div class=docsWrapper_XLvK><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type=button></button><div class=docRoot_HciC><aside class="theme-doc-sidebar-container docSidebarContainer_e5ai"><div class=sidebarViewport_N8x0><div class=sidebar_vJCc><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME"><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>Introduction</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="menu__link menu__link--sublist menu__link--active" href=/tools/staticdocs/docs/getting-started>Getting Started</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>Key Concepts</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>Installation</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>Getting Started</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>Upgrading</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/cli>Command Line Interface</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>Code Generators</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>Podman</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>Requirements and Design</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="menu__link menu__link--sublist" href=/tools/staticdocs/docs/configuration>Configuration</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="menu__link menu__link--sublist" href=/tools/staticdocs/docs/tools>Tools</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="menu__link menu__link--sublist" href=/tools/staticdocs/docs/guides>Guides</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="menu__link menu__link--sublist" href=/tools/staticdocs/docs/development>Development</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="menu__link menu__link--sublist" href=/tools/staticdocs/docs/meta>Meta</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>OpenC3, Inc. Privacy Policy</a></ul></nav></div></div></aside><main class=docMainContainer_namt><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_YAwJ"><div class=docItemContainer_Rv5Z><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" 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_JFrk><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>Command Line Interface</span></ul></nav><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type=button class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Command Line Interface</h1></header><p>The COSMOS Command Line Interface is <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">project</a> (more about <a href=/tools/staticdocs/docs/getting-started/key-concepts#projects>projects</a>).</p>
|
5
5
|
<p>If you followed the <a 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">openc3-project</a> which is in your PATH (necessary for openc3.bat / openc3.sh to be resolved). To see all the available type the following:</p>
|
6
|
-
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">% openc3.sh cli</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">Usage:</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli </span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">help</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Displays this information</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli rake </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Runs rake in the local directory</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli irb </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Runs irb in the local directory</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli script
|
6
|
+
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">% openc3.sh cli</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">Usage:</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli </span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">help</span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Displays this information</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli rake </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Runs rake in the local directory</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli irb </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Runs irb in the local directory</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli script </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Interact with scripts. Run with --help for more info.</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli validate /</span><span class="token environment constant" style="color:rgb(130, 170, 255)">PATH</span><span class="token plain">/FILENAME.gem SCOPE variables.txt </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Validate a COSMOS plugin gem file</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli load /</span><span class="token environment constant" style="color:rgb(130, 170, 255)">PATH</span><span class="token plain">/FILENAME.gem SCOPE variables.txt </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Loads a COSMOS plugin gem file</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli list </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token plain">SCOPE</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"> </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Lists installed plugins, SCOPE is DEFAULT if not given</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli generate TYPE OPTIONS </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Generate various COSMOS entities</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> OPTIONS: </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">--ruby</span><span class="token plain"> or </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">--python</span><span class="token plain"> is required to specify the language </span><span class="token keyword" style="color:rgb(127, 219, 202)">in</span><span class="token plain"> the generated code unless OPENC3_LANGUAGE is </span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">set</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli bridge CONFIG_FILENAME </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Run COSMOS host bridge</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli bridgegem gem_name </span><span class="token assign-left variable" style="color:rgb(214, 222, 235)">variable1</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain">value1 </span><span class="token assign-left variable" style="color:rgb(214, 222, 235)">variable2</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain">value2 </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Runs bridge using gem bridge.txt</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli bridgesetup CONFIG_FILENAME </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Create a default config file</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli pkginstall PKGFILENAME SCOPE </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Install loaded package (Ruby gem or python package)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli pkguninstall PKGFILENAME SCOPE </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Uninstall loaded package (Ruby gem or python package)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli rubysloc </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># DEPRECATED: Please use scc (https://github.com/boyter/scc)</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli xtce_converter </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Convert to and from the XTCE format. Run with --help for more info.</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> cli cstol_converter </span><span class="token comment" style="color:rgb(99, 119, 119);font-style:italic"># Converts CSTOL files (.prc) to COSMOS. Run with --help for more info.</span><br></span></code></pre></div></div>
|
7
7
|
<div class="theme-admonition theme-admonition-note admonition_IZjC alert alert--secondary"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><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>seccomp profile</div><div class=admonitionContent_bl22><p>You can safely ignore <code>WARNING: daemon is not using the default seccomp profile</code></div></div>
|
8
8
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=rake>Rake<a href=#rake class=hash-link aria-label="Direct link to Rake" title="Direct link to Rake"></a></h2>
|
9
9
|
<p>You can execute rake tasks using <code>openc3.sh cli rake</code>. The most typical usage is to generate a plugin and then build it. For example:</p>
|
@@ -13,16 +13,27 @@
|
|
13
13
|
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">% openc3.sh cli irb</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">irb</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">main</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain">:001:</span><span class="token operator file-descriptor important" style="color:rgb(127, 219, 202)">0</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"> require </span><span class="token string" style="color:rgb(173, 219, 103)">'cosmos'</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">irb</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">main</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain">:002:</span><span class="token operator file-descriptor important" style="color:rgb(127, 219, 202)">0</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"> Cosmos::Api::WHITELIST</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token string" style="color:rgb(173, 219, 103)">"get_interface"</span><span class="token plain">,</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">"get_interface_names"</span><span class="token plain">,</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> </span><span class="token punctuation" style="color:rgb(199, 146, 234)">..</span><span class="token plain">.</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><br></span></code></pre></div></div>
|
14
14
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=script>Script<a href=#script class=hash-link aria-label="Direct link to Script" title="Direct link to Script"></a></h2>
|
15
15
|
<p>The script methods allow you to list the available scripts, spawn a script, and run a script while monitoring its output. Note that you must set the OPENC3_API_PASSWORD in COSMOS Core and both the OPENC3_API_USER and OPENC3_API_PASSWORD in COSMOS Enterprise.</p>
|
16
|
-
<div class="theme-admonition theme-admonition-note admonition_IZjC alert alert--secondary"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><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>Offline Access Token</div><div class=admonitionContent_bl22><p>You must visit the frontend Script Runner page as the OPENC3_API_USER or run "openc3.sh cli script init" in order to obtain an offline access token before the other script cli methods will work.</div></div>
|
16
|
+
<div class="theme-admonition theme-admonition-note admonition_IZjC alert alert--secondary"><div class=admonitionHeading_uVvU><span class=admonitionIcon_HiR3><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>Offline Access Token (since 6.3.0)</div><div class=admonitionContent_bl22><p>You must visit the frontend Script Runner page as the OPENC3_API_USER or run "openc3.sh cli script init" in order to obtain an offline access token before the other script cli methods will work.</div></div>
|
17
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=init-enterprise-only-since-630>Init (Enterprise Only since 6.3.0)<a href=#init-enterprise-only-since-630 class=hash-link aria-label="Direct link to Init (Enterprise Only since 6.3.0)" title="Direct link to Init (Enterprise Only since 6.3.0)"></a></h3>
|
18
|
+
<p>Obtain an offline access token without visiting the frontend GUI. This is required when running in a headless CI/CD environment before accessing any of the other commands.</p>
|
17
19
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=list>List<a href=#list class=hash-link aria-label="Direct link to List" title="Direct link to List"></a></h3>
|
18
20
|
<p>List all the available scripts which includes all the files in every target directory. You can filter this list using bash to only include procedures, Ruby files, Python files, etc.</p>
|
19
21
|
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">% </span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">export</span><span class="token plain"> </span><span class="token assign-left variable" style="color:rgb(214, 222, 235)">OPENC3_API_USER</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain">operator</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">% </span><span class="token builtin class-name" style="color:rgb(255, 203, 139)">export</span><span class="token plain"> </span><span class="token assign-left variable" style="color:rgb(214, 222, 235)">OPENC3_API_PASSWORD</span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain">operator</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">% openc3.sh cli script list</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">EXAMPLE/cmd_tlm/example_cmds.txt</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">EXAMPLE/cmd_tlm/example_tlm.txt</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token punctuation" style="color:rgb(199, 146, 234)">..</span><span class="token plain">.</span><br></span></code></pre></div></div>
|
20
22
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=spawn>Spawn<a href=#spawn class=hash-link aria-label="Direct link to Spawn" title="Direct link to Spawn"></a></h3>
|
21
23
|
<p>The ID of the spawned script is returned. You can connect to it in Script Runner by visiting <code>http://localhost:2900/tools/scriptrunner/1</code> where the final value is the ID.</p>
|
22
|
-
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">% openc3.sh spawn INST/procedures/checks.rb</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">
|
24
|
+
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">% openc3.sh cli script spawn INST/procedures/checks.rb</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">4</span><br></span></code></pre></div></div>
|
23
25
|
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=run>Run<a href=#run class=hash-link aria-label="Direct link to Run" title="Direct link to Run"></a></h3>
|
24
26
|
<p>Run spawns the script and then captures the output and prints it to the shell. Note that this will not work with user input prompts so the script must be written to prevent user input. You can also pass variables to the script as shown in the CLI help.</p>
|
25
27
|
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">% openc3.sh cli script run INST/procedures/stash.rb</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">Filename INST/procedures/stash.rb scope DEFAULT</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">2025</span><span class="token plain">/03/22 </span><span class="token number" style="color:rgb(247, 140, 108)">19</span><span class="token plain">:50:40.429 </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">SCRIPTRUNNER</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain">: Script config/DEFAULT/targets/INST/procedures/stash.rb spawned </span><span class="token keyword" style="color:rgb(127, 219, 202)">in</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.796683293</span><span class="token plain"> seconds </span><span class="token operator" style="color:rgb(127, 219, 202)"><</span><span class="token plain">ruby </span><span class="token number" style="color:rgb(247, 140, 108)">3.2</span><span class="token plain">.</span><span class="token operator file-descriptor important" style="color:rgb(127, 219, 202)">6</span><span class="token operator" style="color:rgb(127, 219, 202)">></span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">2025</span><span class="token plain">/03/22 </span><span class="token number" style="color:rgb(247, 140, 108)">19</span><span class="token plain">:50:40.453 </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">SCRIPTRUNNER</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain">: Starting script: stash.rb, line_delay </span><span class="token operator" style="color:rgb(127, 219, 202)">=</span><span class="token plain"> </span><span class="token number" style="color:rgb(247, 140, 108)">0.1</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:3</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:4</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">2025</span><span class="token plain">/03/22 </span><span class="token number" style="color:rgb(247, 140, 108)">19</span><span class="token plain">:50:40.732 </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">stash.rb:4</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain">: key1: val1</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:5</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:6</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">2025</span><span class="token plain">/03/22 </span><span class="token number" style="color:rgb(247, 140, 108)">19</span><span class="token plain">:50:40.936 </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">stash.rb:6</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain">: key2: val2</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:7</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">2025</span><span class="token plain">/03/22 </span><span class="token number" style="color:rgb(247, 140, 108)">19</span><span class="token plain">:50:41.039 </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">stash.rb:7</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain">: CHECK: </span><span class="token string" style="color:rgb(173, 219, 103)">'val1'</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">==</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'val1'</span><span class="token plain"> is TRUE</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:8</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">2025</span><span class="token plain">/03/22 </span><span class="token number" style="color:rgb(247, 140, 108)">19</span><span class="token plain">:50:41.146 </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">stash.rb:8</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain">: CHECK: </span><span class="token string" style="color:rgb(173, 219, 103)">'val2'</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">==</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'val2'</span><span class="token plain"> is TRUE</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:9</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">2025</span><span class="token plain">/03/22 </span><span class="token number" style="color:rgb(247, 140, 108)">19</span><span class="token plain">:50:41.256 </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">stash.rb:9</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain">: CHECK: </span><span class="token string" style="color:rgb(173, 219, 103)">'["key1", "key2"]'</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">==</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'["key1", "key2"]'</span><span class="token plain"> is TRUE</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:10</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:11</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:12</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">2025</span><span class="token plain">/03/22 </span><span class="token number" style="color:rgb(247, 140, 108)">19</span><span class="token plain">:50:41.556 </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">stash.rb:12</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain">: CHECK: </span><span class="token string" style="color:rgb(173, 219, 103)">'{"key1"=>1, "key2"=>2}'</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">==</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'{"key1"=>1, "key2"=>2}'</span><span class="token plain"> is TRUE</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:13</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:14</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">2025</span><span class="token plain">/03/22 </span><span class="token number" style="color:rgb(247, 140, 108)">19</span><span class="token plain">:50:41.763 </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">stash.rb:14</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain">: CHECK: </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">==</span><span class="token plain"> </span><span class="token boolean" style="color:rgb(255, 88, 116)">true</span><span class="token plain"> is TRUE</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:15</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:16</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:17</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:18</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">2025</span><span class="token plain">/03/22 </span><span class="token number" style="color:rgb(247, 140, 108)">19</span><span class="token plain">:50:42.176 </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">stash.rb:18</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain">: CHECK: </span><span class="token string" style="color:rgb(173, 219, 103)">'[1, 2, [3, 4]]'</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">==</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'[1, 2, [3, 4]]'</span><span class="token plain"> is TRUE</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:19</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:21</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:22</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:23</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">2025</span><span class="token plain">/03/22 </span><span class="token number" style="color:rgb(247, 140, 108)">19</span><span class="token plain">:50:42.587 </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">stash.rb:23</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain">: CHECK: </span><span class="token string" style="color:rgb(173, 219, 103)">'{"one"=>1, "two"=>2, "string"=>"string"}'</span><span class="token plain"> </span><span class="token operator" style="color:rgb(127, 219, 202)">==</span><span class="token plain"> </span><span class="token string" style="color:rgb(173, 219, 103)">'{"one"=>1, "two"=>2, "string"=>"string"}'</span><span class="token plain"> is TRUE</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:24</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">running</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">2025</span><span class="token plain">/03/22 </span><span class="token number" style="color:rgb(247, 140, 108)">19</span><span class="token plain">:50:42.697 </span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">SCRIPTRUNNER</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain">: Script completed: stash.rb</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">At </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">INST/procedures/stash.rb:0</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> state </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">stopped</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">script complete</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">%</span><br></span></code></pre></div></div>
|
28
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=running-since-650>Running (since 6.5.0)<a href=#running-since-650 class=hash-link aria-label="Direct link to Running (since 6.5.0)" title="Direct link to Running (since 6.5.0)"></a></h3>
|
29
|
+
<p>List all the running scripts. Add the --verbose option to print the raw output.</p>
|
30
|
+
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">% openc3.sh cli script running</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">ID User Filename Start Time State</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> The Operator INST/procedures/collect.rb </span><span class="token number" style="color:rgb(247, 140, 108)">2025</span><span class="token plain">-06-06T22:40:48Z paused</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">4</span><span class="token plain"> The Operator INST/procedures/checks.rb </span><span class="token number" style="color:rgb(247, 140, 108)">2025</span><span class="token plain">-06-06T22:40:21Z error</span><br></span></code></pre></div></div>
|
31
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=status-since-650>Status (since 6.5.0)<a href=#status-since-650 class=hash-link aria-label="Direct link to Status (since 6.5.0)" title="Direct link to Status (since 6.5.0)"></a></h3>
|
32
|
+
<p>List status for a specific script based on the script ID. Add the --verbose option to print the raw output.</p>
|
33
|
+
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">% openc3.sh cli script status </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">ID User Filename Start Time State</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"></span><span class="token number" style="color:rgb(247, 140, 108)">5</span><span class="token plain"> The Operator INST/procedures/collect.rb </span><span class="token number" style="color:rgb(247, 140, 108)">2025</span><span class="token plain">-06-06T22:40:48Z paused</span><br></span></code></pre></div></div>
|
34
|
+
<h3 class="anchor anchorWithStickyNavbar_fF9Z" id=stop-since-650>Stop (since 6.5.0)<a href=#stop-since-650 class=hash-link aria-label="Direct link to Stop (since 6.5.0)" title="Direct link to Stop (since 6.5.0)"></a></h3>
|
35
|
+
<p>Stop a script based on the script ID.</p>
|
36
|
+
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">% openc3.sh cli script stop </span><span class="token number" style="color:rgb(247, 140, 108)">5</span><br></span></code></pre></div></div>
|
26
37
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=validate>Validate<a href=#validate class=hash-link aria-label="Direct link to Validate" title="Direct link to Validate"></a></h2>
|
27
38
|
<p>Validate is used to validate built COSMOS plugins. It walks through the installation process without actually installing the plugin.</p>
|
28
39
|
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">% openc3.sh cli validate openc3-cosmos-cfdp-1.0.0.gem</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">Installing openc3-cosmos-cfdp-1.0.0.gem</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">Successfully validated openc3-cosmos-cfdp-1.0.0.gem</span><br></span></code></pre></div></div>
|
@@ -47,4 +58,4 @@
|
|
47
58
|
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">% openc3.sh cli xtce_converter</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain">Usage: xtce_converter </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">options</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">--import</span><span class="token plain"> input_xtce_filename </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">--output</span><span class="token plain"> output_dir</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> xtce_converter </span><span class="token punctuation" style="color:rgb(199, 146, 234)">[</span><span class="token plain">options</span><span class="token punctuation" style="color:rgb(199, 146, 234)">]</span><span class="token plain"> </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">--plugin</span><span class="token plain"> /</span><span class="token environment constant" style="color:rgb(130, 170, 255)">PATH</span><span class="token plain">/FILENAME.gem </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">--output</span><span class="token plain"> output_dir </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">--variables</span><span class="token plain"> variables.txt</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain" style=display:inline-block></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> -h, </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">--help</span><span class="token plain"> Show this message</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> -i, </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">--import</span><span class="token plain"> VALUE Import the specified .xtce </span><span class="token function" style="color:rgb(130, 170, 255)">file</span><span class="token plain"></span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> -o, </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">--output</span><span class="token plain"> DIRECTORY Create files </span><span class="token keyword" style="color:rgb(127, 219, 202)">in</span><span class="token plain"> the directory</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> -p, </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">--plugin</span><span class="token plain"> PLUGIN Export .xtce file</span><span class="token punctuation" style="color:rgb(199, 146, 234)">(</span><span class="token plain">s</span><span class="token punctuation" style="color:rgb(199, 146, 234)">)</span><span class="token plain"> from the plugin</span><br></span><span class=token-line style=color:#d6deeb><span class="token plain"> -v, </span><span class="token parameter variable" style="color:rgb(214, 222, 235)">--variables</span><span class="token plain"> Optional variables </span><span class="token function" style="color:rgb(130, 170, 255)">file</span><span class="token plain"> to pass to the plugin</span><br></span></code></pre></div></div>
|
48
59
|
<h2 class="anchor anchorWithStickyNavbar_fF9Z" id=cstol-converter>CSTOL Converter<a href=#cstol-converter class=hash-link aria-label="Direct link to CSTOL Converter" title="Direct link to CSTOL Converter"></a></h2>
|
49
60
|
<p>Converts from the Colorado System Test and Operations Language (CSTOL) to a COSMOS Script Runner Ruby script. It currently does not support conversion to Python. Simply run it in the same directory as CSTOL files (*.prc) and it will convert them all.</p>
|
50
|
-
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">% openc3.sh cli cstol_converter</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/cli.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW 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_g62E"></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/upgrading><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Upgrading</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_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#rake class="table-of-contents__link toc-highlight">Rake</a><li><a href=#irb class="table-of-contents__link toc-highlight">IRB</a><li><a href=#script class="table-of-contents__link toc-highlight">Script</a><ul><li><a href=#list class="table-of-contents__link toc-highlight">List</a><li><a href=#spawn class="table-of-contents__link toc-highlight">Spawn</a><li><a href=#run class="table-of-contents__link toc-highlight">Run</a></ul><li><a href=#validate class="table-of-contents__link toc-highlight">Validate</a><li><a href=#load class="table-of-contents__link toc-highlight">Load</a><li><a href=#list-1 class="table-of-contents__link toc-highlight">List</a><li><a href=#generate class="table-of-contents__link toc-highlight">Generate</a><li><a href=#bridge class="table-of-contents__link toc-highlight">Bridge</a><li><a href=#pkginstall-and-pkguninstall class="table-of-contents__link toc-highlight">Pkginstall and pkguninstall</a><li><a href=#rubysloc-deprecated class="table-of-contents__link toc-highlight">Rubysloc (deprecated)</a><li><a href=#xtce-converter class="table-of-contents__link toc-highlight">XTCE Converter</a><li><a href=#cstol-converter class="table-of-contents__link toc-highlight">CSTOL Converter</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-hidden=true class=iconExternalLink_awgD><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-hidden=true class=iconExternalLink_awgD><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>
|
61
|
+
<div class="language-bash codeBlockContainer_ZGJx theme-code-block" style=--prism-color:#d6deeb;--prism-background-color:#011627><div class=codeBlockContent_kX1v><pre tabindex=0 class="prism-code language-bash codeBlock_TAPP thin-scrollbar" style=color:#d6deeb;background-color:#011627><code class=codeBlockLines_AdAo><span class=token-line style=color:#d6deeb><span class="token plain">% openc3.sh cli cstol_converter</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class=col><a href=https://github.com/OpenC3/cosmos/tree/main/docs.openc3.com/docs/getting-started/cli.md target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_UohW 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_g62E"></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/upgrading><div class=pagination-nav__sublabel>Previous</div><div class=pagination-nav__label>Upgrading</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_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#rake class="table-of-contents__link toc-highlight">Rake</a><li><a href=#irb class="table-of-contents__link toc-highlight">IRB</a><li><a href=#script class="table-of-contents__link toc-highlight">Script</a><ul><li><a href=#init-enterprise-only-since-630 class="table-of-contents__link toc-highlight">Init (Enterprise Only since 6.3.0)</a><li><a href=#list class="table-of-contents__link toc-highlight">List</a><li><a href=#spawn class="table-of-contents__link toc-highlight">Spawn</a><li><a href=#run class="table-of-contents__link toc-highlight">Run</a><li><a href=#running-since-650 class="table-of-contents__link toc-highlight">Running (since 6.5.0)</a><li><a href=#status-since-650 class="table-of-contents__link toc-highlight">Status (since 6.5.0)</a><li><a href=#stop-since-650 class="table-of-contents__link toc-highlight">Stop (since 6.5.0)</a></ul><li><a href=#validate class="table-of-contents__link toc-highlight">Validate</a><li><a href=#load class="table-of-contents__link toc-highlight">Load</a><li><a href=#list-1 class="table-of-contents__link toc-highlight">List</a><li><a href=#generate class="table-of-contents__link toc-highlight">Generate</a><li><a href=#bridge class="table-of-contents__link toc-highlight">Bridge</a><li><a href=#pkginstall-and-pkguninstall class="table-of-contents__link toc-highlight">Pkginstall and pkguninstall</a><li><a href=#rubysloc-deprecated class="table-of-contents__link toc-highlight">Rubysloc (deprecated)</a><li><a href=#xtce-converter class="table-of-contents__link toc-highlight">XTCE Converter</a><li><a href=#cstol-converter class="table-of-contents__link toc-highlight">CSTOL Converter</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-hidden=true class=iconExternalLink_awgD><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-hidden=true class=iconExternalLink_awgD><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>
|