@gothenburg-quantum-analytics/orbit-cli
v0.4.0
Published
CLI tools for Orbit plugin development
Readme
Orbit CLI
Command-line tooling for creating, building, validating, packaging, and emulating Orbit plugins.
What is an Orbit plugin?
Orbit plugins are .orbit extension packages for GQA products. They can add project-specific CAN
decoding, data readers and writers, automated triggers, persistent settings, custom database
formats, and host-rendered interfaces. Helix 2 Plus currently supports browser-targeted Orbit
plugins; Node.js backend plugins are not yet supported on the device.
Installation
npm install --global @gothenburg-quantum-analytics/orbit-cliYou can also run the CLI without a global installation:
npx @gothenburg-quantum-analytics/orbit-cli --helpQuick start
orbit init my-plugin
cd my-plugin
orbit build
orbit validate
orbit packRun orbit <command> --help for command-specific options. The full documentation is in the
Orbit repository.
Documentation
See Getting Started with Orbit Plugin Development for the Helix 2 Plus development workflow.
License
MIT
