Scramjet Platform

⭐ Star us on GitHub — it motivates us a lot! 🚀

Scramjet Platform

Because distributed integrations should not require rebuilding networking and operations for every workflow, by combining runtime execution, APIs, RPC, and configured tunnels we created the Scramjet Platform.

Now you can deploy contained Python, Bun, and Node.js Sequences wherever work needs to happen; Transform Hubs run them locally, and Scramjet Manager coordinates connected Hubs over the internet using configured TLS encryption and client authentication.

Start here

• Manager operations
• STH runtime and package reference
• MultiManager reference
• Sequence author guide
• Sequence lifecycle
• Hub configuration and TLS trust
• Connecting Hubs

Quick start

Install the Hub and CLI packages:

npm install -g @scramjet/sth @scramjet/cli

Start the Hub (default: adapter detection on port 8000):

scramjet-transform-hub

Package and deploy a sequence from another terminal:

si sequence pack /path/to/sequence -o sequence.tar.gz
si sequence deploy sequence.tar.gz

Requirements:

• Node.js >= 18 for the Hub and Node sequences
• Bun >= 1.0 for Bun sequences
• Python >= 3.9 for Python sequences
• Docker for Docker adapter deployments

See Hub setup and concepts for detailed setup and build and run workflows for local development.

Documentation

Generated documentation is published to docs/, while handwritten source is maintained in docs-source/.

Contributing

We accept valid contributions and we will be publishing a more specific project roadmap so contributors can propose features and also help us implement them. We kindly ask you that contributed commits are Signed-Off git commit --sign-off.

We provide support for contributors via test cases. If you expect a certain type of workflow to be officially supported, please specify and implement a test case in Gherkin format in bdd directory and include it in your pull request.

See docs-source/development/contributing.md for development instructions.

License

The Scramjet Transform Hub project is dual-licensed under the AGPL-3.0 and MIT licenses. Parts of the project that are linked with your programs are MIT licensed, the rest is AGPL.