ROCKETRIDE_QUICKSTART

RocketRide Quick Start - Complete Working Examples

Python: Complete Working Project

Step 1: Set Up the .env File

When you connect to a self-hosted engine (local, docker, service, or on-prem) using the extension's development connection group, the extension auto-populates .env in your workspace with the live server URI and key — preserving any other variables you've added. In local mode the engine listens on a dynamically assigned port, so the extension writes the actual resolved address (not a fixed port). In cloud mode, set ROCKETRIDE_APIKEY yourself (cloud sign-in uses a short-lived OAuth token, which is not a usable SDK key).

# Development-group self-hosted engines: auto-filled on connect (local uses the real dynamic port).
# live engine address (auto-filled)
ROCKETRIDE_URI=http://localhost:54123
# self-hosted default; set your own for cloud
ROCKETRIDE_APIKEY=MYAPIKEY

# Add your custom variables:
ROCKETRIDE_INPUT_PATH=/data/input
ROCKETRIDE_OUTPUT_PATH=/data/output

Note: For self-hosted engines in the development connection group, the extension re-syncs ROCKETRIDE_URI/ROCKETRIDE_APIKEY on every connect while leaving your other variables untouched. For cloud, provide your own API key. Add any additional custom variables as needed. Because .env can contain credentials, add it to .gitignore and never commit it.

Step 2: Install Client

pip install rocketride

Step 3: Create Pipeline (pipeline.pipe)

Pipeline files must use the .pipe extension.

{
	"project_id": "85be2a13-ad93-49ed-a1e1-4b0f763ca618",
	"source": "input",
	"components": [
		{
			"id": "input",
			"provider": "webhook",
			"config": {}
		},
		{
			"id": "processor",
			"provider": "transform",
			"config": {
				"input_path": "${ROCKETRIDE_INPUT_PATH}",
				"output_path": "${ROCKETRIDE_OUTPUT_PATH}"
			},
			"input": [{ "lane": "text", "from": "input" }]
		},
		{
			"id": "output",
			"provider": "response_text",
			"config": {},
			"input": [{ "lane": "text", "from": "processor" }]
		}
	]
}